eventespresso / event-espresso-core

admin_pages/maintenance/Maintenance_Admin_Page.core.php

Indentation +616 added lines, -616 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('NO direct script access allowed');
+	exit('NO direct script access allowed');
 }
 
 
@@ -28,636 +28,636 @@ 
 {
 
 
-    public function __construct($routing = true)
-    {
-        parent::__construct($routing);
-    }
-
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug = EE_MAINTENANCE_PG_SLUG;
-        $this->page_label = EE_MAINTENANCE_LABEL;
-        $this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
-        $this->_admin_base_path = EE_MAINTENANCE_ADMIN;
-    }
-
-
-
-    protected function _ajax_hooks()
-    {
-        add_action('wp_ajax_migration_step', array($this, 'migration_step'));
-        add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
-    }
-
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = EE_MAINTENANCE_LABEL;
-        $this->_labels = array(
-            'buttons' => array(
-                'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
-                'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
-            ),
-        );
-    }
-
-
-
-    protected function _set_page_routes()
-    {
-        $this->_page_routes = array(
-            'default'                             => array(
-                'func'       => '_maintenance',
-                'capability' => 'manage_options',
-            ),
-            'change_maintenance_level'            => array(
-                'func'       => '_change_maintenance_level',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'system_status'                       => array(
-                'func'       => '_system_status',
-                'capability' => 'manage_options',
-            ),
-            'download_system_status' => array(
-                'func'       => '_download_system_status',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'send_migration_crash_report'         => array(
-                'func'       => '_send_migration_crash_report',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'confirm_migration_crash_report_sent' => array(
-                'func'       => '_confirm_migration_crash_report_sent',
-                'capability' => 'manage_options',
-            ),
-            'data_reset'                          => array(
-                'func'       => '_data_reset_and_delete',
-                'capability' => 'manage_options',
-            ),
-            'reset_db'                            => array(
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => array('nuke_old_ee4_data' => true),
-            ),
-            'start_with_fresh_ee4_db'             => array(
-                'func'       => '_reset_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-                'args'       => array('nuke_old_ee4_data' => false),
-            ),
-            'delete_db'                           => array(
-                'func'       => '_delete_db',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'rerun_migration_from_ee3'            => array(
-                'func'       => '_rerun_migration_from_ee3',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reset_reservations'                  => array(
-                'func'       => '_reset_reservations',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reset_capabilities'                  => array(
-                'func'       => '_reset_capabilities',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-            'reattempt_migration'                 => array(
-                'func'       => '_reattempt_migration',
-                'capability' => 'manage_options',
-                'noheader'   => true,
-            ),
-        );
-    }
-
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = array(
-            'default'       => array(
-                'nav'           => array(
-                    'label' => esc_html__('Maintenance', 'event_espresso'),
-                    'order' => 10,
-                ),
-                'require_nonce' => false,
-            ),
-            'data_reset'    => array(
-                'nav'           => array(
-                    'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
-                    'order' => 20,
-                ),
-                'require_nonce' => false,
-            ),
-            'system_status' => array(
-                'nav'           => array(
-                    'label' => esc_html__("System Information", "event_espresso"),
-                    'order' => 30,
-                ),
-                'require_nonce' => false,
-            ),
-        );
-    }
-
-
-
-    /**
-     * default maintenance page. If we're in maintenance mode level 2, then we need to show
-     * the migration scripts and all that UI.
-     */
-    public function _maintenance()
-    {
-        //it all depends if we're in maintenance model level 1 (frontend-only) or
-        //level 2 (everything except maintenance page)
-        try {
-            //get the current maintenance level and check if
-            //we are removed
-            $mm = EE_Maintenance_Mode::instance()->level();
-            $placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-            if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
-                //we just took the site out of maintenance mode, so notify the user.
-                //unfortunately this message appears to be echoed on the NEXT page load...
-                //oh well, we should really be checking for this on addon deactivation anyways
-                EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required',
-                    'event_espresso'));
-                $this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
-            }
-            //in case an exception is thrown while trying to handle migrations
-            switch (EE_Maintenance_Mode::instance()->level()) {
-                case EE_Maintenance_Mode::level_0_not_in_maintenance:
-                case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
-                    $show_maintenance_switch = true;
-                    $show_backup_db_text = false;
-                    $show_migration_progress = false;
-                    $script_names = array();
-                    $addons_should_be_upgraded_first = false;
-                    break;
-                case EE_Maintenance_Mode::level_2_complete_maintenance:
-                    $show_maintenance_switch = false;
-                    $show_migration_progress = true;
-                    if (isset($this->_req_data['continue_migration'])) {
-                        $show_backup_db_text = false;
-                    } else {
-                        $show_backup_db_text = true;
-                    }
-                    $scripts_needing_to_run = EE_Data_Migration_Manager::instance()
-                                                                       ->check_for_applicable_data_migration_scripts();
-                    $addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
-                    $script_names = array();
-                    $current_script = null;
-                    foreach ($scripts_needing_to_run as $script) {
-                        if ($script instanceof EE_Data_Migration_Script_Base) {
-                            if ( ! $current_script) {
-                                $current_script = $script;
-                                $current_script->migration_page_hooks();
-                            }
-                            $script_names[] = $script->pretty_name();
-                        }
-                    }
-                    break;
-            }
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-            $exception_thrown = false;
-        } catch (EE_Error $e) {
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
-            //now, just so we can display the page correctly, make a error migration script stage object
-            //and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-            $exception_thrown = true;
-        }
-        $current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
-        $current_db_state = str_replace('.decaf', '', $current_db_state);
-        if ($exception_thrown
-            || ($most_recent_migration
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->is_broken()
-            )
-        ) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
-            $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
-            $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
-                                                                                        'success' => '0',
-            ), EE_MAINTENANCE_ADMIN_URL);
-        } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
-        } else {
-            if ($most_recent_migration
-                && $most_recent_migration instanceof EE_Data_Migration_Script_Base
-                && $most_recent_migration->can_continue()
-            ) {
-                $show_backup_db_text = false;
-                $show_continue_current_migration_script = true;
-                $show_most_recent_migration = true;
-            } elseif (isset($this->_req_data['continue_migration'])) {
-                $show_most_recent_migration = true;
-                $show_continue_current_migration_script = false;
-            } else {
-                $show_most_recent_migration = false;
-                $show_continue_current_migration_script = false;
-            }
-            if (isset($current_script)) {
-                $migrates_to = $current_script->migrates_to_version();
-                $plugin_slug = $migrates_to['slug'];
-                $new_version = $migrates_to['version'];
-                $this->_template_args = array_merge($this->_template_args, array(
-                    'current_db_state' => sprintf(__("EE%s (%s)", "event_espresso"),
-                        isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
-                    'next_db_state'    => isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),
-                        $new_version, $plugin_slug) : null,
-                ));
-            } else {
-                $this->_template_args['current_db_state'] = null;
-                $this->_template_args['next_db_state'] = null;
-            }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
-            $this->_template_args = array_merge(
-                $this->_template_args,
-                array(
-                    'show_most_recent_migration'             => $show_most_recent_migration,
-                    //flag for showing the most recent migration's status and/or errors
-                    'show_migration_progress'                => $show_migration_progress,
-                    //flag for showing the option to run migrations and see their progress
-                    'show_backup_db_text'                    => $show_backup_db_text,
-                    //flag for showing text telling the user to backup their DB
-                    'show_maintenance_switch'                => $show_maintenance_switch,
-                    //flag for showing the option to change maintenance mode between levels 0 and 1
-                    'script_names'                           => $script_names,
-                    //array of names of scripts that have run
-                    'show_continue_current_migration_script' => $show_continue_current_migration_script,
-                    //flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
-                    'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
-                        EE_MAINTENANCE_ADMIN_URL),
-                    'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
-                        EE_MAINTENANCE_ADMIN_URL),
-                    'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'change_maintenance_level'),
-                        EE_MAINTENANCE_ADMIN_URL),
-                    'ultimate_db_state'                      => sprintf(__("EE%s", 'event_espresso'),
-                        espresso_version()),
-                )
-            );
-            //make sure we have the form fields helper available. It usually is, but sometimes it isn't
-            //localize script stuff
-            wp_localize_script('ee-maintenance', 'ee_maintenance', array(
-                'migrating'                        => esc_html__("Updating Database...", "event_espresso"),
-                'next'                             => esc_html__("Next", "event_espresso"),
-                'fatal_error'                      => esc_html__("A Fatal Error Has Occurred", "event_espresso"),
-                'click_next_when_ready'            => esc_html__("The current Database Update has ended. Click 'next' when ready to proceed",
-                    "event_espresso"),
-                'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
-                'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
-                'status_completed'                 => EE_Data_Migration_Manager::status_completed,
-            ));
-        }
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
-        //now render the migration options part, and put it in a variable
-        $migration_options_template_file = apply_filters(
-            'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
-        );
-        $migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args,true);
-        $this->_template_args['migration_options_html'] = $migration_options_html;
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * returns JSON and executes another step of the currently-executing data migration (called via ajax)
-     */
-    public function migration_step()
-    {
-        $this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * Can be used by js when it notices a response with HTML in it in order
-     * to log the malformed response
-     */
-    public function add_error_to_migrations_ran()
-    {
-        EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
-        $this->_template_args['data'] = array('ok' => true);
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * changes the maintenance level, provided there are still no migration scripts that should run
-     */
-    public function _change_maintenance_level()
-    {
-        $new_level = absint($this->_req_data['maintenance_mode_level']);
-        if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
-            $success = true;
-        } else {
-            EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-            $success = false;
-        }
-        $this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
-    }
-
-
-
-    /**
-     * a tab with options for resetting and/or deleting EE data
-     *
-     * @throws \EE_Error
-     * @throws \DomainException
-     */
-    public function _data_reset_and_delete()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
-        $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
-            'reset_reservations',
-            'reset_reservations',
-            array(),
-            'button button-primary',
-            '',
-            false
-        );
-        $this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
-            'reset_capabilities',
-            'reset_capabilities',
-            array(),
-            'button button-primary',
-            '',
-            false
-        );
-        $this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'delete_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array('action' => 'reset_db'),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            $this->_template_path,
-            $this->_template_args,
-            true
-        );
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    protected function _reset_reservations()
-    {
-        if(\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
-            EE_Error::add_success(
-                __(
-                    'Ticket and datetime reserved counts have been successfully reset.',
-                    'event_espresso'
-                )
-            );
-        } else {
-            EE_Error::add_success(
-                __(
-                    'Ticket and datetime reserved counts were correct and did not need resetting.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true);
-    }
-
-
-
-    protected function _reset_capabilities()
-    {
-        EE_Registry::instance()->CAP->init_caps(true);
-        EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.',
-            'event_espresso'));
-        $this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
-    }
-
-
-
-    /**
-     * resets the DMSs so we can attempt to continue migrating after a fatal error
-     * (only a good idea when someone has somehow tried ot fix whatever caused
-     * the fatal error in teh first place)
-     */
-    protected function _reattempt_migration()
-    {
-        EE_Data_Migration_Manager::instance()->reattempt();
-        $this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
-    }
-
-
-
-    /**
-     * shows the big ol' System Information page
-     */
-    public function _system_status()
-    {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
-        $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
-        $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'action' => 'download_system_status',
-            ),
-            EE_MAINTENANCE_ADMIN_URL
-        );
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-    /**
-     * Downloads an HTML file of the system status that can be easily stored or emailed
-     */
-    public function _download_system_status()
-    {
-        $status_info = EEM_System_Status::instance()->get_system_stati();
-        header( 'Content-Disposition: attachment' );
-        header( "Content-Disposition: attachment; filename=system_status_" . sanitize_key( site_url() ) . ".html" );
-        echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
-        echo "<h1>System Information for " . site_url() . "</h1>";
-        echo EEH_Template::layout_array_as_table( $status_info );
-        die;
-    }
-
-
-
-    public function _send_migration_crash_report()
-    {
-        $from = $this->_req_data['from'];
-        $from_name = $this->_req_data['from_name'];
-        $body = $this->_req_data['body'];
-        try {
-            $success = wp_mail(EE_SUPPORT_EMAIL,
-                'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
-                array(
-                    "from:$from_name<$from>",
-                    //					'content-type:text/html charset=UTF-8'
-                ));
-        } catch (Exception $e) {
-            $success = false;
-        }
-        $this->_redirect_after_action($success, esc_html__("Migration Crash Report", "event_espresso"),
-            esc_html__("sent", "event_espresso"),
-            array('success' => $success, 'action' => 'confirm_migration_crash_report_sent'));
-    }
-
-
-
-    public function _confirm_migration_crash_report_sent()
-    {
-        try {
-            $most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
-        } catch (EE_Error $e) {
-            EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
-            //now, just so we can display the page correctly, make a error migration script stage object
-            //and also put the error on it. It only persists for the duration of this request
-            $most_recent_migration = new EE_DMS_Unknown_1_0_0();
-            $most_recent_migration->add_error($e->getMessage());
-        }
-        $success = $this->_req_data['success'] == '1' ? true : false;
-        $this->_template_args['success'] = $success;
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;
-        $this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
-            EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
-            EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
-            EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
-            $this->_template_args, true);
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-
-    /**
-     * Resets the entire EE4 database.
-     * Currently basically only sets up ee4 database for a fresh install- doesn't
-     * actually clean out the old wp options, or cpts (although does erase old ee table data)
-     *
-     * @param boolean $nuke_old_ee4_data controls whether or not we
-     *                                   destroy the old ee4 data, or just try initializing ee4 default data
-     */
-    public function _reset_db($nuke_old_ee4_data = true)
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        if ($nuke_old_ee4_data) {
-            EEH_Activation::delete_all_espresso_cpt_data();
-            EEH_Activation::delete_all_espresso_tables_and_data(false);
-            EEH_Activation::remove_cron_tasks();
-        }
-        //make sure when we reset the registry's config that it
-        //switches to using the new singleton
-        EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
-        EE_System::instance()->initialize_db_if_no_migrations_required(true);
-        EE_System::instance()->redirect_to_about_ee();
-    }
-
-
-
-    /**
-     * Deletes ALL EE tables, Records, and Options from the database.
-     */
-    public function _delete_db()
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data();
-        EEH_Activation::remove_cron_tasks();
-        EEH_Activation::deactivate_event_espresso();
-        wp_safe_redirect(admin_url('plugins.php'));
-        exit;
-    }
-
-
-
-    /**
-     * sets up EE4 to rerun the migrations from ee3 to ee4
-     */
-    public function _rerun_migration_from_ee3()
-    {
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
-        EEH_Activation::delete_all_espresso_cpt_data();
-        EEH_Activation::delete_all_espresso_tables_and_data(false);
-        //set the db state to something that will require migrations
-        update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
-        EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
-        $this->_redirect_after_action(true, esc_html__("Database", 'event_espresso'), esc_html__("reset", 'event_espresso'));
-    }
-
-
-
-    //none of the below group are currently used for Gateway Settings
-    protected function _add_screen_options()
-    {
-    }
-
-
-
-    protected function _add_feature_pointers()
-    {
-    }
-
+	public function __construct($routing = true)
+	{
+		parent::__construct($routing);
+	}
+
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug = EE_MAINTENANCE_PG_SLUG;
+		$this->page_label = EE_MAINTENANCE_LABEL;
+		$this->_admin_base_url = EE_MAINTENANCE_ADMIN_URL;
+		$this->_admin_base_path = EE_MAINTENANCE_ADMIN;
+	}
+
+
+
+	protected function _ajax_hooks()
+	{
+		add_action('wp_ajax_migration_step', array($this, 'migration_step'));
+		add_action('wp_ajax_add_error_to_migrations_ran', array($this, 'add_error_to_migrations_ran'));
+	}
+
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = EE_MAINTENANCE_LABEL;
+		$this->_labels = array(
+			'buttons' => array(
+				'reset_reservations' => esc_html__('Reset Ticket and Datetime Reserved Counts', 'event_espresso'),
+				'reset_capabilities' => esc_html__('Reset Event Espresso Capabilities', 'event_espresso'),
+			),
+		);
+	}
+
+
+
+	protected function _set_page_routes()
+	{
+		$this->_page_routes = array(
+			'default'                             => array(
+				'func'       => '_maintenance',
+				'capability' => 'manage_options',
+			),
+			'change_maintenance_level'            => array(
+				'func'       => '_change_maintenance_level',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'system_status'                       => array(
+				'func'       => '_system_status',
+				'capability' => 'manage_options',
+			),
+			'download_system_status' => array(
+				'func'       => '_download_system_status',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'send_migration_crash_report'         => array(
+				'func'       => '_send_migration_crash_report',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'confirm_migration_crash_report_sent' => array(
+				'func'       => '_confirm_migration_crash_report_sent',
+				'capability' => 'manage_options',
+			),
+			'data_reset'                          => array(
+				'func'       => '_data_reset_and_delete',
+				'capability' => 'manage_options',
+			),
+			'reset_db'                            => array(
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => array('nuke_old_ee4_data' => true),
+			),
+			'start_with_fresh_ee4_db'             => array(
+				'func'       => '_reset_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+				'args'       => array('nuke_old_ee4_data' => false),
+			),
+			'delete_db'                           => array(
+				'func'       => '_delete_db',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'rerun_migration_from_ee3'            => array(
+				'func'       => '_rerun_migration_from_ee3',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reset_reservations'                  => array(
+				'func'       => '_reset_reservations',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reset_capabilities'                  => array(
+				'func'       => '_reset_capabilities',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+			'reattempt_migration'                 => array(
+				'func'       => '_reattempt_migration',
+				'capability' => 'manage_options',
+				'noheader'   => true,
+			),
+		);
+	}
+
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = array(
+			'default'       => array(
+				'nav'           => array(
+					'label' => esc_html__('Maintenance', 'event_espresso'),
+					'order' => 10,
+				),
+				'require_nonce' => false,
+			),
+			'data_reset'    => array(
+				'nav'           => array(
+					'label' => esc_html__('Reset/Delete Data', 'event_espresso'),
+					'order' => 20,
+				),
+				'require_nonce' => false,
+			),
+			'system_status' => array(
+				'nav'           => array(
+					'label' => esc_html__("System Information", "event_espresso"),
+					'order' => 30,
+				),
+				'require_nonce' => false,
+			),
+		);
+	}
+
+
+
+	/**
+	 * default maintenance page. If we're in maintenance mode level 2, then we need to show
+	 * the migration scripts and all that UI.
+	 */
+	public function _maintenance()
+	{
+		//it all depends if we're in maintenance model level 1 (frontend-only) or
+		//level 2 (everything except maintenance page)
+		try {
+			//get the current maintenance level and check if
+			//we are removed
+			$mm = EE_Maintenance_Mode::instance()->level();
+			$placed_in_mm = EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+			if ($mm == EE_Maintenance_Mode::level_2_complete_maintenance && ! $placed_in_mm) {
+				//we just took the site out of maintenance mode, so notify the user.
+				//unfortunately this message appears to be echoed on the NEXT page load...
+				//oh well, we should really be checking for this on addon deactivation anyways
+				EE_Error::add_attention(__('Site taken out of maintenance mode because no data migration scripts are required',
+					'event_espresso'));
+				$this->_process_notices(array('page' => 'espresso_maintenance_settings'), false);
+			}
+			//in case an exception is thrown while trying to handle migrations
+			switch (EE_Maintenance_Mode::instance()->level()) {
+				case EE_Maintenance_Mode::level_0_not_in_maintenance:
+				case EE_Maintenance_Mode::level_1_frontend_only_maintenance:
+					$show_maintenance_switch = true;
+					$show_backup_db_text = false;
+					$show_migration_progress = false;
+					$script_names = array();
+					$addons_should_be_upgraded_first = false;
+					break;
+				case EE_Maintenance_Mode::level_2_complete_maintenance:
+					$show_maintenance_switch = false;
+					$show_migration_progress = true;
+					if (isset($this->_req_data['continue_migration'])) {
+						$show_backup_db_text = false;
+					} else {
+						$show_backup_db_text = true;
+					}
+					$scripts_needing_to_run = EE_Data_Migration_Manager::instance()
+																	   ->check_for_applicable_data_migration_scripts();
+					$addons_should_be_upgraded_first = EE_Data_Migration_Manager::instance()->addons_need_updating();
+					$script_names = array();
+					$current_script = null;
+					foreach ($scripts_needing_to_run as $script) {
+						if ($script instanceof EE_Data_Migration_Script_Base) {
+							if ( ! $current_script) {
+								$current_script = $script;
+								$current_script->migration_page_hooks();
+							}
+							$script_names[] = $script->pretty_name();
+						}
+					}
+					break;
+			}
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
+			$exception_thrown = false;
+		} catch (EE_Error $e) {
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
+			//now, just so we can display the page correctly, make a error migration script stage object
+			//and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+			$exception_thrown = true;
+		}
+		$current_db_state = EE_Data_Migration_Manager::instance()->ensure_current_database_state_is_set();
+		$current_db_state = str_replace('.decaf', '', $current_db_state);
+		if ($exception_thrown
+			|| ($most_recent_migration
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->is_broken()
+			)
+		) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+			$this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
+			$this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
+																						'success' => '0',
+			), EE_MAINTENANCE_ADMIN_URL);
+		} elseif ($addons_should_be_upgraded_first) {
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+		} else {
+			if ($most_recent_migration
+				&& $most_recent_migration instanceof EE_Data_Migration_Script_Base
+				&& $most_recent_migration->can_continue()
+			) {
+				$show_backup_db_text = false;
+				$show_continue_current_migration_script = true;
+				$show_most_recent_migration = true;
+			} elseif (isset($this->_req_data['continue_migration'])) {
+				$show_most_recent_migration = true;
+				$show_continue_current_migration_script = false;
+			} else {
+				$show_most_recent_migration = false;
+				$show_continue_current_migration_script = false;
+			}
+			if (isset($current_script)) {
+				$migrates_to = $current_script->migrates_to_version();
+				$plugin_slug = $migrates_to['slug'];
+				$new_version = $migrates_to['version'];
+				$this->_template_args = array_merge($this->_template_args, array(
+					'current_db_state' => sprintf(__("EE%s (%s)", "event_espresso"),
+						isset($current_db_state[$plugin_slug]) ? $current_db_state[$plugin_slug] : 3, $plugin_slug),
+					'next_db_state'    => isset($current_script) ? sprintf(__("EE%s (%s)", 'event_espresso'),
+						$new_version, $plugin_slug) : null,
+				));
+			} else {
+				$this->_template_args['current_db_state'] = null;
+				$this->_template_args['next_db_state'] = null;
+			}
+			$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+			$this->_template_args = array_merge(
+				$this->_template_args,
+				array(
+					'show_most_recent_migration'             => $show_most_recent_migration,
+					//flag for showing the most recent migration's status and/or errors
+					'show_migration_progress'                => $show_migration_progress,
+					//flag for showing the option to run migrations and see their progress
+					'show_backup_db_text'                    => $show_backup_db_text,
+					//flag for showing text telling the user to backup their DB
+					'show_maintenance_switch'                => $show_maintenance_switch,
+					//flag for showing the option to change maintenance mode between levels 0 and 1
+					'script_names'                           => $script_names,
+					//array of names of scripts that have run
+					'show_continue_current_migration_script' => $show_continue_current_migration_script,
+					//flag to change wording to indicating that we're only CONTINUING a migration script (somehow it got interrupted0
+					'reset_db_page_link'                     => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
+						EE_MAINTENANCE_ADMIN_URL),
+					'data_reset_page'                        => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
+						EE_MAINTENANCE_ADMIN_URL),
+					'update_migration_script_page_link'      => EE_Admin_Page::add_query_args_and_nonce(array('action' => 'change_maintenance_level'),
+						EE_MAINTENANCE_ADMIN_URL),
+					'ultimate_db_state'                      => sprintf(__("EE%s", 'event_espresso'),
+						espresso_version()),
+				)
+			);
+			//make sure we have the form fields helper available. It usually is, but sometimes it isn't
+			//localize script stuff
+			wp_localize_script('ee-maintenance', 'ee_maintenance', array(
+				'migrating'                        => esc_html__("Updating Database...", "event_espresso"),
+				'next'                             => esc_html__("Next", "event_espresso"),
+				'fatal_error'                      => esc_html__("A Fatal Error Has Occurred", "event_espresso"),
+				'click_next_when_ready'            => esc_html__("The current Database Update has ended. Click 'next' when ready to proceed",
+					"event_espresso"),
+				'status_no_more_migration_scripts' => EE_Data_Migration_Manager::status_no_more_migration_scripts,
+				'status_fatal_error'               => EE_Data_Migration_Manager::status_fatal_error,
+				'status_completed'                 => EE_Data_Migration_Manager::status_completed,
+			));
+		}
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
+		//now render the migration options part, and put it in a variable
+		$migration_options_template_file = apply_filters(
+			'FHEE__ee_migration_page__migration_options_template',
+			EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+		);
+		$migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args,true);
+		$this->_template_args['migration_options_html'] = $migration_options_html;
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * returns JSON and executes another step of the currently-executing data migration (called via ajax)
+	 */
+	public function migration_step()
+	{
+		$this->_template_args['data'] = EE_Data_Migration_Manager::instance()->response_to_migration_ajax_request();
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * Can be used by js when it notices a response with HTML in it in order
+	 * to log the malformed response
+	 */
+	public function add_error_to_migrations_ran()
+	{
+		EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($this->_req_data['message']);
+		$this->_template_args['data'] = array('ok' => true);
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * changes the maintenance level, provided there are still no migration scripts that should run
+	 */
+	public function _change_maintenance_level()
+	{
+		$new_level = absint($this->_req_data['maintenance_mode_level']);
+		if ( ! EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			EE_Maintenance_Mode::instance()->set_maintenance_level($new_level);
+			$success = true;
+		} else {
+			EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+			$success = false;
+		}
+		$this->_redirect_after_action($success, 'Maintenance Mode', esc_html__("Updated", "event_espresso"));
+	}
+
+
+
+	/**
+	 * a tab with options for resetting and/or deleting EE data
+	 *
+	 * @throws \EE_Error
+	 * @throws \DomainException
+	 */
+	public function _data_reset_and_delete()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+		$this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
+			'reset_reservations',
+			'reset_reservations',
+			array(),
+			'button button-primary',
+			'',
+			false
+		);
+		$this->_template_args['reset_capabilities_button'] = $this->get_action_link_or_button(
+			'reset_capabilities',
+			'reset_capabilities',
+			array(),
+			'button button-primary',
+			'',
+			false
+		);
+		$this->_template_args['delete_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'delete_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['reset_db_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array('action' => 'reset_db'),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			$this->_template_path,
+			$this->_template_args,
+			true
+		);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	protected function _reset_reservations()
+	{
+		if(\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+			EE_Error::add_success(
+				__(
+					'Ticket and datetime reserved counts have been successfully reset.',
+					'event_espresso'
+				)
+			);
+		} else {
+			EE_Error::add_success(
+				__(
+					'Ticket and datetime reserved counts were correct and did not need resetting.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_redirect_after_action(true, '', '', array('action' => 'data_reset'), true);
+	}
+
+
+
+	protected function _reset_capabilities()
+	{
+		EE_Registry::instance()->CAP->init_caps(true);
+		EE_Error::add_success(__('Default Event Espresso capabilities have been restored for all current roles.',
+			'event_espresso'));
+		$this->_redirect_after_action(false, '', '', array('action' => 'data_reset'), true);
+	}
+
+
+
+	/**
+	 * resets the DMSs so we can attempt to continue migrating after a fatal error
+	 * (only a good idea when someone has somehow tried ot fix whatever caused
+	 * the fatal error in teh first place)
+	 */
+	protected function _reattempt_migration()
+	{
+		EE_Data_Migration_Manager::instance()->reattempt();
+		$this->_redirect_after_action(false, '', '', array('action' => 'default'), true);
+	}
+
+
+
+	/**
+	 * shows the big ol' System Information page
+	 */
+	public function _system_status()
+	{
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+		$this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
+		$this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'action' => 'download_system_status',
+			),
+			EE_MAINTENANCE_ADMIN_URL
+		);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+	/**
+	 * Downloads an HTML file of the system status that can be easily stored or emailed
+	 */
+	public function _download_system_status()
+	{
+		$status_info = EEM_System_Status::instance()->get_system_stati();
+		header( 'Content-Disposition: attachment' );
+		header( "Content-Disposition: attachment; filename=system_status_" . sanitize_key( site_url() ) . ".html" );
+		echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
+		echo "<h1>System Information for " . site_url() . "</h1>";
+		echo EEH_Template::layout_array_as_table( $status_info );
+		die;
+	}
+
+
+
+	public function _send_migration_crash_report()
+	{
+		$from = $this->_req_data['from'];
+		$from_name = $this->_req_data['from_name'];
+		$body = $this->_req_data['body'];
+		try {
+			$success = wp_mail(EE_SUPPORT_EMAIL,
+				'Migration Crash Report',
+				$body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+				array(
+					"from:$from_name<$from>",
+					//					'content-type:text/html charset=UTF-8'
+				));
+		} catch (Exception $e) {
+			$success = false;
+		}
+		$this->_redirect_after_action($success, esc_html__("Migration Crash Report", "event_espresso"),
+			esc_html__("sent", "event_espresso"),
+			array('success' => $success, 'action' => 'confirm_migration_crash_report_sent'));
+	}
+
+
+
+	public function _confirm_migration_crash_report_sent()
+	{
+		try {
+			$most_recent_migration = EE_Data_Migration_Manager::instance()->get_last_ran_script(true);
+		} catch (EE_Error $e) {
+			EE_Data_Migration_Manager::instance()->add_error_to_migrations_ran($e->getMessage());
+			//now, just so we can display the page correctly, make a error migration script stage object
+			//and also put the error on it. It only persists for the duration of this request
+			$most_recent_migration = new EE_DMS_Unknown_1_0_0();
+			$most_recent_migration->add_error($e->getMessage());
+		}
+		$success = $this->_req_data['success'] == '1' ? true : false;
+		$this->_template_args['success'] = $success;
+		$this->_template_args['most_recent_migration'] = $most_recent_migration;
+		$this->_template_args['reset_db_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reset_db'),
+			EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_args['reset_db_page_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'data_reset'),
+			EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
+			EE_MAINTENANCE_ADMIN_URL);
+		$this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
+			$this->_template_args, true);
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+
+	/**
+	 * Resets the entire EE4 database.
+	 * Currently basically only sets up ee4 database for a fresh install- doesn't
+	 * actually clean out the old wp options, or cpts (although does erase old ee table data)
+	 *
+	 * @param boolean $nuke_old_ee4_data controls whether or not we
+	 *                                   destroy the old ee4 data, or just try initializing ee4 default data
+	 */
+	public function _reset_db($nuke_old_ee4_data = true)
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		if ($nuke_old_ee4_data) {
+			EEH_Activation::delete_all_espresso_cpt_data();
+			EEH_Activation::delete_all_espresso_tables_and_data(false);
+			EEH_Activation::remove_cron_tasks();
+		}
+		//make sure when we reset the registry's config that it
+		//switches to using the new singleton
+		EE_Registry::instance()->CFG = EE_Registry::instance()->CFG->reset(true);
+		EE_System::instance()->initialize_db_if_no_migrations_required(true);
+		EE_System::instance()->redirect_to_about_ee();
+	}
+
+
+
+	/**
+	 * Deletes ALL EE tables, Records, and Options from the database.
+	 */
+	public function _delete_db()
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data();
+		EEH_Activation::remove_cron_tasks();
+		EEH_Activation::deactivate_event_espresso();
+		wp_safe_redirect(admin_url('plugins.php'));
+		exit;
+	}
+
+
+
+	/**
+	 * sets up EE4 to rerun the migrations from ee3 to ee4
+	 */
+	public function _rerun_migration_from_ee3()
+	{
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_0_not_in_maintenance);
+		EEH_Activation::delete_all_espresso_cpt_data();
+		EEH_Activation::delete_all_espresso_tables_and_data(false);
+		//set the db state to something that will require migrations
+		update_option(EE_Data_Migration_Manager::current_database_state, '3.1.36.0');
+		EE_Maintenance_Mode::instance()->set_maintenance_level(EE_Maintenance_Mode::level_2_complete_maintenance);
+		$this->_redirect_after_action(true, esc_html__("Database", 'event_espresso'), esc_html__("reset", 'event_espresso'));
+	}
+
+
+
+	//none of the below group are currently used for Gateway Settings
+	protected function _add_screen_options()
+	{
+	}
+
+
+
+	protected function _add_feature_pointers()
+	{
+	}
+
 
 
-    public function admin_init()
-    {
-    }
-
-
-
-    public function admin_notices()
-    {
-    }
-
+	public function admin_init()
+	{
+	}
+
+
+
+	public function admin_notices()
+	{
+	}
+
 
 
-    public function admin_footer_scripts()
-    {
-    }
+	public function admin_footer_scripts()
+	{
+	}
 
 
 
-    public function load_scripts_styles()
-    {
-        wp_enqueue_script('ee_admin_js');
+	public function load_scripts_styles()
+	{
+		wp_enqueue_script('ee_admin_js');
 //		wp_enqueue_media();
 //		wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
-            EVENT_ESPRESSO_VERSION, true);
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
-            EVENT_ESPRESSO_VERSION);
-        wp_enqueue_style('espresso_maintenance');
-    }
+		wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
+			EVENT_ESPRESSO_VERSION, true);
+		wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
+			EVENT_ESPRESSO_VERSION);
+		wp_enqueue_style('espresso_maintenance');
+	}
 
 
 
-    public function load_scripts_styles_default()
-    {
-        //styles
+	public function load_scripts_styles_default()
+	{
+		//styles
 //		wp_enqueue_style('ee-text-links');
 //		//scripts
 //		wp_enqueue_script('ee-text-links');
-    }
+	}
 
 
 

Spacing +17 added lines, -17 removed lines

@@ -244,13 +244,13 @@ 
                 && $most_recent_migration->is_broken()
             )
         ) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_was_borked_page.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_was_borked_page.template.php';
             $this->_template_args['support_url'] = 'http://eventespresso.com/support/forums/';
             $this->_template_args['next_url'] = EEH_URL::add_query_args_and_nonce(array('action'  => 'confirm_migration_crash_report_sent',
                                                                                         'success' => '0',
             ), EE_MAINTENANCE_ADMIN_URL);
         } elseif ($addons_should_be_upgraded_first) {
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_upgrade_addons_before_migrating.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_upgrade_addons_before_migrating.template.php';
         } else {
             if ($most_recent_migration
                 && $most_recent_migration instanceof EE_Data_Migration_Script_Base
@@ -280,7 +280,7 @@ 
                 $this->_template_args['current_db_state'] = null;
                 $this->_template_args['next_db_state'] = null;
             }
-            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_migration_page.template.php';
+            $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_migration_page.template.php';
             $this->_template_args = array_merge(
                 $this->_template_args,
                 array(
@@ -319,13 +319,13 @@ 
                 'status_completed'                 => EE_Data_Migration_Manager::status_completed,
             ));
         }
-        $this->_template_args['most_recent_migration'] = $most_recent_migration;//the actual most recently ran migration
+        $this->_template_args['most_recent_migration'] = $most_recent_migration; //the actual most recently ran migration
         //now render the migration options part, and put it in a variable
         $migration_options_template_file = apply_filters(
             'FHEE__ee_migration_page__migration_options_template',
-            EE_MAINTENANCE_TEMPLATE_PATH . 'migration_options_from_ee4.template.php'
+            EE_MAINTENANCE_TEMPLATE_PATH.'migration_options_from_ee4.template.php'
         );
-        $migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args,true);
+        $migration_options_html = EEH_Template::display_template($migration_options_template_file, $this->_template_args, true);
         $this->_template_args['migration_options_html'] = $migration_options_html;
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
             $this->_template_args, true);
@@ -384,7 +384,7 @@ 
      */
     public function _data_reset_and_delete()
     {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_data_reset_and_delete.template.php';
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_data_reset_and_delete.template.php';
         $this->_template_args['reset_reservations_button'] = $this->get_action_link_or_button(
             'reset_reservations',
             'reset_reservations',
@@ -421,7 +421,7 @@ 
 
     protected function _reset_reservations()
     {
-        if(\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
+        if (\EED_Ticket_Sales_Monitor::reset_reservation_counts()) {
             EE_Error::add_success(
                 __(
                     'Ticket and datetime reserved counts have been successfully reset.',
@@ -469,7 +469,7 @@ 
      */
     public function _system_status()
     {
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_system_stati_page.template.php';
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_system_stati_page.template.php';
         $this->_template_args['system_stati'] = EEM_System_Status::instance()->get_system_stati();
         $this->_template_args['download_system_status_url'] = EE_Admin_Page::add_query_args_and_nonce(
             array(
@@ -488,11 +488,11 @@ 
     public function _download_system_status()
     {
         $status_info = EEM_System_Status::instance()->get_system_stati();
-        header( 'Content-Disposition: attachment' );
-        header( "Content-Disposition: attachment; filename=system_status_" . sanitize_key( site_url() ) . ".html" );
+        header('Content-Disposition: attachment');
+        header("Content-Disposition: attachment; filename=system_status_".sanitize_key(site_url()).".html");
         echo "<style>table{border:1px solid darkgrey;}td{vertical-align:top}</style>";
-        echo "<h1>System Information for " . site_url() . "</h1>";
-        echo EEH_Template::layout_array_as_table( $status_info );
+        echo "<h1>System Information for ".site_url()."</h1>";
+        echo EEH_Template::layout_array_as_table($status_info);
         die;
     }
 
@@ -506,7 +506,7 @@ 
         try {
             $success = wp_mail(EE_SUPPORT_EMAIL,
                 'Migration Crash Report',
-                $body . "/r/n<br>" . print_r(EEM_System_Status::instance()->get_system_stati(), true),
+                $body."/r/n<br>".print_r(EEM_System_Status::instance()->get_system_stati(), true),
                 array(
                     "from:$from_name<$from>",
                     //					'content-type:text/html charset=UTF-8'
@@ -541,7 +541,7 @@ 
             EE_MAINTENANCE_ADMIN_URL);
         $this->_template_args['reattempt_action_url'] = EE_Admin_Page::add_query_args_and_nonce(array('action' => 'reattempt_migration'),
             EE_MAINTENANCE_ADMIN_URL);
-        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH . 'ee_confirm_migration_crash_report_sent.template.php';
+        $this->_template_path = EE_MAINTENANCE_TEMPLATE_PATH.'ee_confirm_migration_crash_report_sent.template.php';
         $this->_template_args['admin_page_content'] = EEH_Template::display_template($this->_template_path,
             $this->_template_args, true);
         $this->display_admin_page_with_sidebar();
@@ -642,9 +642,9 @@ 
         wp_enqueue_script('ee_admin_js');
 //		wp_enqueue_media();
 //		wp_enqueue_script('media-upload');
-        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL . '/ee-maintenance.js', array('jquery'),
+        wp_enqueue_script('ee-maintenance', EE_MAINTENANCE_ASSETS_URL.'/ee-maintenance.js', array('jquery'),
             EVENT_ESPRESSO_VERSION, true);
-        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL . 'ee-maintenance.css', array(),
+        wp_register_style('espresso_maintenance', EE_MAINTENANCE_ASSETS_URL.'ee-maintenance.css', array(),
             EVENT_ESPRESSO_VERSION);
         wp_enqueue_style('espresso_maintenance');
     }

core/services/loaders/CoreLoader.php

Spacing +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
      */
     public function __construct($generator)
     {
-        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     /**
      * CoreLoader constructor.
      *
-     * @param EE_Registry|CoffeeShop $generator
+     * @param EE_Registry $generator
      * @throws InvalidArgumentException
      */
     public function __construct($generator)

Indentation +52 added lines, -52 removed lines

@@ -23,58 +23,58 @@
 class CoreLoader implements LoaderDecoratorInterface
 {
 
-    /**
-     * @var EE_Registry|CoffeeShop $generator
-     */
-    private $generator;
-
-
-
-    /**
-     * CoreLoader constructor.
-     *
-     * @param EE_Registry|CoffeeShop $generator
-     * @throws InvalidArgumentException
-     */
-    public function __construct($generator)
-    {
-        if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->generator = $generator;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws ServiceNotFoundException
-     */
-    public function load($fqcn, $arguments = array())
-    {
-        return $this->generator instanceof EE_Registry
-            ? $this->generator->create($fqcn, $arguments)
-            : $this->generator->brew($fqcn, $arguments);
-    }
-
-
-
-    /**
-     * calls reset() on generator if method exists
-     */
-    public function reset()
-    {
-        if (method_exists($this->generator, 'reset')) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * @var EE_Registry|CoffeeShop $generator
+	 */
+	private $generator;
+
+
+
+	/**
+	 * CoreLoader constructor.
+	 *
+	 * @param EE_Registry|CoffeeShop $generator
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($generator)
+	{
+		if(!($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->generator = $generator;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws ServiceNotFoundException
+	 */
+	public function load($fqcn, $arguments = array())
+	{
+		return $this->generator instanceof EE_Registry
+			? $this->generator->create($fqcn, $arguments)
+			: $this->generator->brew($fqcn, $arguments);
+	}
+
+
+
+	/**
+	 * calls reset() on generator if method exists
+	 */
+	public function reset()
+	{
+		if (method_exists($this->generator, 'reset')) {
+			$this->generator->reset();
+		}
+	}
 
 }
 // End of file CoreLoader.php

core/services/collections/CollectionInterface.php

Spacing +15 added lines, -15 removed lines

@@ -1,8 +1,8 @@ 
 <?php
 namespace EventEspresso\core\services\collections;
 
-if ( ! defined( 'EVENT_ESPRESSO_VERSION' ) ) {
-	exit( 'No direct script access allowed' );
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
+	exit('No direct script access allowed');
 }
 
 
@@ -27,7 +27,7 @@ 
 	 * @param  mixed $identifier
 	 * @return bool
 	 */
-	public function add( $object, $identifier = null );
+	public function add($object, $identifier = null);
 
 	/**
 	 * setIdentifier
@@ -39,7 +39,7 @@ 
 	 * @param  mixed $identifier
 	 * @return bool
 	 */
-	public function setIdentifier( $object, $identifier = null );
+	public function setIdentifier($object, $identifier = null);
 
 	/**
 	 * get
@@ -50,7 +50,7 @@ 
 	 * @param mixed $identifier
 	 * @return mixed
 	 */
-	public function get( $identifier );
+	public function get($identifier);
 
 	/**
 	 * has
@@ -62,7 +62,7 @@ 
 	 * @param  mixed $identifier
 	 * @return bool
 	 */
-	public function has( $identifier );
+	public function has($identifier);
 
 	/**
 	 * hasObject
@@ -72,7 +72,7 @@ 
 	 * @param $object
 	 * @return bool
 	 */
-	public function hasObject( $object );
+	public function hasObject($object);
 
 	/**
 	 * remove
@@ -82,7 +82,7 @@ 
 	 * @param $object
 	 * @return bool
 	 */
-	public function remove( $object );
+	public function remove($object);
 
 	/**
 	 * setCurrent
@@ -92,7 +92,7 @@ 
 	 * @param mixed $identifier
 	 * @return boolean
 	 */
-	public function setCurrent( $identifier ) ;
+	public function setCurrent($identifier);
 
 	/**
 	 * setCurrentUsingObject
@@ -102,7 +102,7 @@ 
 	 * @param $object
 	 * @return boolean
 	 */
-	public function setCurrentUsingObject( $object );
+	public function setCurrentUsingObject($object);
 
 	/**
 	 * Returns the object occupying the index before the current object,
@@ -119,7 +119,7 @@ 
 	 * @param $object
 	 * @return boolean|int|string
 	 */
-	public function indexOf( $object );
+	public function indexOf($object);
 
 
 	/**
@@ -129,7 +129,7 @@ 
 	 * @param $index
 	 * @return mixed
 	 */
-	public function objectAtIndex( $index );
+	public function objectAtIndex($index);
 
 	/**
 	 * Returns the sequence of objects as specified by the offset and length
@@ -139,7 +139,7 @@ 
 	 * @param int $length
 	 * @return array
 	 */
-	public function slice( $offset, $length );
+	public function slice($offset, $length);
 
 	/**
 	 * Inserts an object (or an array of objects) at a certain point
@@ -148,7 +148,7 @@ 
 	 * @param mixed   $objects A single object or an array of objects
 	 * @param integer $index
 	 */
-	public function insertAt( $objects, $index );
+	public function insertAt($objects, $index);
 
 	/**
 	 * Removes the object at the given index
@@ -156,7 +156,7 @@ 
 	 * @see http://stackoverflow.com/a/8736013
 	 * @param integer $index
 	 */
-	public function removeAt( $index ) ;
+	public function removeAt($index);
 
 
 

Indentation +10 added lines, -10 removed lines

@@ -113,12 +113,12 @@ 
 	public function previous();
 
 		/**
-	 * Returns the index of a given object, or false if not found
-	 *
-	 * @see http://stackoverflow.com/a/8736013
-	 * @param $object
-	 * @return boolean|int|string
-	 */
+		 * Returns the index of a given object, or false if not found
+		 *
+		 * @see http://stackoverflow.com/a/8736013
+		 * @param $object
+		 * @return boolean|int|string
+		 */
 	public function indexOf( $object );
 
 
@@ -160,10 +160,10 @@ 
 
 
 
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll();
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll();
 
 }
 // End of file CollectionInterface.php

core/services/collections/Collection.php

Indentation +12 added lines, -13 removed lines

@@ -83,7 +83,6 @@ 
 
 	 /**
 	  * setIdentifier
-
 	  * Sets the data associated with an object in the Collection
 	  * if no $identifier is supplied, then the spl_object_hash() is used
 	  *
@@ -352,18 +351,18 @@ 
 
 
 
-     /**
-      * detaches ALL objects from the Collection
-      */
-     public function detachAll()
-     {
-         $this->rewind();
-         while ($this->valid()) {
-             $object = $this->current();
-             $this->next();
-             $this->detach($object);
-         }
-     }
+	 /**
+	  * detaches ALL objects from the Collection
+	  */
+	 public function detachAll()
+	 {
+		 $this->rewind();
+		 while ($this->valid()) {
+			 $object = $this->current();
+			 $this->next();
+			 $this->detach($object);
+		 }
+	 }
 
 
 

Doc Comments +3 added lines, -3 removed lines

@@ -65,7 +65,7 @@ 
 	  * by calling EE_Object_Collection::set_identifier()
 	  *
 	  * @access public
-	  * @param        $object
+	  * @param        \EventEspresso\core\services\progress_steps\ProgressStep $object
 	  * @param  mixed $identifier
 	  * @return bool
 	  * @throws \EventEspresso\core\exceptions\InvalidEntityException
@@ -211,7 +211,7 @@ 
 	  * advances pointer to the provided object
 	  *
 	  * @access public
-	  * @param $object
+	  * @param \EventEspresso\core\libraries\form_sections\form_handlers\SequentialStepForm $object
 	  * @return boolean
 	  */
 	 public function setCurrentUsingObject( $object ) {
@@ -249,7 +249,7 @@ 
 	  *
 	  * @see http://stackoverflow.com/a/8736013
 	  * @param $object
-	  * @return boolean|int|string
+	  * @return integer
 	  */
 	 public function indexOf( $object ) {
 		 if ( ! $this->contains( $object ) ) {

core/services/loaders/CachingLoader.php

Spacing +4 added lines, -4 removed lines

@@ -102,17 +102,17 @@
         $fqcn = ltrim($fqcn, '\\');
         // caching can be turned off via the following code:
         // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if(
+        if (
             apply_filters(
                 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
                 false,
                 $this
             )
-        ){
+        ) {
             return $this->loader->load($fqcn, $arguments);
         }
-        $identifier = md5($fqcn . serialize($arguments));
-        if($this->cache->has($identifier)){
+        $identifier = md5($fqcn.serialize($arguments));
+        if ($this->cache->has($identifier)) {
             return $this->cache->get($identifier);
         }
         $object = $this->loader->load($fqcn, $arguments);

Indentation +108 added lines, -108 removed lines

@@ -22,114 +22,114 @@
 class CachingLoader extends LoaderDecorator
 {
 
-    /**
-     * @var CollectionInterface $cache
-     */
-    protected $cache;
-
-    /**
-     * @var string $identifier
-     */
-    protected $identifier;
-
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderDecoratorInterface $loader, CollectionInterface $cache, $identifier = '')
-    {
-        parent::__construct($loader);
-        $this->cache = $cache;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso\core\services\loaders\CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-    }
-
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if ( ! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws InvalidEntityException
-     * @throws ServiceNotFoundException
-     */
-    public function load($fqcn, $arguments = array())
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-                false,
-                $this
-            )
-        ){
-            return $this->loader->load($fqcn, $arguments);
-        }
-        $identifier = md5($fqcn . serialize($arguments));
-        if($this->cache->has($identifier)){
-            return $this->cache->get($identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments);
-        $this->cache->add($object, $identifier);
-        return $object;
-    }
-
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->cache->detachAll();
-        $this->loader->reset();
-    }
+	/**
+	 * @var CollectionInterface $cache
+	 */
+	protected $cache;
+
+	/**
+	 * @var string $identifier
+	 */
+	protected $identifier;
+
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderDecoratorInterface $loader, CollectionInterface $cache, $identifier = '')
+	{
+		parent::__construct($loader);
+		$this->cache = $cache;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso\core\services\loaders\CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+	}
+
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if ( ! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InvalidEntityException
+	 * @throws ServiceNotFoundException
+	 */
+	public function load($fqcn, $arguments = array())
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+				false,
+				$this
+			)
+		){
+			return $this->loader->load($fqcn, $arguments);
+		}
+		$identifier = md5($fqcn . serialize($arguments));
+		if($this->cache->has($identifier)){
+			return $this->cache->get($identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments);
+		$this->cache->add($object, $identifier);
+		return $object;
+	}
+
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->cache->detachAll();
+		$this->loader->reset();
+	}
 
 
 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +989 added lines, -989 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -19,1048 +19,1048 @@ 
 {
 
 
-    /**
-     * possibly truncated version of the EE core version string
-     *
-     * @var string
-     */
-    protected static $_core_version = '';
+	/**
+	 * possibly truncated version of the EE core version string
+	 *
+	 * @var string
+	 */
+	protected static $_core_version = '';
 
-    /**
-     * Holds values for registered addons
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered addons
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
-    /**
-     * @var  array $_incompatible_addons keys are addon SLUGS
-     * (first argument passed to EE_Register_Addon::register()), keys are
-     * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
-     * Generally this should be used sparingly, as we don't want to muddle up
-     * EE core with knowledge of ALL the addons out there.
-     * If you want NO versions of an addon to run with a certain version of core,
-     * it's usually best to define the addon's "min_core_version" as part of its call
-     * to EE_Register_Addon::register(), rather than using this array with a super high value for its
-     * minimum plugin version.
-     * @access    protected
-     */
-    protected static $_incompatible_addons = array(
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-    );
+	/**
+	 * @var  array $_incompatible_addons keys are addon SLUGS
+	 * (first argument passed to EE_Register_Addon::register()), keys are
+	 * their MINIMUM VERSION (with all 5 parts. Eg 1.2.3.rc.004).
+	 * Generally this should be used sparingly, as we don't want to muddle up
+	 * EE core with knowledge of ALL the addons out there.
+	 * If you want NO versions of an addon to run with a certain version of core,
+	 * it's usually best to define the addon's "min_core_version" as part of its call
+	 * to EE_Register_Addon::register(), rather than using this array with a super high value for its
+	 * minimum plugin version.
+	 * @access    protected
+	 */
+	protected static $_incompatible_addons = array(
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+	);
 
 
-    /**
-     * We should always be comparing core to a version like '4.3.0.rc.000',
-     * not just '4.3.0'.
-     * So if the addon developer doesn't provide that full version string,
-     * fill in the blanks for them
-     *
-     * @param string $min_core_version
-     * @return string always like '4.3.0.rc.000'
-     */
-    protected static function _effective_version($min_core_version)
-    {
-        // versions: 4 . 3 . 1 . p . 123
-        // offsets:    0 . 1 . 2 . 3 . 4
-        $version_parts = explode('.', $min_core_version);
-        //check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
-            $version_parts[2] = '0';
-        }
-        //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
-        //soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
-            $version_parts[3] = 'dev';
-        }
-        if (! isset($version_parts[4])) {
-            $version_parts[4] = '000';
-        }
-        return implode('.', $version_parts);
-    }
+	/**
+	 * We should always be comparing core to a version like '4.3.0.rc.000',
+	 * not just '4.3.0'.
+	 * So if the addon developer doesn't provide that full version string,
+	 * fill in the blanks for them
+	 *
+	 * @param string $min_core_version
+	 * @return string always like '4.3.0.rc.000'
+	 */
+	protected static function _effective_version($min_core_version)
+	{
+		// versions: 4 . 3 . 1 . p . 123
+		// offsets:    0 . 1 . 2 . 3 . 4
+		$version_parts = explode('.', $min_core_version);
+		//check they specified the micro version (after 2nd period)
+		if (! isset($version_parts[2])) {
+			$version_parts[2] = '0';
+		}
+		//if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
+		//soon we can assume that's 'rc', but this current version is 'alpha'
+		if (! isset($version_parts[3])) {
+			$version_parts[3] = 'dev';
+		}
+		if (! isset($version_parts[4])) {
+			$version_parts[4] = '000';
+		}
+		return implode('.', $version_parts);
+	}
 
 
-    /**
-     * Returns whether or not the min core version requirement of the addon is met
-     *
-     * @param string $min_core_version    the minimum core version required by the addon
-     * @param string $actual_core_version the actual core version, optional
-     * @return boolean
-     */
-    public static function _meets_min_core_version_requirement(
-        $min_core_version,
-        $actual_core_version = EVENT_ESPRESSO_VERSION
-    ) {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
+	/**
+	 * Returns whether or not the min core version requirement of the addon is met
+	 *
+	 * @param string $min_core_version    the minimum core version required by the addon
+	 * @param string $actual_core_version the actual core version, optional
+	 * @return boolean
+	 */
+	public static function _meets_min_core_version_requirement(
+		$min_core_version,
+		$actual_core_version = EVENT_ESPRESSO_VERSION
+	) {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
 
 
-    /**
-     *    Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @since    4.3.0
-     * @param string                  $addon_name                           the EE_Addon's name. Required.
-     * @param  array                  $setup_args                           {                                    An
-     *                                                                      array of arguments provided for registering
-     *                                                                      the message type.
-     * @type  string                  $class_name                           the addon's main file name.
-     *                                                                      If left blank, generated from the addon
-     *                                                                      name, changes something like "calendar" to
-     *                                                                      "EE_Calendar"
-     * @type string                   $min_core_version                     the minimum version of EE Core that the
-     *       addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                              the "software" version for the addon. eg
-     *       "1.0.0.p" for a first stable release, or "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                       the full server path to the main file
-     *       loaded
-     *                                                                      directly by WP
-     * @type string                   $admin_path                           full server path to the folder where the
-     *       addon\'s admin files reside
-     * @type string                   $admin_callback                       a method to be called when the EE Admin is
-     *       first invoked, can be used for hooking into any admin page
-     * @type string                   $config_section                       the section name for this addon's
-     *       configuration settings section (defaults to "addons")
-     * @type string                   $config_class                         the class name for this addon's
-     *       configuration settings object
-     * @type string                   $config_name                          the class name for this addon's
-     *       configuration settings object
-     * @type string                   $autoloader_paths                     an array of class names and the full server
-     *       paths to those files. Required.
-     * @type string                   $autoloader_folders                   an array of  "full server paths" for any
-     *       folders containing classes that might be invoked by the addon
-     * @type string                   $dms_paths                            an array of full server paths to folders
-     *       that contain data migration scripts. Required.
-     * @type string                   $module_paths                         an array of full server paths to any
-     *       EED_Modules used by the addon
-     * @type string                   $shortcode_paths                      an array of full server paths to folders
-     *       that contain EES_Shortcodes
-     * @type string                   $widget_paths                         an array of full server paths to folders
-     *       that contain WP_Widgets
-     * @type string                   $pue_options
-     * @type array                    $capabilities                         an array indexed by role name
-     *                                                                      (i.e administrator,author ) and the values
-     *                                                                      are an array of caps to add to the role.
-     *                                                                      'administrator' => array(
-     *                                                                      'read_addon', 'edit_addon', etc.
-     *                                                                      ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                      an array of EE_Meta_Capability_Map object
-     *       for any addons that need to register any special meta mapped capabilities.  Should be indexed where the
-     *       key is the EE_Meta_Capability_Map class name and the values are the arguments sent to the class.
-     * @type array                    $model_paths                          array of folders containing DB models
-     * @see      EE_Register_Model
-     * @type array                    $class_paths                          array of folders containing DB classes
-     * @see      EE_Register_Model
-     * @type array                    $model_extension_paths                array of folders containing DB model
-     *       extensions
-     * @see      EE_Register_Model_Extension
-     * @type array                    $class_extension_paths                array of folders containing DB class
-     *       extensions
-     * @see      EE_Register_Model_Extension
-     * @type array message_types {
-     *                                                                      An array of message types with the key as
-     *                                                                      the message type name and the values as
-     *                                                                      below:
-     * @type string                   $mtfilename                           The filename of the message type being
-     *       registered. This will be the main EE_{Messagetype_Name}_message_type class.
-     *                                                                      (eg.
-     *                                                                      EE_Declined_Registration_message_type.class.php)
-     *                                                                      Required.
-     * @type array                    $autoloadpaths                        An array of paths to add to the messages
-     *                                                                      autoloader for the new message type.
-     *                                                                      Required.
-     * @type array                    $messengers_to_activate_with          An array of messengers that this message
-     *                                                                      type should activate with. Each value in
-     *                                                                      the
-     *                                                                      array
-     *                                                                      should match the name property of a
-     *                                                                      EE_messenger. Optional.
-     * @type array                    $messengers_to_validate_with          An array of messengers that this message
-     *                                                                      type should validate with. Each value in
-     *                                                                      the
-     *                                                                      array
-     *                                                                      should match the name property of an
-     *                                                                      EE_messenger.
-     *                                                                      Optional.
-     *                                                                      }
-     * @type array                    $custom_post_types
-     * @type array                    $custom_taxonomies
-     * @type array                    $payment_method_paths                 each element is the folder containing the
-     *                                                                      EE_PMT_Base child class
-     *                                                                      (eg,
-     *                                                                      '/wp-content/plugins/my_plugin/Payomatic/'
-     *                                                                      which contains the files
-     *                                                                      EE_PMT_Payomatic.pm.php)
-     * @type array                    $default_terms
-     * @type array                    $namespace                            {
-     *                                                                      An array with two items for registering the
-     *                                                                      addon's namespace. (If, for some reason,
-     *                                                                      you
-     *                                                                      require additional namespaces, use
-     *                                                                      EventEspresso\core\Psr4Autoloader::addNamespace()
-     *                                                                      directly)
-     * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
-     * @type string                   $FQNS                                 the namespace prefix
-     * @type string                   $DIR                                  a base directory for class files in the
-     *       namespace.
-     *                                                                      }
-     *                                                                      }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($addon_name = '', $setup_args = array())
-    {
-        // required fields MUST be present, so let's make sure they are.
-        \EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        //setup $_settings array from incoming values.
-        $addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return;
-        }
-        // register namespaces
-        \EE_Register_Addon::_setup_namespaces($addon_settings);
-        // check if this is an activation request
-        if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
-            // dont bother setting up the rest of the addon atm
-            return;
-        }
-        // we need cars
-        \EE_Register_Addon::_setup_autoloaders($addon_name);
-        // register new models and extensions
-        \EE_Register_Addon::_register_models_and_extensions($addon_name);
-        // setup DMS
-        \EE_Register_Addon::_register_data_migration_scripts($addon_name);
-        // if config_class is present let's register config.
-        \EE_Register_Addon::_register_config($addon_name);
-        // register admin pages
-        \EE_Register_Addon::_register_admin_pages($addon_name);
-        // add to list of modules to be registered
-        \EE_Register_Addon::_register_modules($addon_name);
-        // add to list of shortcodes to be registered
-        \EE_Register_Addon::_register_shortcodes($addon_name);
-        // add to list of widgets to be registered
-        \EE_Register_Addon::_register_widgets($addon_name);
-        // register capability related stuff.
-        \EE_Register_Addon::_register_capabilities($addon_name);
-        // any message type to register?
-        \EE_Register_Addon::_register_message_types($addon_name);
-        // any custom post type/ custom capabilities or default terms to register
-        \EE_Register_Addon::_register_custom_post_types($addon_name);
-        // and any payment methods
-        \EE_Register_Addon::_register_payment_methods($addon_name);
-        // load and instantiate main addon class
-        $addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
-        $addon->after_registration();
-    }
+	/**
+	 *    Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @since    4.3.0
+	 * @param string                  $addon_name                           the EE_Addon's name. Required.
+	 * @param  array                  $setup_args                           {                                    An
+	 *                                                                      array of arguments provided for registering
+	 *                                                                      the message type.
+	 * @type  string                  $class_name                           the addon's main file name.
+	 *                                                                      If left blank, generated from the addon
+	 *                                                                      name, changes something like "calendar" to
+	 *                                                                      "EE_Calendar"
+	 * @type string                   $min_core_version                     the minimum version of EE Core that the
+	 *       addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                              the "software" version for the addon. eg
+	 *       "1.0.0.p" for a first stable release, or "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                       the full server path to the main file
+	 *       loaded
+	 *                                                                      directly by WP
+	 * @type string                   $admin_path                           full server path to the folder where the
+	 *       addon\'s admin files reside
+	 * @type string                   $admin_callback                       a method to be called when the EE Admin is
+	 *       first invoked, can be used for hooking into any admin page
+	 * @type string                   $config_section                       the section name for this addon's
+	 *       configuration settings section (defaults to "addons")
+	 * @type string                   $config_class                         the class name for this addon's
+	 *       configuration settings object
+	 * @type string                   $config_name                          the class name for this addon's
+	 *       configuration settings object
+	 * @type string                   $autoloader_paths                     an array of class names and the full server
+	 *       paths to those files. Required.
+	 * @type string                   $autoloader_folders                   an array of  "full server paths" for any
+	 *       folders containing classes that might be invoked by the addon
+	 * @type string                   $dms_paths                            an array of full server paths to folders
+	 *       that contain data migration scripts. Required.
+	 * @type string                   $module_paths                         an array of full server paths to any
+	 *       EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                      an array of full server paths to folders
+	 *       that contain EES_Shortcodes
+	 * @type string                   $widget_paths                         an array of full server paths to folders
+	 *       that contain WP_Widgets
+	 * @type string                   $pue_options
+	 * @type array                    $capabilities                         an array indexed by role name
+	 *                                                                      (i.e administrator,author ) and the values
+	 *                                                                      are an array of caps to add to the role.
+	 *                                                                      'administrator' => array(
+	 *                                                                      'read_addon', 'edit_addon', etc.
+	 *                                                                      ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                      an array of EE_Meta_Capability_Map object
+	 *       for any addons that need to register any special meta mapped capabilities.  Should be indexed where the
+	 *       key is the EE_Meta_Capability_Map class name and the values are the arguments sent to the class.
+	 * @type array                    $model_paths                          array of folders containing DB models
+	 * @see      EE_Register_Model
+	 * @type array                    $class_paths                          array of folders containing DB classes
+	 * @see      EE_Register_Model
+	 * @type array                    $model_extension_paths                array of folders containing DB model
+	 *       extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array                    $class_extension_paths                array of folders containing DB class
+	 *       extensions
+	 * @see      EE_Register_Model_Extension
+	 * @type array message_types {
+	 *                                                                      An array of message types with the key as
+	 *                                                                      the message type name and the values as
+	 *                                                                      below:
+	 * @type string                   $mtfilename                           The filename of the message type being
+	 *       registered. This will be the main EE_{Messagetype_Name}_message_type class.
+	 *                                                                      (eg.
+	 *                                                                      EE_Declined_Registration_message_type.class.php)
+	 *                                                                      Required.
+	 * @type array                    $autoloadpaths                        An array of paths to add to the messages
+	 *                                                                      autoloader for the new message type.
+	 *                                                                      Required.
+	 * @type array                    $messengers_to_activate_with          An array of messengers that this message
+	 *                                                                      type should activate with. Each value in
+	 *                                                                      the
+	 *                                                                      array
+	 *                                                                      should match the name property of a
+	 *                                                                      EE_messenger. Optional.
+	 * @type array                    $messengers_to_validate_with          An array of messengers that this message
+	 *                                                                      type should validate with. Each value in
+	 *                                                                      the
+	 *                                                                      array
+	 *                                                                      should match the name property of an
+	 *                                                                      EE_messenger.
+	 *                                                                      Optional.
+	 *                                                                      }
+	 * @type array                    $custom_post_types
+	 * @type array                    $custom_taxonomies
+	 * @type array                    $payment_method_paths                 each element is the folder containing the
+	 *                                                                      EE_PMT_Base child class
+	 *                                                                      (eg,
+	 *                                                                      '/wp-content/plugins/my_plugin/Payomatic/'
+	 *                                                                      which contains the files
+	 *                                                                      EE_PMT_Payomatic.pm.php)
+	 * @type array                    $default_terms
+	 * @type array                    $namespace                            {
+	 *                                                                      An array with two items for registering the
+	 *                                                                      addon's namespace. (If, for some reason,
+	 *                                                                      you
+	 *                                                                      require additional namespaces, use
+	 *                                                                      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 *                                                                      directly)
+	 * @see      EventEspresso\core\Psr4Autoloader::addNamespace()
+	 * @type string                   $FQNS                                 the namespace prefix
+	 * @type string                   $DIR                                  a base directory for class files in the
+	 *       namespace.
+	 *                                                                      }
+	 *                                                                      }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($addon_name = '', $setup_args = array())
+	{
+		// required fields MUST be present, so let's make sure they are.
+		\EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = \EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		//setup $_settings array from incoming values.
+		$addon_settings = \EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		\EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return;
+		}
+		// register namespaces
+		\EE_Register_Addon::_setup_namespaces($addon_settings);
+		// check if this is an activation request
+		if (\EE_Register_Addon::_addon_activation($addon_name, $addon_settings)) {
+			// dont bother setting up the rest of the addon atm
+			return;
+		}
+		// we need cars
+		\EE_Register_Addon::_setup_autoloaders($addon_name);
+		// register new models and extensions
+		\EE_Register_Addon::_register_models_and_extensions($addon_name);
+		// setup DMS
+		\EE_Register_Addon::_register_data_migration_scripts($addon_name);
+		// if config_class is present let's register config.
+		\EE_Register_Addon::_register_config($addon_name);
+		// register admin pages
+		\EE_Register_Addon::_register_admin_pages($addon_name);
+		// add to list of modules to be registered
+		\EE_Register_Addon::_register_modules($addon_name);
+		// add to list of shortcodes to be registered
+		\EE_Register_Addon::_register_shortcodes($addon_name);
+		// add to list of widgets to be registered
+		\EE_Register_Addon::_register_widgets($addon_name);
+		// register capability related stuff.
+		\EE_Register_Addon::_register_capabilities($addon_name);
+		// any message type to register?
+		\EE_Register_Addon::_register_message_types($addon_name);
+		// any custom post type/ custom capabilities or default terms to register
+		\EE_Register_Addon::_register_custom_post_types($addon_name);
+		// and any payment methods
+		\EE_Register_Addon::_register_payment_methods($addon_name);
+		// load and instantiate main addon class
+		$addon = \EE_Register_Addon::_load_and_init_addon_class($addon_name);
+		$addon->after_registration();
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _verify_parameters($addon_name, array $setup_args)
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args)) {
-            throw new EE_Error(
-                __(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _verify_parameters($addon_name, array $setup_args)
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args)) {
+			throw new EE_Error(
+				__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name($addon_name, array $setup_args)
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
-            //capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name($addon_name, array $setup_args)
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(array('-', '_'), ' ', trim($addon_name));
+			//capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
+	}
 
 
-    /**
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return array
-     */
-    private static function _get_addon_settings($class_name, array $setup_args)
-    {
-        //setup $_settings array from incoming values.
-        $addon_settings = array(
-            // generated from the addon name, changes something like "calendar" to "EE_Calendar"
-            'class_name'            => $class_name,
-            // the addon slug for use in URLs, etc
-            'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
-                : '',
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
-            //the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
-                : array(),
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
-                : array(),
-            // array of full server paths to any EE_DMS data migration scripts used by the addon
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
-                : array(),
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
-                : array(),
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
-                : array(),
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
-                : array(),
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
-                : array(),
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
-                : array(),
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
-                : array(),
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
-                : array(),
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
-                : array(),
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
-                : array(),
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
-                : array(),
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
-                : array(),
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
-                : array(),
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
-                : array(),
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
-                : array(),
-            'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
-                : array(),
-            // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
-            // that can be used for adding upgrading/marketing info
-            'plugins_page_row'      => isset($setup_args['plugins_page_row'])
-                ? $setup_args['plugins_page_row']
-                : '',
-            'namespace'             => isset(
-                $setup_args['namespace'],
-                $setup_args['namespace']['FQNS'],
-                $setup_args['namespace']['DIR']
-            )
-                ? (array)$setup_args['namespace']
-                : array(),
-        );
-        // if plugin_action_slug is NOT set, but an admin page path IS set,
-        // then let's just use the plugin_slug since that will be used for linking to the admin page
-        $addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
-                                                && ! empty($addon_settings['admin_path'])
-            ? $addon_settings['plugin_slug']
-            : $addon_settings['plugin_action_slug'];
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
+	/**
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return array
+	 */
+	private static function _get_addon_settings($class_name, array $setup_args)
+	{
+		//setup $_settings array from incoming values.
+		$addon_settings = array(
+			// generated from the addon name, changes something like "calendar" to "EE_Calendar"
+			'class_name'            => $class_name,
+			// the addon slug for use in URLs, etc
+			'plugin_slug'           => isset($setup_args['plugin_slug'])
+				? (string)$setup_args['plugin_slug']
+				: '',
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string)$setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string)$setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string)$setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string)$setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string)$setup_args['main_file_path']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string)$setup_args['admin_path'] : '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string)$setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string)$setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string)$setup_args['config_class'] : '',
+			//the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string)$setup_args['config_name'] : '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array)$setup_args['autoloader_paths']
+				: array(),
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array)$setup_args['autoloader_folders']
+				: array(),
+			// array of full server paths to any EE_DMS data migration scripts used by the addon
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array)$setup_args['dms_paths']
+				: array(),
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array)$setup_args['module_paths']
+				: array(),
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array)$setup_args['shortcode_paths']
+				: array(),
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array)$setup_args['widget_paths']
+				: array(),
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array)$setup_args['pue_options']
+				: array(),
+			'message_types'         => isset($setup_args['message_types'])
+				? (array)$setup_args['message_types']
+				: array(),
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array)$setup_args['capabilities']
+				: array(),
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array)$setup_args['capability_maps']
+				: array(),
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array)$setup_args['model_paths']
+				: array(),
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array)$setup_args['class_paths']
+				: array(),
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array)$setup_args['model_extension_paths']
+				: array(),
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array)$setup_args['class_extension_paths']
+				: array(),
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array)$setup_args['custom_post_types']
+				: array(),
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array)$setup_args['custom_taxonomies']
+				: array(),
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array)$setup_args['payment_method_paths']
+				: array(),
+			'default_terms'         => isset($setup_args['default_terms'])
+				? (array)$setup_args['default_terms']
+				: array(),
+			// if not empty, inserts a new table row after this plugin's row on the WP Plugins page
+			// that can be used for adding upgrading/marketing info
+			'plugins_page_row'      => isset($setup_args['plugins_page_row'])
+				? $setup_args['plugins_page_row']
+				: '',
+			'namespace'             => isset(
+				$setup_args['namespace'],
+				$setup_args['namespace']['FQNS'],
+				$setup_args['namespace']['DIR']
+			)
+				? (array)$setup_args['namespace']
+				: array(),
+		);
+		// if plugin_action_slug is NOT set, but an admin page path IS set,
+		// then let's just use the plugin_slug since that will be used for linking to the admin page
+		$addon_settings['plugin_action_slug'] = empty($addon_settings['plugin_action_slug'])
+												&& ! empty($addon_settings['admin_path'])
+			? $addon_settings['plugin_slug']
+			: $addon_settings['plugin_action_slug'];
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return boolean
-     */
-    private static function _addon_is_compatible($addon_name, array $addon_settings)
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        //check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[$addon_name],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (
-        ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return boolean
+	 */
+	private static function _addon_is_compatible($addon_name, array $addon_settings)
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		//check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[$addon_name],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (
+		! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} else if (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
 
 
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
-    private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
-    {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[$addon_name]['pue_options'] = array(
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
-                    : false,
-            );
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                array('EE_Register_Addon', 'load_pue_update')
-            );
-        }
-    }
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
+	private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
+	{
+		if (! empty($setup_args['pue_options'])) {
+			self::$_settings[$addon_name]['pue_options'] = array(
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string)$setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string)$setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string)$setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string)$setup_args['pue_options']['use_wp_update']
+					: false,
+			);
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				array('EE_Register_Addon', 'load_pue_update')
+			);
+		}
+	}
 
 
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-        isset(
-            $addon_settings['namespace'],
-            $addon_settings['namespace']['FQNS'],
-            $addon_settings['namespace']['DIR']
-        )
-        ) {
-            EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
-                $addon_settings['namespace']['FQNS'],
-                $addon_settings['namespace']['DIR']
-            );
-        }
-    }
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+		isset(
+			$addon_settings['namespace'],
+			$addon_settings['namespace']['FQNS'],
+			$addon_settings['namespace']['DIR']
+		)
+		) {
+			EE_Psr4AutoloaderInit::psr4_loader()->addNamespace(
+				$addon_settings['namespace']['FQNS'],
+				$addon_settings['namespace']['DIR']
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     */
-    private static function _addon_activation($addon_name, array $addon_settings)
-    {
-        // this is an activation request
-        if (did_action('activate_plugin')) {
-            //to find if THIS is the addon that was activated, just check if we have already registered it or not
-            //(as the newly-activated addon wasn't around the first time addons were registered).
-            //Note: the presence of pue_options in the addon registration options will initialize the $_settings
-            //property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[$addon_name])
-                || (isset(self::$_settings[$addon_name])
-                    && ! isset(self::$_settings[$addon_name]['class_name'])
-                )
-            ) {
-                self::$_settings[$addon_name] = $addon_settings;
-                $addon                        = self::_load_and_init_addon_class($addon_name);
-                $addon->set_activation_indicator_option();
-                // dont bother setting up the rest of the addon.
-                // we know it was just activated and the request will end soon
-            }
-            return true;
-        } else {
-            // make sure this was called in the right place!
-            if (
-                ! did_action('AHEE__EE_System__load_espresso_addons')
-                || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-            ) {
-                EE_Error::doing_it_wrong(
-                    __METHOD__,
-                    sprintf(
-                        __(
-                            'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
-                            'event_espresso'
-                        ),
-                        $addon_name
-                    ),
-                    '4.3.0'
-                );
-            }
-            // make sure addon settings are set correctly without overwriting anything existing
-            if (isset(self::$_settings[$addon_name])) {
-                self::$_settings[$addon_name] += $addon_settings;
-            } else {
-                self::$_settings[$addon_name] = $addon_settings;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 */
+	private static function _addon_activation($addon_name, array $addon_settings)
+	{
+		// this is an activation request
+		if (did_action('activate_plugin')) {
+			//to find if THIS is the addon that was activated, just check if we have already registered it or not
+			//(as the newly-activated addon wasn't around the first time addons were registered).
+			//Note: the presence of pue_options in the addon registration options will initialize the $_settings
+			//property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
+			if (! isset(self::$_settings[$addon_name])
+				|| (isset(self::$_settings[$addon_name])
+					&& ! isset(self::$_settings[$addon_name]['class_name'])
+				)
+			) {
+				self::$_settings[$addon_name] = $addon_settings;
+				$addon                        = self::_load_and_init_addon_class($addon_name);
+				$addon->set_activation_indicator_option();
+				// dont bother setting up the rest of the addon.
+				// we know it was just activated and the request will end soon
+			}
+			return true;
+		} else {
+			// make sure this was called in the right place!
+			if (
+				! did_action('AHEE__EE_System__load_espresso_addons')
+				|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+			) {
+				EE_Error::doing_it_wrong(
+					__METHOD__,
+					sprintf(
+						__(
+							'An attempt to register an EE_Addon named "%s" has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register addons.',
+							'event_espresso'
+						),
+						$addon_name
+					),
+					'4.3.0'
+				);
+			}
+			// make sure addon settings are set correctly without overwriting anything existing
+			if (isset(self::$_settings[$addon_name])) {
+				self::$_settings[$addon_name] += $addon_settings;
+			} else {
+				self::$_settings[$addon_name] = $addon_settings;
+			}
+		}
+		return false;
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _setup_autoloaders($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
-            // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
-        }
-        // setup autoloaders for folders
-        if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
-            }
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _setup_autoloaders($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
+			// setup autoloader for single file
+			EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
+		}
+		// setup autoloaders for folders
+		if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+			foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
+			}
+		}
+	}
 
 
-    /**
-     * register new models and extensions
-     *
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_models_and_extensions($addon_name)
-    {
-        // register new models
-        if (
-            ! empty(self::$_settings[$addon_name]['model_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_paths'])
-        ) {
-            EE_Register_Model::register(
-                $addon_name,
-                array(
-                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
-                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
-                )
-            );
-        }
-        // register model extensions
-        if (
-            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
-            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-        ) {
-            EE_Register_Model_Extensions::register(
-                $addon_name,
-                array(
-                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
-                )
-            );
-        }
-    }
+	/**
+	 * register new models and extensions
+	 *
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_models_and_extensions($addon_name)
+	{
+		// register new models
+		if (
+			! empty(self::$_settings[$addon_name]['model_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_paths'])
+		) {
+			EE_Register_Model::register(
+				$addon_name,
+				array(
+					'model_paths' => self::$_settings[$addon_name]['model_paths'],
+					'class_paths' => self::$_settings[$addon_name]['class_paths'],
+				)
+			);
+		}
+		// register model extensions
+		if (
+			! empty(self::$_settings[$addon_name]['model_extension_paths'])
+			|| ! empty(self::$_settings[$addon_name]['class_extension_paths'])
+		) {
+			EE_Register_Model_Extensions::register(
+				$addon_name,
+				array(
+					'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+					'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_data_migration_scripts($addon_name)
-    {
-        // setup DMS
-        if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
-            EE_Register_Data_Migration_Scripts::register(
-                $addon_name,
-                array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_data_migration_scripts($addon_name)
+	{
+		// setup DMS
+		if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+			EE_Register_Data_Migration_Scripts::register(
+				$addon_name,
+				array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_config($addon_name)
-    {
-        // if config_class is present let's register config.
-        if (! empty(self::$_settings[$addon_name]['config_class'])) {
-            EE_Register_Config::register(
-                self::$_settings[$addon_name]['config_class'],
-                array(
-                    'config_section' => self::$_settings[$addon_name]['config_section'],
-                    'config_name'    => self::$_settings[$addon_name]['config_name'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_config($addon_name)
+	{
+		// if config_class is present let's register config.
+		if (! empty(self::$_settings[$addon_name]['config_class'])) {
+			EE_Register_Config::register(
+				self::$_settings[$addon_name]['config_class'],
+				array(
+					'config_section' => self::$_settings[$addon_name]['config_section'],
+					'config_name'    => self::$_settings[$addon_name]['config_name'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_admin_pages($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['admin_path'])) {
-            EE_Register_Admin_Page::register(
-                $addon_name,
-                array('page_path' => self::$_settings[$addon_name]['admin_path'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_admin_pages($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+			EE_Register_Admin_Page::register(
+				$addon_name,
+				array('page_path' => self::$_settings[$addon_name]['admin_path'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_modules($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['module_paths'])) {
-            EE_Register_Module::register(
-                $addon_name,
-                array('module_paths' => self::$_settings[$addon_name]['module_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_modules($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+			EE_Register_Module::register(
+				$addon_name,
+				array('module_paths' => self::$_settings[$addon_name]['module_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_shortcodes($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
-            EE_Register_Shortcode::register(
-                $addon_name,
-                array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_shortcodes($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+			EE_Register_Shortcode::register(
+				$addon_name,
+				array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_widgets($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
-            EE_Register_Widget::register(
-                $addon_name,
-                array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_widgets($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+			EE_Register_Widget::register(
+				$addon_name,
+				array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_capabilities($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['capabilities'])) {
-            EE_Register_Capabilities::register(
-                $addon_name,
-                array(
-                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
-                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_capabilities($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['capabilities'])) {
+			EE_Register_Capabilities::register(
+				$addon_name,
+				array(
+					'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+					'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_message_types($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['message_types'])) {
-            add_action(
-                'EE_Brewing_Regular___messages_caf',
-                array('EE_Register_Addon', 'register_message_types')
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_message_types($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['message_types'])) {
+			add_action(
+				'EE_Brewing_Regular___messages_caf',
+				array('EE_Register_Addon', 'register_message_types')
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_custom_post_types($addon_name)
-    {
-        if (
-            ! empty(self::$_settings[$addon_name]['custom_post_types'])
-            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
-        ) {
-            EE_Register_CPT::register(
-                $addon_name,
-                array(
-                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
-                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_custom_post_types($addon_name)
+	{
+		if (
+			! empty(self::$_settings[$addon_name]['custom_post_types'])
+			|| ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
+		) {
+			EE_Register_CPT::register(
+				$addon_name,
+				array(
+					'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+					'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+					'default_terms' => self::$_settings[$addon_name]['default_terms'],
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     * @return void
-     * @throws \EE_Error
-     */
-    private static function _register_payment_methods($addon_name)
-    {
-        if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
-            EE_Register_Payment_Method::register(
-                $addon_name,
-                array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
-            );
-        }
-    }
+	/**
+	 * @param string $addon_name
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	private static function _register_payment_methods($addon_name)
+	{
+		if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+			EE_Register_Payment_Method::register(
+				$addon_name,
+				array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
+			);
+		}
+	}
 
 
-    /**
-     * Loads and instantiates the EE_Addon class and adds it onto the registry
-     *
-     * @param string $addon_name
-     * @return EE_Addon
-     */
-    private static function _load_and_init_addon_class($addon_name)
-    {
-        $addon = EE_Registry::instance()->load_addon(
-            dirname(self::$_settings[$addon_name]['main_file_path']),
-            self::$_settings[$addon_name]['class_name']
-        );
-        $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
-        $addon->set_version(self::$_settings[$addon_name]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
-        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
-        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
-        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
-        //unfortunately this can't be hooked in upon construction, because we don't have
-        //the plugin mainfile's path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[$addon_name]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                array($addon, self::$_settings[$addon_name]['admin_callback'])
-            );
-        }
-        return $addon;
-    }
+	/**
+	 * Loads and instantiates the EE_Addon class and adds it onto the registry
+	 *
+	 * @param string $addon_name
+	 * @return EE_Addon
+	 */
+	private static function _load_and_init_addon_class($addon_name)
+	{
+		$addon = EE_Registry::instance()->load_addon(
+			dirname(self::$_settings[$addon_name]['main_file_path']),
+			self::$_settings[$addon_name]['class_name']
+		);
+		$addon->set_name($addon_name);
+		$addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+		$addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+		$addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+		$addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+		$addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+		$addon->set_version(self::$_settings[$addon_name]['version']);
+		$addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+		$addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+		$addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+		$addon->set_config_name(self::$_settings[$addon_name]['config_name']);
+		//unfortunately this can't be hooked in upon construction, because we don't have
+		//the plugin mainfile's path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[$addon_name]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				array($addon, self::$_settings[$addon_name]['admin_callback'])
+			);
+		}
+		return $addon;
+	}
 
 
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return    void
-     */
-    public static function load_pue_update()
-    {
-        // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
-        // cycle thru settings
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
-                // initiate the class and start the plugin update engine!
-                new PluginUpdateEngineChecker(
-                // host file URL
-                    'https://eventespresso.com',
-                    // plugin slug(s)
-                    array(
-                        'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
-                    ),
-                    // options
-                    array(
-                        'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
-                        'lang_domain'       => 'event_espresso',
-                        'checkPeriod'       => $settings['pue_options']['checkPeriod'],
-                        'option_key'        => 'site_license_key',
-                        'options_page_slug' => 'event_espresso',
-                        'plugin_basename'   => $settings['pue_options']['plugin_basename'],
-                        // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
-                        'use_wp_update'     => $settings['pue_options']['use_wp_update'],
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return    void
+	 */
+	public static function load_pue_update()
+	{
+		// load PUE client
+		require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+		// cycle thru settings
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['pue_options'])) {
+				// initiate the class and start the plugin update engine!
+				new PluginUpdateEngineChecker(
+				// host file URL
+					'https://eventespresso.com',
+					// plugin slug(s)
+					array(
+						'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
+						'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+					),
+					// options
+					array(
+						'apikey'            => EE_Registry::instance()->NET_CFG->core->site_license_key,
+						'lang_domain'       => 'event_espresso',
+						'checkPeriod'       => $settings['pue_options']['checkPeriod'],
+						'option_key'        => 'site_license_key',
+						'options_page_slug' => 'event_espresso',
+						'plugin_basename'   => $settings['pue_options']['plugin_basename'],
+						// if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
+						'use_wp_update'     => $settings['pue_options']['use_wp_update'],
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
-     *
-     * @since 4.4.0
-     * @return void
-     * @throws \EE_Error
-     */
-    public static function register_message_types()
-    {
-        foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::register($message_type, $message_type_settings);
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for EE_Brewing_Regular__messages_caf hook used to register message types.
+	 *
+	 * @since 4.4.0
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public static function register_message_types()
+	{
+		foreach (self::$_settings as $addon_name => $settings) {
+			if (! empty($settings['message_types'])) {
+				foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::register($message_type, $message_type_settings);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters an addon that was previously registered with a specific addon_name.
-     *
-     * @since    4.3.0
-     * @param string $addon_name the name for the addon that was previously registered
-     * @throws EE_Error
-     * @return void
-     */
-    public static function deregister($addon_name = null)
-    {
-        if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) {
-            do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-            $class_name = self::$_settings[$addon_name]['class_name'];
-            if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
-                // setup DMS
-                EE_Register_Data_Migration_Scripts::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['admin_path'])) {
-                // register admin page
-                EE_Register_Admin_Page::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['module_paths'])) {
-                // add to list of modules to be registered
-                EE_Register_Module::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
-                // add to list of shortcodes to be registered
-                EE_Register_Shortcode::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['config_class'])) {
-                // if config_class present let's register config.
-                EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
-            }
-            if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
-                // add to list of widgets to be registered
-                EE_Register_Widget::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['model_paths'])
-                ||
-                ! empty(self::$_settings[$addon_name]['class_paths'])
-            ) {
-                // add to list of shortcodes to be registered
-                EE_Register_Model::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
-                ||
-                ! empty(self::$_settings[$addon_name]['class_extension_paths'])
-            ) {
-                // add to list of shortcodes to be registered
-                EE_Register_Model_Extensions::deregister($addon_name);
-            }
-            if (! empty(self::$_settings[$addon_name]['message_types'])) {
-                foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
-                    EE_Register_Message_Type::deregister($message_type);
-                }
-            }
-            //deregister capabilities for addon
-            if (
-                ! empty(self::$_settings[$addon_name]['capabilities'])
-                || ! empty(self::$_settings[$addon_name]['capability_maps'])
-            ) {
-                EE_Register_Capabilities::deregister($addon_name);
-            }
-            //deregister custom_post_types for addon
-            if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
-                EE_Register_CPT::deregister($addon_name);
-            }
-            remove_action(
-                'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
-                array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
-            );
-            remove_action(
-                'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-                array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required')
-            );
-            unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]);
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
+	/**
+	 * This deregisters an addon that was previously registered with a specific addon_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $addon_name the name for the addon that was previously registered
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function deregister($addon_name = null)
+	{
+		if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) {
+			do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
+			$class_name = self::$_settings[$addon_name]['class_name'];
+			if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+				// setup DMS
+				EE_Register_Data_Migration_Scripts::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+				// register admin page
+				EE_Register_Admin_Page::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+				// add to list of modules to be registered
+				EE_Register_Module::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+				// add to list of shortcodes to be registered
+				EE_Register_Shortcode::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['config_class'])) {
+				// if config_class present let's register config.
+				EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
+			}
+			if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+				// add to list of widgets to be registered
+				EE_Register_Widget::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['model_paths'])
+				||
+				! empty(self::$_settings[$addon_name]['class_paths'])
+			) {
+				// add to list of shortcodes to be registered
+				EE_Register_Model::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
+				||
+				! empty(self::$_settings[$addon_name]['class_extension_paths'])
+			) {
+				// add to list of shortcodes to be registered
+				EE_Register_Model_Extensions::deregister($addon_name);
+			}
+			if (! empty(self::$_settings[$addon_name]['message_types'])) {
+				foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
+					EE_Register_Message_Type::deregister($message_type);
+				}
+			}
+			//deregister capabilities for addon
+			if (
+				! empty(self::$_settings[$addon_name]['capabilities'])
+				|| ! empty(self::$_settings[$addon_name]['capability_maps'])
+			) {
+				EE_Register_Capabilities::deregister($addon_name);
+			}
+			//deregister custom_post_types for addon
+			if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+				EE_Register_CPT::deregister($addon_name);
+			}
+			remove_action(
+				'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
+				array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
+			);
+			remove_action(
+				'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+				array(EE_Registry::instance()->addons->{$class_name}, 'initialize_db_if_no_migrations_required')
+			);
+			unset(EE_Registry::instance()->addons->{$class_name}, self::$_settings[$addon_name]);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
 
 
 }

Spacing +75 added lines, -75 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -66,15 +66,15 @@ 
         // offsets:    0 . 1 . 2 . 3 . 4
         $version_parts = explode('.', $min_core_version);
         //check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
+        if ( ! isset($version_parts[2])) {
             $version_parts[2] = '0';
         }
         //if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
         //soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
+        if ( ! isset($version_parts[3])) {
             $version_parts[3] = 'dev';
         }
-        if (! isset($version_parts[4])) {
+        if ( ! isset($version_parts[4])) {
             $version_parts[4] = '000';
         }
         return implode('.', $version_parts);
@@ -231,7 +231,7 @@ 
         // setup PUE
         \EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
         // does this addon work with this version of core or WordPress ?
-        if (! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! \EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
         }
         // register namespaces
@@ -288,7 +288,7 @@ 
                 )
             );
         }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -329,7 +329,7 @@ 
         } else {
             $class_name = $setup_args['class_name'];
         }
-        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_' . $class_name;
+        return strpos($class_name, 'EE_') === 0 ? $class_name : 'EE_'.$class_name;
     }
 
 
@@ -346,105 +346,105 @@ 
             'class_name'            => $class_name,
             // the addon slug for use in URLs, etc
             'plugin_slug'           => isset($setup_args['plugin_slug'])
-                ? (string)$setup_args['plugin_slug']
+                ? (string) $setup_args['plugin_slug']
                 : '',
             // page slug to be used when generating the "Settings" link on the WP plugin page
             'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string)$setup_args['plugin_action_slug']
+                ? (string) $setup_args['plugin_action_slug']
                 : '',
             // the "software" version for the addon
             'version'               => isset($setup_args['version'])
-                ? (string)$setup_args['version']
+                ? (string) $setup_args['version']
                 : '',
             // the minimum version of EE Core that the addon will work with
             'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string)$setup_args['min_core_version']
+                ? (string) $setup_args['min_core_version']
                 : '',
             // the minimum version of WordPress that the addon will work with
             'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string)$setup_args['min_wp_version']
+                ? (string) $setup_args['min_wp_version']
                 : EE_MIN_WP_VER_REQUIRED,
             // full server path to main file (file loaded directly by WP)
             'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string)$setup_args['main_file_path']
+                ? (string) $setup_args['main_file_path']
                 : '',
             // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
             'admin_path'            => isset($setup_args['admin_path'])
-                ? (string)$setup_args['admin_path'] : '',
+                ? (string) $setup_args['admin_path'] : '',
             // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
             'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string)$setup_args['admin_callback']
+                ? (string) $setup_args['admin_callback']
                 : '',
             // the section name for this addon's configuration settings section (defaults to "addons")
             'config_section'        => isset($setup_args['config_section'])
-                ? (string)$setup_args['config_section']
+                ? (string) $setup_args['config_section']
                 : 'addons',
             // the class name for this addon's configuration settings object
             'config_class'          => isset($setup_args['config_class'])
-                ? (string)$setup_args['config_class'] : '',
+                ? (string) $setup_args['config_class'] : '',
             //the name given to the config for this addons' configuration settings object (optional)
             'config_name'           => isset($setup_args['config_name'])
-                ? (string)$setup_args['config_name'] : '',
+                ? (string) $setup_args['config_name'] : '',
             // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
             'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array)$setup_args['autoloader_paths']
+                ? (array) $setup_args['autoloader_paths']
                 : array(),
             // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
             'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array)$setup_args['autoloader_folders']
+                ? (array) $setup_args['autoloader_folders']
                 : array(),
             // array of full server paths to any EE_DMS data migration scripts used by the addon
             'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array)$setup_args['dms_paths']
+                ? (array) $setup_args['dms_paths']
                 : array(),
             // array of full server paths to any EED_Modules used by the addon
             'module_paths'          => isset($setup_args['module_paths'])
-                ? (array)$setup_args['module_paths']
+                ? (array) $setup_args['module_paths']
                 : array(),
             // array of full server paths to any EES_Shortcodes used by the addon
             'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array)$setup_args['shortcode_paths']
+                ? (array) $setup_args['shortcode_paths']
                 : array(),
             // array of full server paths to any WP_Widgets used by the addon
             'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array)$setup_args['widget_paths']
+                ? (array) $setup_args['widget_paths']
                 : array(),
             // array of PUE options used by the addon
             'pue_options'           => isset($setup_args['pue_options'])
-                ? (array)$setup_args['pue_options']
+                ? (array) $setup_args['pue_options']
                 : array(),
             'message_types'         => isset($setup_args['message_types'])
-                ? (array)$setup_args['message_types']
+                ? (array) $setup_args['message_types']
                 : array(),
             'capabilities'          => isset($setup_args['capabilities'])
-                ? (array)$setup_args['capabilities']
+                ? (array) $setup_args['capabilities']
                 : array(),
             'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array)$setup_args['capability_maps']
+                ? (array) $setup_args['capability_maps']
                 : array(),
             'model_paths'           => isset($setup_args['model_paths'])
-                ? (array)$setup_args['model_paths']
+                ? (array) $setup_args['model_paths']
                 : array(),
             'class_paths'           => isset($setup_args['class_paths'])
-                ? (array)$setup_args['class_paths']
+                ? (array) $setup_args['class_paths']
                 : array(),
             'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array)$setup_args['model_extension_paths']
+                ? (array) $setup_args['model_extension_paths']
                 : array(),
             'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array)$setup_args['class_extension_paths']
+                ? (array) $setup_args['class_extension_paths']
                 : array(),
             'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array)$setup_args['custom_post_types']
+                ? (array) $setup_args['custom_post_types']
                 : array(),
             'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array)$setup_args['custom_taxonomies']
+                ? (array) $setup_args['custom_taxonomies']
                 : array(),
             'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array)$setup_args['payment_method_paths']
+                ? (array) $setup_args['payment_method_paths']
                 : array(),
             'default_terms'         => isset($setup_args['default_terms'])
-                ? (array)$setup_args['default_terms']
+                ? (array) $setup_args['default_terms']
                 : array(),
             // if not empty, inserts a new table row after this plugin's row on the WP Plugins page
             // that can be used for adding upgrading/marketing info
@@ -456,7 +456,7 @@ 
                 $setup_args['namespace']['FQNS'],
                 $setup_args['namespace']['DIR']
             )
-                ? (array)$setup_args['namespace']
+                ? (array) $setup_args['namespace']
                 : array(),
         );
         // if plugin_action_slug is NOT set, but an admin page path IS set,
@@ -526,7 +526,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             unset($_GET['activate'], $_REQUEST['activate']);
@@ -554,19 +554,19 @@ 
      */
     private static function _parse_pue_options($addon_name, $class_name, array $setup_args)
     {
-        if (! empty($setup_args['pue_options'])) {
+        if ( ! empty($setup_args['pue_options'])) {
             self::$_settings[$addon_name]['pue_options'] = array(
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string)$setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string)$setup_args['pue_options']['plugin_basename']
+                    ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
                 'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string)$setup_args['pue_options']['checkPeriod']
+                    ? (string) $setup_args['pue_options']['checkPeriod']
                     : '24',
                 'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string)$setup_args['pue_options']['use_wp_update']
+                    ? (string) $setup_args['pue_options']['use_wp_update']
                     : false,
             );
             add_action(
@@ -614,7 +614,7 @@ 
             //(as the newly-activated addon wasn't around the first time addons were registered).
             //Note: the presence of pue_options in the addon registration options will initialize the $_settings
             //property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
-            if (! isset(self::$_settings[$addon_name])
+            if ( ! isset(self::$_settings[$addon_name])
                 || (isset(self::$_settings[$addon_name])
                     && ! isset(self::$_settings[$addon_name]['class_name'])
                 )
@@ -662,13 +662,13 @@ 
      */
     private static function _setup_autoloaders($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
             // setup autoloader for single file
             EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
         }
         // setup autoloaders for folders
-        if (! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
-            foreach ((array)self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -721,7 +721,7 @@ 
     private static function _register_data_migration_scripts($addon_name)
     {
         // setup DMS
-        if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
                 $addon_name,
                 array('dms_paths' => self::$_settings[$addon_name]['dms_paths'])
@@ -738,7 +738,7 @@ 
     private static function _register_config($addon_name)
     {
         // if config_class is present let's register config.
-        if (! empty(self::$_settings[$addon_name]['config_class'])) {
+        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
                 self::$_settings[$addon_name]['config_class'],
                 array(
@@ -757,7 +757,7 @@ 
      */
     private static function _register_admin_pages($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
                 array('page_path' => self::$_settings[$addon_name]['admin_path'])
@@ -773,7 +773,7 @@ 
      */
     private static function _register_modules($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
                 array('module_paths' => self::$_settings[$addon_name]['module_paths'])
@@ -789,7 +789,7 @@ 
      */
     private static function _register_shortcodes($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
             EE_Register_Shortcode::register(
                 $addon_name,
                 array('shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'])
@@ -805,7 +805,7 @@ 
      */
     private static function _register_widgets($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
                 array('widget_paths' => self::$_settings[$addon_name]['widget_paths'])
@@ -821,7 +821,7 @@ 
      */
     private static function _register_capabilities($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['capabilities'])) {
+        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
                 array(
@@ -840,7 +840,7 @@ 
      */
     private static function _register_message_types($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['message_types'])) {
+        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
                 array('EE_Register_Addon', 'register_message_types')
@@ -879,7 +879,7 @@ 
      */
     private static function _register_payment_methods($addon_name)
     {
-        if (! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
                 array('payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths'])
@@ -915,7 +915,7 @@ 
         //the plugin mainfile's path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), array($addon, 'deactivation'));
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[$addon_name]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
                 array($addon, self::$_settings[$addon_name]['admin_callback'])
@@ -933,10 +933,10 @@ 
     public static function load_pue_update()
     {
         // load PUE client
-        require_once EE_THIRD_PARTY . 'pue' . DS . 'pue-client.php';
+        require_once EE_THIRD_PARTY.'pue'.DS.'pue-client.php';
         // cycle thru settings
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
+            if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
                 new PluginUpdateEngineChecker(
                 // host file URL
@@ -944,7 +944,7 @@ 
                     // plugin slug(s)
                     array(
                         'premium'    => array('p' => $settings['pue_options']['pue_plugin_slug']),
-                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'),
+                        'prerelease' => array('beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'),
                     ),
                     // options
                     array(
@@ -973,8 +973,8 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $addon_name => $settings) {
-            if (! empty($settings['message_types'])) {
-                foreach ((array)$settings['message_types'] as $message_type => $message_type_settings) {
+            if ( ! empty($settings['message_types'])) {
+                foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
             }
@@ -995,46 +995,46 @@ 
         if (isset(self::$_settings[$addon_name], self::$_settings[$addon_name]['class_name'])) {
             do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
             $class_name = self::$_settings[$addon_name]['class_name'];
-            if (! empty(self::$_settings[$addon_name]['dms_paths'])) {
+            if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
                 // setup DMS
                 EE_Register_Data_Migration_Scripts::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['admin_path'])) {
+            if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
                 // register admin page
                 EE_Register_Admin_Page::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['module_paths'])) {
+            if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
                 // add to list of modules to be registered
                 EE_Register_Module::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
+            if ( ! empty(self::$_settings[$addon_name]['shortcode_paths'])) {
                 // add to list of shortcodes to be registered
                 EE_Register_Shortcode::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['config_class'])) {
+            if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
                 // if config_class present let's register config.
                 EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
             }
-            if (! empty(self::$_settings[$addon_name]['widget_paths'])) {
+            if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
                 // add to list of widgets to be registered
                 EE_Register_Widget::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['model_paths'])
+            if ( ! empty(self::$_settings[$addon_name]['model_paths'])
                 ||
                 ! empty(self::$_settings[$addon_name]['class_paths'])
             ) {
                 // add to list of shortcodes to be registered
                 EE_Register_Model::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['model_extension_paths'])
+            if ( ! empty(self::$_settings[$addon_name]['model_extension_paths'])
                 ||
                 ! empty(self::$_settings[$addon_name]['class_extension_paths'])
             ) {
                 // add to list of shortcodes to be registered
                 EE_Register_Model_Extensions::deregister($addon_name);
             }
-            if (! empty(self::$_settings[$addon_name]['message_types'])) {
-                foreach ((array)self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
+            if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+                foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::deregister($message_type);
                 }
             }
@@ -1046,11 +1046,11 @@ 
                 EE_Register_Capabilities::deregister($addon_name);
             }
             //deregister custom_post_types for addon
-            if (! empty(self::$_settings[$addon_name]['custom_post_types'])) {
+            if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
                 EE_Register_CPT::deregister($addon_name);
             }
             remove_action(
-                'deactivate_' . EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
+                'deactivate_'.EE_Registry::instance()->addons->{$class_name}->get_main_plugin_file_basename(),
                 array(EE_Registry::instance()->addons->{$class_name}, 'deactivation')
             );
             remove_action(

core/libraries/plugin_api/EE_Register_Message_Type.lib.php

Indentation +432 added lines, -432 removed lines

@@ -7,7 +7,7 @@ 
  * @since           4.3.0
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -22,461 +22,461 @@ 
 {
 
 
-    /**
-     * Holds values for registered message types
-     *
-     * @var array
-     */
-    protected static $_ee_message_type_registry = array();
+	/**
+	 * Holds values for registered message types
+	 *
+	 * @var array
+	 */
+	protected static $_ee_message_type_registry = array();
 
 
-    /**
-     * Method for registering new message types in the EE_messages system.
-     * Note:  All message types must have the following files in order to work:
-     * Template files for default templates getting setup.
-     * See /core/libraries/messages/defaults/default/ for examples
-     * (note that template files match a specific naming schema).
-     * These templates will need to be registered with the default template pack.
-     * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
-     *      for examples.  Note for any new message types, there will need to be a validator for each
-     *      messenger combo this message type can activate with.
-     * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
-     *      message type and its properties.
-     *
-     * @since    4.3.0
-     * @param string $mt_name       Whatever is defined for the $name property of
-     *                              the message type you are registering (eg.
-     *                              declined_registration). Required.
-     * @param  array $setup_args    An array of arguments provided for registering the message type.
-     *                              @see inline docs in the register method for what can be passed in as arguments.
-     * @throws \EE_Error
-     *                              }
-     */
-    public static function register($mt_name = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if (
-            ! isset($mt_name)
-            || ! is_array($setup_args)
-            || empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
-        ) {
-            throw new EE_Error(
-                __('In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
-                    'event_espresso')
-            );
-        }
+	/**
+	 * Method for registering new message types in the EE_messages system.
+	 * Note:  All message types must have the following files in order to work:
+	 * Template files for default templates getting setup.
+	 * See /core/libraries/messages/defaults/default/ for examples
+	 * (note that template files match a specific naming schema).
+	 * These templates will need to be registered with the default template pack.
+	 * - EE_Messages_Validator extended class(es).  See /core/libraries/messages/validators/email/
+	 *      for examples.  Note for any new message types, there will need to be a validator for each
+	 *      messenger combo this message type can activate with.
+	 * - And of course the main EE_{Message_Type_Name}_message_type class that defines the new
+	 *      message type and its properties.
+	 *
+	 * @since    4.3.0
+	 * @param string $mt_name       Whatever is defined for the $name property of
+	 *                              the message type you are registering (eg.
+	 *                              declined_registration). Required.
+	 * @param  array $setup_args    An array of arguments provided for registering the message type.
+	 *                              @see inline docs in the register method for what can be passed in as arguments.
+	 * @throws \EE_Error
+	 *                              }
+	 */
+	public static function register($mt_name = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if (
+			! isset($mt_name)
+			|| ! is_array($setup_args)
+			|| empty($setup_args['mtfilename']) || empty($setup_args['autoloadpaths'])
+		) {
+			throw new EE_Error(
+				__('In order to register a message type with EE_Register_Message_Type::register, you must include a unique name for the message type, plus an array containing the following keys: "mtfilename", "autoloadpaths"',
+					'event_espresso')
+			);
+		}
 
-        //make sure we don't register twice
-        if (isset(self::$_ee_message_type_registry[$mt_name])) {
-            return;
-        }
+		//make sure we don't register twice
+		if (isset(self::$_ee_message_type_registry[$mt_name])) {
+			return;
+		}
 
-        //make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __('A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
-                        'event_espresso'),
-                    $mt_name
-                ),
-                '4.3.0'
-            );
-        }
-        //setup $__ee_message_type_registry array from incoming values.
-        self::$_ee_message_type_registry[$mt_name] = array(
-            /**
-             * The file name for the message type being registered.
-             * Required.
-             * @type string
-             */
-            'mtfilename'                  => (string)$setup_args['mtfilename'],
-            /**
-             * Autoload paths for classes used by the message type.
-             * Required.
-             * @type array
-             */
-            'autoloadpaths'               => (array)$setup_args['autoloadpaths'],
-            /**
-             * Messengers that the message type should be able to activate with.
-             * Use messenger slugs.
-             * @type array
-             */
-            'messengers_to_activate_with' => ! empty($setup_args['messengers_to_activate_with'])
-                ? (array)$setup_args['messengers_to_activate_with']
-                : array(),
-            /**
-             * Messengers that the message type should validate with.
-             * Use messenger slugs.
-             * @type array
-             */
-            'messengers_to_validate_with' => ! empty($setup_args['messengers_to_validate_with'])
-                ? (array)$setup_args['messengers_to_validate_with']
-                : array(),
-            /**
-             * Whether to force activate this message type the first time it is registered.
-             * @type bool   False means its not activated by default and left up to the end user to activate.
-             */
-            'force_activation'            => ! empty($setup_args['force_activation'])
-                ? (bool)$setup_args['force_activation']
-                : false,
-            /**
-             * What messengers this message type supports the default template pack for.
-             * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
-             * then it is expected that the message type being registered is doing its own custom default template
-             * pack/variation registration.
-             *
-             * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
-             * $setup_arguments array as well:
-             * - 'base_path_for_default_templates'
-             *
-             * @type array   Expect an array of messengers this supports default template packs for.
-             */
-            'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
-                ? (array)$setup_args['messengers_supporting_default_template_pack_with']
-                : array(),
-            /**
-             * The base path where the default templates for this message type can be found.
-             * @type string
-             */
-            'base_path_for_default_templates' => isset($setup_args['base_path_for_default_templates'])
-                ? $setup_args['base_path_for_default_templates']
-                : '',
-            /**
-             * The base path where the default variations for this message type can be found.
-             * @type string
-             */
-            'base_path_for_default_variation' => isset($setup_args['base_path_for_default_variation'])
-                ? $setup_args['base_path_for_default_variation']
-                : '',
-            /**
-             * The base url for the default variations for this message type.
-             * @type string
-             */
-            'base_url_for_default_variation' => isset($setup_args['base_url_for_default_variation'])
-                ? $setup_args['base_url_for_default_variation']
-                : ''
-        );
-        //add filters but only if they haven't already been set (these filters only need to be registered ONCE because
-        //the callback handles all registered message types.
-        if ( false === has_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
-        )) {
-            add_filter(
-                'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-                array('EE_Register_Message_Type', 'register_msgs_autoload_paths'),
-                10
-            );
-            add_filter(
-                'FHEE__EE_messages__get_installed__messagetype_files',
-                array('EE_Register_Message_Type', 'register_messagetype_files'),
-                10,
-                1
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_default_message_types__default_types',
-                array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'),
-                10,
-                2
-            );
-            add_filter(
-                'FHEE__EE_messenger__get_valid_message_types__valid_types',
-                array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'),
-                10,
-                2
-            );
-            //actions
-            add_action(
-                'AHEE__EE_Addon__initialize_default_data__begin',
-                array('EE_Register_Message_Type', 'set_defaults')
-            );
+		//make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__('A message type named "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular___messages_caf" hook.',
+						'event_espresso'),
+					$mt_name
+				),
+				'4.3.0'
+			);
+		}
+		//setup $__ee_message_type_registry array from incoming values.
+		self::$_ee_message_type_registry[$mt_name] = array(
+			/**
+			 * The file name for the message type being registered.
+			 * Required.
+			 * @type string
+			 */
+			'mtfilename'                  => (string)$setup_args['mtfilename'],
+			/**
+			 * Autoload paths for classes used by the message type.
+			 * Required.
+			 * @type array
+			 */
+			'autoloadpaths'               => (array)$setup_args['autoloadpaths'],
+			/**
+			 * Messengers that the message type should be able to activate with.
+			 * Use messenger slugs.
+			 * @type array
+			 */
+			'messengers_to_activate_with' => ! empty($setup_args['messengers_to_activate_with'])
+				? (array)$setup_args['messengers_to_activate_with']
+				: array(),
+			/**
+			 * Messengers that the message type should validate with.
+			 * Use messenger slugs.
+			 * @type array
+			 */
+			'messengers_to_validate_with' => ! empty($setup_args['messengers_to_validate_with'])
+				? (array)$setup_args['messengers_to_validate_with']
+				: array(),
+			/**
+			 * Whether to force activate this message type the first time it is registered.
+			 * @type bool   False means its not activated by default and left up to the end user to activate.
+			 */
+			'force_activation'            => ! empty($setup_args['force_activation'])
+				? (bool)$setup_args['force_activation']
+				: false,
+			/**
+			 * What messengers this message type supports the default template pack for.
+			 * Note: If you do not set this (or any of the following template pack/variation related arguments) to true,
+			 * then it is expected that the message type being registered is doing its own custom default template
+			 * pack/variation registration.
+			 *
+			 * If this is set and has values, then it is expected that the following arguments are also set in the incoming options
+			 * $setup_arguments array as well:
+			 * - 'base_path_for_default_templates'
+			 *
+			 * @type array   Expect an array of messengers this supports default template packs for.
+			 */
+			'messengers_supporting_default_template_pack_with' => isset($setup_args['messengers_supporting_default_template_pack_with'])
+				? (array)$setup_args['messengers_supporting_default_template_pack_with']
+				: array(),
+			/**
+			 * The base path where the default templates for this message type can be found.
+			 * @type string
+			 */
+			'base_path_for_default_templates' => isset($setup_args['base_path_for_default_templates'])
+				? $setup_args['base_path_for_default_templates']
+				: '',
+			/**
+			 * The base path where the default variations for this message type can be found.
+			 * @type string
+			 */
+			'base_path_for_default_variation' => isset($setup_args['base_path_for_default_variation'])
+				? $setup_args['base_path_for_default_variation']
+				: '',
+			/**
+			 * The base url for the default variations for this message type.
+			 * @type string
+			 */
+			'base_url_for_default_variation' => isset($setup_args['base_url_for_default_variation'])
+				? $setup_args['base_url_for_default_variation']
+				: ''
+		);
+		//add filters but only if they haven't already been set (these filters only need to be registered ONCE because
+		//the callback handles all registered message types.
+		if ( false === has_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			array('EE_Register_Message_Type', 'register_msgs_autoload_paths')
+		)) {
+			add_filter(
+				'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+				array('EE_Register_Message_Type', 'register_msgs_autoload_paths'),
+				10
+			);
+			add_filter(
+				'FHEE__EE_messages__get_installed__messagetype_files',
+				array('EE_Register_Message_Type', 'register_messagetype_files'),
+				10,
+				1
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_default_message_types__default_types',
+				array('EE_Register_Message_Type', 'register_messengers_to_activate_mt_with'),
+				10,
+				2
+			);
+			add_filter(
+				'FHEE__EE_messenger__get_valid_message_types__valid_types',
+				array('EE_Register_Message_Type', 'register_messengers_to_validate_mt_with'),
+				10,
+				2
+			);
+			//actions
+			add_action(
+				'AHEE__EE_Addon__initialize_default_data__begin',
+				array('EE_Register_Message_Type', 'set_defaults')
+			);
 
-            //default template packs and variations related
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack_Default__get_supports',
-                array('EE_Register_Message_Type', 'register_default_template_pack_supports')
-            );
-            add_filter(
-                'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
-                array('EE_Register_Message_Type', 'register_base_template_path'),
-                10,
-                6
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
-                array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
-                10,
-                8
-            );
-            add_filter(
-                'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
-                array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
-                10,
-                8
-            );
-        }
-    }
+			//default template packs and variations related
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack_Default__get_supports',
+				array('EE_Register_Message_Type', 'register_default_template_pack_supports')
+			);
+			add_filter(
+				'FHEE__EE_Template_Pack___get_specific_template__filtered_base_path',
+				array('EE_Register_Message_Type', 'register_base_template_path'),
+				10,
+				6
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url',
+				array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
+				10,
+				8
+			);
+			add_filter(
+				'FHEE__EE_Messages_Template_Pack__get_variation__base_path',
+				array('EE_Register_Message_Type', 'register_variation_base_path_or_url'),
+				10,
+				8
+			);
+		}
+	}
 
 
-    /**
-     * This just ensures that when an addon registers a message type that on initial activation/reactivation the
-     * defaults the addon sets are taken care of.
-     */
-    public static function set_defaults()
-    {
-        /** @type EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	/**
+	 * This just ensures that when an addon registers a message type that on initial activation/reactivation the
+	 * defaults the addon sets are taken care of.
+	 */
+	public static function set_defaults()
+	{
+		/** @type EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
 
-        //for any message types with force activation, let's ensure they are activated
-        foreach (self::$_ee_message_type_registry as $message_type_name => $settings) {
-            if ($settings['force_activation']) {
-                foreach ($settings['messengers_to_activate_with'] as $messenger) {
-                    //DO not force activation if this message type has already been activated in the system
-                    if (! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name,
-                        $messenger)
-                    ) {
-                        $message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
-                    }
-                }
-            }
-        }
-    }
+		//for any message types with force activation, let's ensure they are activated
+		foreach (self::$_ee_message_type_registry as $message_type_name => $settings) {
+			if ($settings['force_activation']) {
+				foreach ($settings['messengers_to_activate_with'] as $messenger) {
+					//DO not force activation if this message type has already been activated in the system
+					if (! $message_resource_manager->has_message_type_been_activated_for_messenger($message_type_name,
+						$messenger)
+					) {
+						$message_resource_manager->ensure_message_type_is_active($message_type_name, $messenger);
+					}
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters a message type that was previously registered with a specific message_type_name.
-     *
-     * @since    4.3.0
-     * @param string $message_type_name the name for the message type that was previously registered
-     * @return void
-     */
-    public static function deregister($message_type_name = null)
-    {
-        if (! empty(self::$_ee_message_type_registry[$message_type_name])) {
-            //let's make sure that we remove any place this message type was made active
-            /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-            $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-            //ensures that if this message type is registered again that it retains its previous active state vs
-            //remaining inactive.
-            $Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
-                $message_type_name,
-                true
-            );
-            $Message_Resource_Manager->deactivate_message_type($message_type_name, false);
-            unset(self::$_ee_message_type_registry[$message_type_name]);
-        }
-    }
+	/**
+	 * This deregisters a message type that was previously registered with a specific message_type_name.
+	 *
+	 * @since    4.3.0
+	 * @param string $message_type_name the name for the message type that was previously registered
+	 * @return void
+	 */
+	public static function deregister($message_type_name = null)
+	{
+		if (! empty(self::$_ee_message_type_registry[$message_type_name])) {
+			//let's make sure that we remove any place this message type was made active
+			/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+			$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+			//ensures that if this message type is registered again that it retains its previous active state vs
+			//remaining inactive.
+			$Message_Resource_Manager->remove_message_type_has_been_activated_from_all_messengers(
+				$message_type_name,
+				true
+			);
+			$Message_Resource_Manager->deactivate_message_type($message_type_name, false);
+			unset(self::$_ee_message_type_registry[$message_type_name]);
+		}
+	}
 
 
-    /**
-     * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
-     *
-     * @since   4.3.0
-     * @param  array $messagetype_files The current array of message type file names
-     * @return  array                                 Array of message type file names
-     */
-    public static function register_messagetype_files($messagetype_files)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $messagetype_files;
-        }
-        foreach (self::$_ee_message_type_registry as $mt_reg) {
-            if (empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            $messagetype_files[] = $mt_reg['mtfilename'];
-        }
-        return $messagetype_files;
-    }
+	/**
+	 * callback for FHEE__EE_messages__get_installed__messagetype_files filter.
+	 *
+	 * @since   4.3.0
+	 * @param  array $messagetype_files The current array of message type file names
+	 * @return  array                                 Array of message type file names
+	 */
+	public static function register_messagetype_files($messagetype_files)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $messagetype_files;
+		}
+		foreach (self::$_ee_message_type_registry as $mt_reg) {
+			if (empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			$messagetype_files[] = $mt_reg['mtfilename'];
+		}
+		return $messagetype_files;
+	}
 
 
-    /**
-     * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
-     *
-     * @since    4.3.0
-     * @param array $paths array of paths to be checked by EE_messages autoloader.
-     * @return array
-     */
-    public static function register_msgs_autoload_paths($paths)
-    {
-        if (! empty(self::$_ee_message_type_registry)) {
-            foreach (self::$_ee_message_type_registry as $mt_reg) {
-                if (empty($mt_reg['autoloadpaths'])) {
-                    continue;
-                }
-                $paths = array_merge($paths, $mt_reg['autoloadpaths']);
-            }
-        }
-        return $paths;
-    }
+	/**
+	 * callback for FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.
+	 *
+	 * @since    4.3.0
+	 * @param array $paths array of paths to be checked by EE_messages autoloader.
+	 * @return array
+	 */
+	public static function register_msgs_autoload_paths($paths)
+	{
+		if (! empty(self::$_ee_message_type_registry)) {
+			foreach (self::$_ee_message_type_registry as $mt_reg) {
+				if (empty($mt_reg['autoloadpaths'])) {
+					continue;
+				}
+				$paths = array_merge($paths, $mt_reg['autoloadpaths']);
+			}
+		}
+		return $paths;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
-     *
-     * @since  4.3.0
-     * @param  array        $default_types  array of message types activated with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
-     * @return array
-     */
-    public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $default_types;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $default_types[] = $message_type_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_default_message_types__default_types filter.
+	 *
+	 * @since  4.3.0
+	 * @param  array        $default_types  array of message types activated with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
+	 * @return array
+	 */
+	public static function register_messengers_to_activate_mt_with($default_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $default_types;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_activate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_activate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$default_types[] = $message_type_name;
+				}
+			}
+		}
 
-        return $default_types;
-    }
+		return $default_types;
+	}
 
 
-    /**
-     * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
-     *
-     * @since   4.3.0
-     * @param  array        $valid_types    array of message types valid with messenger (
-     *                                      corresponds to the $name property of message type)
-     * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
-     * @return  array
-     */
-    public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger)
-    {
-        if (empty(self::$_ee_message_type_registry)) {
-            return $valid_types;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
-                continue;
-            }
-            // loop through each of the messengers and if it matches the loaded class
-            // then we add this message type to the
-            foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
-                if ($messenger->name == $msgr) {
-                    $valid_types[] = $message_type_name;
-                }
-            }
-        }
+	/**
+	 * callback for FHEE__EE_messenger__get_valid_message_types__default_types filter.
+	 *
+	 * @since   4.3.0
+	 * @param  array        $valid_types    array of message types valid with messenger (
+	 *                                      corresponds to the $name property of message type)
+	 * @param  EE_messenger $messenger      The EE_messenger the filter is called from.
+	 * @return  array
+	 */
+	public static function register_messengers_to_validate_mt_with($valid_types, EE_messenger $messenger)
+	{
+		if (empty(self::$_ee_message_type_registry)) {
+			return $valid_types;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_to_validate_with']) || empty($mt_reg['mtfilename'])) {
+				continue;
+			}
+			// loop through each of the messengers and if it matches the loaded class
+			// then we add this message type to the
+			foreach ($mt_reg['messengers_to_validate_with'] as $msgr) {
+				if ($messenger->name == $msgr) {
+					$valid_types[] = $message_type_name;
+				}
+			}
+		}
 
-        return $valid_types;
-    }
+		return $valid_types;
+	}
 
 
-    /**
-     * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
-     * supporting the default template pack
-     *
-     * @param array $supports
-     *
-     * @return array
-     */
-    public static function register_default_template_pack_supports($supports)
-    {
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
-                continue;
-            }
-            foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
-                $supports[$messenger_slug][] = $message_type_name;
-            }
-        }
-        return $supports;
-    }
+	/**
+	 * Callback for `FHEE__EE_Messages_Template_Pack_Default__get_supports` filter to register this message type as
+	 * supporting the default template pack
+	 *
+	 * @param array $supports
+	 *
+	 * @return array
+	 */
+	public static function register_default_template_pack_supports($supports)
+	{
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if (empty($mt_reg['messengers_supporting_default_template_pack_with'])) {
+				continue;
+			}
+			foreach ($mt_reg['messengers_supporting_default_template_pack_with'] as $messenger_slug) {
+				$supports[$messenger_slug][] = $message_type_name;
+			}
+		}
+		return $supports;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
-     *
-     * @param string $base_path The original base path for message templates
-     * @param EE_messenger $messenger
-     * @param EE_message_type $message_type
-     * @param string $field  The field requesting a template
-     * @param string $context  The context requesting a template
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_base_template_path(
-        $base_path,
-        $messenger,
-        $message_type,
-        $field,
-        $context,
-        $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default
-            || ! $message_type instanceof EE_message_type
-        ) {
-            return $base_path;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if ($message_type->name === $message_type_name
-                && ! empty($mt_reg['base_path_for_default_templates'])
-            ) {
-                return $mt_reg['base_path_for_default_templates'];
-            }
-        }
-        return $base_path;
-    }
+	/**
+	 * Callback for FHEE__EE_Template_Pack___get_specific_template__filtered_base_path
+	 *
+	 * @param string $base_path The original base path for message templates
+	 * @param EE_messenger $messenger
+	 * @param EE_message_type $message_type
+	 * @param string $field  The field requesting a template
+	 * @param string $context  The context requesting a template
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_base_template_path(
+		$base_path,
+		$messenger,
+		$message_type,
+		$field,
+		$context,
+		$template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default
+			|| ! $message_type instanceof EE_message_type
+		) {
+			return $base_path;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if ($message_type->name === $message_type_name
+				&& ! empty($mt_reg['base_path_for_default_templates'])
+			) {
+				return $mt_reg['base_path_for_default_templates'];
+			}
+		}
+		return $base_path;
+	}
 
 
-    /**
-     * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
-     * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
-     *
-     * @param string $base_path_or_url       The original incoming base url or path
-     * @param string $messenger_slug      The slug of the messenger the template is being generated for.
-     * @param string $message_type_slug The slug of the message type the template is being generated for.
-     * @param string $type             The "type" of css being requested.
-     * @param string $variation      The variation being requested.
-     * @param string $file_extension What file extension is expected for the variation file.
-     * @param bool $url whether a url or path is being requested.
-     * @param EE_Messages_Template_Pack $template_pack
-     *
-     * @return string
-     */
-    public static function register_variation_base_path_or_url(
-        $base_path_or_url,
-        $messenger_slug,
-        $message_type_slug,
-        $type,
-        $variation,
-        $url,
-        $file_extension,
-        $template_pack
-    ) {
-        if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
-            return $base_path_or_url;
-        }
-        foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
-            if ($message_type_name === $message_type_slug
-            ) {
-                if ($url
-                    && ! empty($mt_reg['base_url_for_default_variation'])
-                ) {
-                    return $mt_reg['base_url_for_default_variation'];
-                } elseif (! $url
-                    && ! empty($mt_reg['base_path_for_default_variation'])
-                ) {
-                    return $mt_reg['base_path_for_default_variation'];
-                }
-            }
-        }
-        return $base_path_or_url;
-    }
+	/**
+	 * Callback for FHEE__EE_Messages_Template_Pack__get_variation__base_path and
+	 * FHEE__EE_Messages_Template_Pack__get_variation__base_path_or_url hooks
+	 *
+	 * @param string $base_path_or_url       The original incoming base url or path
+	 * @param string $messenger_slug      The slug of the messenger the template is being generated for.
+	 * @param string $message_type_slug The slug of the message type the template is being generated for.
+	 * @param string $type             The "type" of css being requested.
+	 * @param string $variation      The variation being requested.
+	 * @param string $file_extension What file extension is expected for the variation file.
+	 * @param bool $url whether a url or path is being requested.
+	 * @param EE_Messages_Template_Pack $template_pack
+	 *
+	 * @return string
+	 */
+	public static function register_variation_base_path_or_url(
+		$base_path_or_url,
+		$messenger_slug,
+		$message_type_slug,
+		$type,
+		$variation,
+		$url,
+		$file_extension,
+		$template_pack
+	) {
+		if (! $template_pack instanceof EE_Messages_Template_Pack_Default) {
+			return $base_path_or_url;
+		}
+		foreach (self::$_ee_message_type_registry as $message_type_name => $mt_reg) {
+			if ($message_type_name === $message_type_slug
+			) {
+				if ($url
+					&& ! empty($mt_reg['base_url_for_default_variation'])
+				) {
+					return $mt_reg['base_url_for_default_variation'];
+				} elseif (! $url
+					&& ! empty($mt_reg['base_path_for_default_variation'])
+				) {
+					return $mt_reg['base_path_for_default_variation'];
+				}
+			}
+		}
+		return $base_path_or_url;
+	}
 }

core/libraries/messages/EE_Message_Resource_Manager.lib.php

Spacing +27 added lines, -27 removed lines

@@ -1,6 +1,6 @@ 
 <?php
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -276,7 +276,7 @@ 
     public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
     {
         $this->_initialize_collections();
-        return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]);
+        return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
     }
 
 
@@ -304,8 +304,8 @@ 
     {
         $settings = array();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            $settings = isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings'])
-                ? $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings']
+            $settings = isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'])
+                ? $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings']
                 : array();
         }
         return $settings;
@@ -324,7 +324,7 @@ 
         $this->_initialize_collections();
         return
             ! empty($this->_active_message_types[$messenger_name])
-            && ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types']);
+            && ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types']);
     }
 
 
@@ -339,7 +339,7 @@ 
     public function get_active_message_types_for_messenger($messenger_name)
     {
         $message_types = array();
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
+        if ( ! $this->messenger_has_active_message_types($messenger_name)) {
             return $message_types;
         }
         $installed_message_types = $this->installed_message_types();
@@ -364,11 +364,11 @@ 
         $active_message_type_names = array();
         $this->_initialize_collections();
         foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][$messenger . '-message_types'])) {
+            if ( ! isset($messenger_settings['settings'][$messenger.'-message_types'])) {
                 continue;
             }
-            foreach ($messenger_settings['settings'][$messenger . '-message_types'] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
+            foreach ($messenger_settings['settings'][$messenger.'-message_types'] as $message_type_name => $message_type_config) {
+                if ( ! in_array($message_type_name, $active_message_type_names)) {
                     $active_message_type_names[] = $message_type_name;
                 }
             }
@@ -444,7 +444,7 @@ 
     public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
     {
         $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
+        if ( ! in_array($message_type_name, $valid_message_types)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -567,7 +567,7 @@ 
      */
     public function ensure_messenger_is_active($messenger_name, $update_option = true)
     {
-        if (! isset($this->_active_messengers[$messenger_name])) {
+        if ( ! isset($this->_active_messengers[$messenger_name])) {
             try {
                 $this->activate_messenger($messenger_name, array(), $update_option);
             } catch (EE_Error $e) {
@@ -612,7 +612,7 @@ 
             $this->ensure_messenger_is_active($messenger_name, $update_option);
         }
 
-        if (! empty($not_installed_messenger)) {
+        if ( ! empty($not_installed_messenger)) {
             EE_Error::add_error(
                 sprintf(
                     __('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
@@ -643,7 +643,7 @@ 
             //ensure messenger is active (that's an inherent coupling between active message types and the
             //messenger they are being activated for.
             try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+                if ( ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
                     //all is good so let's just get it active
                     $this->activate_messenger($messenger_name, array($message_type_name), $update_option);
                 }
@@ -671,7 +671,7 @@ 
      */
     public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
     {
-        $message_type_names = (array)$message_type_names;
+        $message_type_names = (array) $message_type_names;
         foreach ($message_type_names as $message_type_name) {
             // note, intentionally not updating option here because we're in a loop.
             // We'll follow the instructions of the incoming $update_option argument after the loop.
@@ -717,7 +717,7 @@ 
             //generate new templates if necessary and ensure all related templates that are already in the database are
             //marked active.  Note, this will also deactivate a message type for a messenger if the template
             //cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
+            if ( ! empty($message_type_names)) {
                 $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
                 EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
             }
@@ -743,10 +743,10 @@ 
         //only override _active_message_types when an explicit array of $message_type_names has been provided.
         $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[$messenger->name])
             ? $messenger->get_default_message_types()
-            : (array)$message_type_names;
+            : (array) $message_type_names;
 
         //now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[$messenger->name])) {
+        if ( ! isset($this->_active_message_types[$messenger->name])) {
             $this->_active_message_types[$messenger->name]['settings'] = array();
         }
 
@@ -792,12 +792,12 @@ 
                     $existing_settings[$field] = $new_settings[$field];
                     continue;
                 }
-                if (! isset($existing_settings[$field])) {
+                if ( ! isset($existing_settings[$field])) {
                     $existing_settings[$field] = $values['default'];
                 }
             }
         }
-        $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings'] = $existing_settings;
+        $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]['settings'] = $existing_settings;
     }
 
 
@@ -818,11 +818,11 @@ 
         }
 
         // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
+        if ( ! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
             $this->_has_activated_messengers_and_message_types[$messenger->name] = array();
         }
         // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
+        if ( ! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
             $this->_has_activated_messengers_and_message_types[$messenger->name][] = $message_type_name;
         }
     }
@@ -841,7 +841,7 @@ 
         $messenger = $this->get_messenger($messenger_name);
         if ($messenger instanceof EE_messenger) {
             $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
+            if ( ! empty($msgr_settings)) {
                 foreach ($msgr_settings as $field => $value) {
                     //is there a new setting for this?
                     if (isset($new_settings[$field])) {
@@ -849,7 +849,7 @@ 
                         continue;
                     }
                     //only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
+                    if ( ! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
                         $this->_active_message_types[$messenger->name]['settings'][$field] = $value;
                     }
                 }
@@ -893,7 +893,7 @@ 
         }
         foreach ($this->_active_message_types as $messenger_name => $settings) {
             unset(
-                $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]
+                $this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]
             );
 
             //we always record (even on deactivation) that a message type has been activated because there should at
@@ -919,7 +919,7 @@ 
     {
         $this->_initialize_collections();
         if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]);
+            unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name.'-message_types'][$message_type_name]);
         }
         $this->_message_template_group_model->deactivate_message_template_groups_for(array($messenger_name),
             array($message_type_name));
@@ -1013,7 +1013,7 @@ 
         $all_message_types_valid           = true;
         //loop through list of active message types and verify they are installed.
         foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[$message_type_name])) {
+            if ( ! isset($installed_message_types[$message_type_name])) {
                 $this->remove_message_type_has_been_activated_from_all_messengers(
                     $message_type_name,
                     true
@@ -1087,7 +1087,7 @@ 
         $message_type_name,
         $consider_current_state = false
     ) {
-        foreach(array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
+        foreach (array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
             $this->remove_message_type_has_been_activated_for_messenger(
                 $message_type_name,
                 $messenger_name,

Indentation +1112 added lines, -1112 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -17,1117 +17,1117 @@ 
 class EE_Message_Resource_Manager
 {
 
-    /**
-     * This option in the database is used to keep a record of message types that have been activated for a messenger
-     * at some point in the history of the site.  It is utilized by the implementation of the 'force' flag in
-     * EE_Register_Message_Type.  The force flag is an indication of whether a message type should be activated by
-     * default when the message type is registered.  However, if a user has explicitly deactivated a message type, then
-     * the force flag is ignored.  The method by which the code knows whether to ignore this flag is via this option.
-     * Note, that this is NOT a historical record.  Its entirely possible for a message type to have been activated for
-     * a messenger and yet not have a record in this option.  This occurs when a message type is inactivated through an
-     * automated process (when an add-on registering the message type deactivates, or when some other code calls the
-     * EE_Registery_Message_Type::deregister method) and the related record(s) is(are) removed from this option to ensure
-     * the "force" flag is respected if that message type is later re-registered.
-     *
-     * This option should NOT be used to determine the current "active" state of a message type for a given messenger.
-     *
-     * The name of this option (and related methods/properties) is due to matching the original intended purpose for the
-     * option that got superseded by later behaviour requirements.
-     */
-    const HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME = 'ee_has_activated_messenger';
-
-    /**
-     * @type boolean $_initialized
-     */
-    protected $_initialized = false;
-
-    /**
-     * @type EE_Messenger_Collection $_messenger_collection_loader
-     */
-    protected $_messenger_collection_loader;
-
-    /**
-     * @type EE_Message_Type_Collection $_message_type_collection_loader
-     */
-    protected $_message_type_collection_loader;
-
-    /**
-     * @type EEM_Message_Template_Group $_message_template_group_model
-     */
-    protected $_message_template_group_model;
-
-    /**
-     * @type EE_messenger[]
-     */
-    protected $_installed_messengers = array();
-
-    /**
-     * @type EE_message_type[]
-     */
-    protected $_installed_message_types = array();
-
-    /**
-     * Array of active messengers.
-     * Format is this:
-     * array(
-     *      'messenger_name' => EE_messenger
-     * )
-     *
-     * @type EE_messenger[]
-     */
-    protected $_active_messengers = array();
-
-    /**
-     * Formatted array of active message types grouped per messenger.
-     * Format is this:
-     * array(
-     *      'messenger_name' => array(
-     *          'settings' => array(
-     *              '{messenger_name}-message_types' => array(
-     *                  'message_type_name' => array() //variable array of settings corresponding to message type.
-     *              )
-     *          )
-     *      )
-     * )
-     *
-     * @type array
-     */
-    protected $_active_message_types = array();
-
-
-    /**
-     * This holds the array of messengers and their corresponding message types that have
-     * been activated on a site at some point.  This is an important record that helps the messages system
-     * not accidentally reactivate something that was intentionally deactivated by a user.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @type array
-     */
-    protected $_has_activated_messengers_and_message_types = array();
-
-    /**
-     * An array of unique message type contexts across all active message types.
-     * The array will be indexed by either 'slugs' or 'all'.
-     * The slugs index contains an array indexed by unique context slugs with the latest label representation for that
-     * slug. array(
-     *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
-     * );
-     * The all index returns an array in this format:
-     * array(
-     *      'message_type_name' => array(
-     *          'context_slug' => array(
-     *              'label' => 'localized label for context',
-     *              'description' => 'localized description for context'
-     *          )
-     *      )
-     * );
-     *
-     * @type array
-     */
-    protected $_contexts = array();
-
-
-    /**
-     * EE_Message_Resource_Manager constructor.
-     *
-     * @param \EE_Messenger_Collection_Loader    $Messenger_Collection_Loader
-     * @param \EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader
-     * @param \EEM_Message_Template_Group        $Message_Template_Group_Model
-     */
-    function __construct(
-        EE_Messenger_Collection_Loader $Messenger_Collection_Loader,
-        EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader,
-        EEM_Message_Template_Group $Message_Template_Group_Model
-    ) {
-        $this->_messenger_collection_loader    = $Messenger_Collection_Loader;
-        $this->_message_type_collection_loader = $Message_Type_Collection_Loader;
-        $this->_message_template_group_model   = $Message_Template_Group_Model;
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function _initialize_collections()
-    {
-        if ($this->_initialized) {
-            return;
-        }
-        $this->_initialized = true;
-        $this->_messenger_collection_loader->load_messengers_from_folder();
-        $this->_message_type_collection_loader->load_message_types_from_folder();
-        $this->get_has_activated_messengers_option(true);
-        $this->_set_active_messengers_and_message_types();
-    }
-
-
-    /**
-     * @return EE_Messenger_Collection
-     */
-    public function messenger_collection()
-    {
-        $this->_initialize_collections();
-        return $this->_messenger_collection_loader->messenger_collection();
-    }
-
-
-    /**
-     * @return EE_messenger[]
-     */
-    public function active_messengers()
-    {
-        $this->_initialize_collections();
-        return $this->_active_messengers;
-    }
-
-
-    /**
-     * @param string $messenger_name
-     * @return \EE_messenger
-     */
-    public function get_messenger($messenger_name)
-    {
-        return $this->messenger_collection()->get_by_info($messenger_name);
-    }
-
-
-    /**
-     * This returns the corresponding EE_messenger object for the given string if it is active.
-     *
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_active_messenger($messenger)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_messengers[$messenger]) ? $this->_active_messengers[$messenger] : null;
-    }
-
-
-    /**
-     * @return \EE_messenger[]
-     */
-    public function installed_messengers()
-    {
-        if (empty($this->_installed_messengers)) {
-            $this->_installed_messengers = array();
-            $this->messenger_collection()->rewind();
-            while ($this->messenger_collection()->valid()) {
-                $this->_installed_messengers[$this->messenger_collection()->current()->name] = $this->messenger_collection()->current();
-                $this->messenger_collection()->next();
-            }
-        }
-        return $this->_installed_messengers;
-    }
-
-
-    /**
-     * @param string $messenger_name
-     * @return \EE_messenger
-     * @throws \EE_Error
-     */
-    public function valid_messenger($messenger_name)
-    {
-        $messenger = $this->get_messenger($messenger_name);
-        if ($messenger instanceof EE_messenger) {
-            return $messenger;
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The "%1$s" messenger is either invalid or not installed', 'event_espresso'),
-                $messenger_name
-            )
-        );
-    }
-
-
-    /**
-     * @return EE_Message_Type_Collection
-     */
-    public function message_type_collection()
-    {
-        $this->_initialize_collections();
-        return $this->_message_type_collection_loader->message_type_collection();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function active_message_types()
-    {
-        $this->_initialize_collections();
-        return $this->_active_message_types;
-    }
-
-
-    /**
-     * @param string $message_type_name
-     * @return \EE_message_type
-     */
-    public function get_message_type($message_type_name)
-    {
-        return $this->message_type_collection()->get_by_info($message_type_name);
-    }
-
-
-    /**
-     * This returns the EE_message_type from the active message types array ( if present );
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name
-     * @return \EE_message_type|null
-     */
-    public function get_active_message_type_for_messenger($messenger_name, $message_type_name)
-    {
-        return $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
-            ? $this->get_message_type($message_type_name)
-            : null;
-    }
-
-
-    /**
-     * Returns whether the given message type is active for the given messenger.
-     *
-     * @param string $messenger_name
-     * @param string $message_type_name
-     * @return bool
-     */
-    public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]);
-    }
-
-
-    /**
-     * Returns whether the given messenger is active.
-     *
-     * @param string $messenger_name the name of the messenger to check if active.
-     * @return bool
-     */
-    public function is_messenger_active($messenger_name)
-    {
-        $this->_initialize_collections();
-        return ! empty($this->_active_message_types[$messenger_name]);
-    }
-
-
-    /**
-     * This returns any settings that might be on a message type for a messenger
-     *
-     * @param string $messenger_name    The slug of the messenger
-     * @param string $message_type_name The slug of the message type getting the settings for.
-     * @return array
-     */
-    public function get_message_type_settings_for_messenger($messenger_name, $message_type_name)
-    {
-        $settings = array();
-        if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            $settings = isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings'])
-                ? $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings']
-                : array();
-        }
-        return $settings;
-    }
-
-
-    /**
-     * Returns whether the given messenger name has active message types on it.
-     * Infers whether the messenger is active or not as well.
-     *
-     * @param string $messenger_name
-     * @return bool
-     */
-    public function messenger_has_active_message_types($messenger_name)
-    {
-        $this->_initialize_collections();
-        return
-            ! empty($this->_active_message_types[$messenger_name])
-            && ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types']);
-    }
-
-
-    /**
-     * This checks the _active_message_types property for any active message types
-     * that are present for the given messenger and returns them.
-     *
-     * @since 4.9.0
-     * @param string $messenger_name The messenger being checked
-     * @return EE_message_type[]|array    (empty array if no active_message_types)
-     */
-    public function get_active_message_types_for_messenger($messenger_name)
-    {
-        $message_types = array();
-        if (! $this->messenger_has_active_message_types($messenger_name)) {
-            return $message_types;
-        }
-        $installed_message_types = $this->installed_message_types();
-        foreach ($installed_message_types as $message_type_name => $message_type) {
-            if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                $message_types[$message_type_name] = $message_type;
-            }
-        }
-        return $message_types;
-    }
-
-
-    /**
-     * This does NOT return the _active_message_types property but
-     * simply returns an array of active message type names from that property.
-     * (The _active_message_types property is indexed by messenger and active message_types per messenger).
-     *
-     * @return array message_type references (string)
-     */
-    public function list_of_active_message_types()
-    {
-        $active_message_type_names = array();
-        $this->_initialize_collections();
-        foreach ($this->_active_message_types as $messenger => $messenger_settings) {
-            if (! isset($messenger_settings['settings'][$messenger . '-message_types'])) {
-                continue;
-            }
-            foreach ($messenger_settings['settings'][$messenger . '-message_types'] as $message_type_name => $message_type_config) {
-                if (! in_array($message_type_name, $active_message_type_names)) {
-                    $active_message_type_names[] = $message_type_name;
-                }
-            }
-        }
-        return $active_message_type_names;
-    }
-
-
-    /**
-     * Same as list_of_active_message_types() except this returns actual EE_message_type objects
-     *
-     * @since 4.9.0
-     * @return \EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        $active_message_types      = array();
-        $installed_message_types   = $this->installed_message_types();
-        $active_message_type_names = $this->list_of_active_message_types();
-        foreach ($active_message_type_names as $active_message_type_name) {
-            if (isset($installed_message_types[$active_message_type_name])) {
-                $active_message_types[$active_message_type_name] = $installed_message_types[$active_message_type_name];
-            }
-        }
-        return $active_message_types;
-    }
-
-
-    /**
-     * @return \EE_message_type[]
-     */
-    public function installed_message_types()
-    {
-        if (empty($this->_installed_message_types)) {
-            $this->message_type_collection()->rewind();
-            while ($this->message_type_collection()->valid()) {
-                $this->_installed_message_types[$this->message_type_collection()->current()->name] = $this->message_type_collection()->current();
-                $this->message_type_collection()->next();
-            }
-        }
-        return $this->_installed_message_types;
-    }
-
-
-    /**
-     * @param string $message_type_name
-     * @return \EE_message_type
-     * @throws \EE_Error
-     */
-    public function valid_message_type($message_type_name)
-    {
-        $message_type = $this->get_message_type($message_type_name);
-        if ($message_type instanceof EE_message_type) {
-            return $message_type;
-        }
-        throw new EE_Error(
-            sprintf(
-                __('The "%1$s" message type is either invalid or not installed', 'event_espresso'),
-                $message_type_name
-            )
-        );
-    }
-
-
-    /**
-     * valid_message_type_for_messenger
-     *
-     * @param EE_messenger $messenger
-     * @param string       $message_type_name
-     * @return boolean
-     * @throws \EE_Error
-     */
-    public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
-    {
-        $valid_message_types = $messenger->get_valid_message_types();
-        if (! in_array($message_type_name, $valid_message_types)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'The message type (%1$s) sent to "%2$s" is not valid for the "%3$s" messenger.  Double-check the spelling and verify that message type has been registered as a valid type with the messenger.',
-                        'event_espresso'
-                    ),
-                    $message_type_name,
-                    __METHOD__,
-                    $messenger->name
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * Used to return active messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     *
-     * @param   bool $reset     If true then we ignore whether the option is cached on the _active_message_types
-     *                          property and pull directly from the db.  Otherwise whatever is currently on the
-     *                          $_active_message_types property is pulled.
-     * @return array
-     */
-    public function get_active_messengers_option($reset = false)
-    {
-        if ($reset) {
-            $this->_active_message_types = get_option('ee_active_messengers', array());
-        }
-        return $this->_active_message_types;
-    }
-
-
-    /**
-     * Used to update the active messengers array stored in the wp options table.
-     *
-     * @param array $active_messenger_settings Incoming data to save.  If empty, then the internal cached property
-     *                                         representing this data is used.
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public function update_active_messengers_option($active_messenger_settings = array())
-    {
-        $active_messenger_settings = empty($active_messenger_settings) ? $this->_active_message_types : $active_messenger_settings;
-        //make sure _active_message_types is updated (this is the internal cache for the settings).
-        $this->_active_message_types = $active_messenger_settings;
-        return update_option('ee_active_messengers', $active_messenger_settings);
-    }
-
-
-    /**
-     * Used to return has activated message types for messengers array stored in the wp options table.
-     * If no value is present in the option then an empty array is returned.
-     * The value is cached on the $_has_activated_messengers_and_message_types property for future calls.
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param   bool $reset Used to indicate that any cached value should be ignored.
-     * @return array
-     */
-    public function get_has_activated_messengers_option($reset = false)
-    {
-        if ($reset || empty($this->_has_activated_messengers_and_message_types)) {
-            $this->_has_activated_messengers_and_message_types = get_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, array());
-        }
-        return $this->_has_activated_messengers_and_message_types;
-    }
-
-
-    /**
-     * Used to update the has activated option in the db.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param array $has_activated_messengers Incoming data to save.  If empty, then the internal cached property
-     *                                        representing this data is used.
-     * @return bool FALSE if not updated, TRUE if updated.
-     */
-    public function update_has_activated_messengers_option($has_activated_messengers = array())
-    {
-        //make sure the option has been retrieved from first so we don't overwrite it accidentally.
-        if (empty($has_activated_messengers) && empty($this->_has_activated_messengers_and_message_types)) {
-            $this->get_has_activated_messengers_option();
-        }
-        $has_activated_messengers = empty($has_activated_messengers)
-            ? $this->_has_activated_messengers_and_message_types
-            : $has_activated_messengers;
-        return update_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, $has_activated_messengers);
-    }
-
-
-    /**
-     * wrapper for _set_active_messengers_and_message_types()
-     */
-    public function reset_active_messengers_and_message_types()
-    {
-        $this->_set_active_messengers_and_message_types();
-    }
-
-
-    /**
-     * Generate list of active messengers and message types from collection.
-     * This sets up the active messengers from what is present in the database.
-     */
-    protected function _set_active_messengers_and_message_types()
-    {
-        //echo "\n\n " . __LINE__ . ") " . __METHOD__ . "() \n";
-        // list of activated messengers as set via the admin
-        // note calling `get_active_messengers_options` also initializes the _active_message_types property.
-        $this->get_active_messengers_option(true);
-        $this->ensure_messengers_are_active(array(), false, true);
-        $this->update_active_messengers_option();
-        $this->update_has_activated_messengers_option();
-    }
-
-
-    /**
-     * Ensures that the specified messenger is currently active.
-     * If not, activates it and its default message types.
-     *
-     * @param string $messenger_name
-     * @param bool   $update_option Whether to update the option in the db or not.
-     * @return boolean true if either already active or successfully activated.
-     */
-    public function ensure_messenger_is_active($messenger_name, $update_option = true)
-    {
-        if (! isset($this->_active_messengers[$messenger_name])) {
-            try {
-                $this->activate_messenger($messenger_name, array(), $update_option);
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    $e->getMessage(),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This ensures the given array of messenger names is active in the system.
-     * Note, this method will not activate any NEW message types for the messenger when it is called. Instead,
-     * it will automatically activate the default message types for the messenger if its not active.
-     *
-     * @param array $messenger_names  Array of messenger names for messengers to be activated.  If an empty array
-     *                                (default) then will attempt to set the active messengers from the
-     *                                activated_messengers option
-     *                                (stored in $_active_message_types property).
-     * @param bool  $update_option    Whether to update the related active messengers option.
-     * @param bool  $verify           Whether to verify the messengers are installed before activating. Note if this is
-     *                                set to true and a messenger is indicated as active, but is NOT installed, then it
-     *                                will automatically be deactivated.
-     */
-    public function ensure_messengers_are_active($messenger_names = array(), $update_option = true, $verify = false)
-    {
-        $messenger_names = empty($messenger_names) ? array_keys($this->_active_message_types) : $messenger_names;
-
-        $not_installed = array();
-        foreach ($messenger_names as $messenger_name) {
-            if ($verify && ! $this->messenger_collection()->has_by_name($messenger_name)) {
-                $not_installed[] = $messenger_name;
-                $this->deactivate_messenger($messenger_name);
-                continue;
-            }
-            $this->ensure_messenger_is_active($messenger_name, $update_option);
-        }
-
-        if (! empty($not_installed_messenger)) {
-            EE_Error::add_error(
-                sprintf(
-                    __('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
-                    '<br />',
-                    implode(', ', $not_installed_messenger)
-                ),
-                __FILE__, __FUNCTION__, __LINE__
-            );
-        }
-    }
-
-
-    /**
-     * Ensures that the specified message type for the given messenger is currently active, if not activates it.
-     * This ALSO ensures that the given messenger is active as well!
-     *
-     * @param string $message_type_name message type name.
-     * @param        $messenger_name
-     * @param bool   $update_option     Whether to update the option in the db or not.
-     * @return bool  Returns true if already is active or if was activated successfully.
-     * @throws \EE_Error
-     */
-    public function ensure_message_type_is_active($message_type_name, $messenger_name, $update_option = true)
-    {
-        // grab the messenger to work with.
-        $messenger = $this->valid_messenger($messenger_name);
-        if ($this->valid_message_type_for_messenger($messenger, $message_type_name)) {
-            //ensure messenger is active (that's an inherent coupling between active message types and the
-            //messenger they are being activated for.
-            try {
-                if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-                    //all is good so let's just get it active
-                    $this->activate_messenger($messenger_name, array($message_type_name), $update_option);
-                }
-            } catch (EE_Error $e) {
-                EE_Error::add_error(
-                    $e->getMessage(),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This is a wrapper for `ensure_message_type_is_active` that will handle ensuring multiple message types for a
-     * messenger are active in one go.
-     *
-     * @param array  $message_type_names Array of message type names to ensure are active.
-     * @param string $messenger_name     The name of the messenger that the message types are to be activated on.
-     * @param bool   $update_option      Whether to persist the activation to the database or not (default true).
-     */
-    public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
-    {
-        $message_type_names = (array)$message_type_names;
-        foreach ($message_type_names as $message_type_name) {
-            // note, intentionally not updating option here because we're in a loop.
-            // We'll follow the instructions of the incoming $update_option argument after the loop.
-            $this->ensure_message_type_is_active($message_type_name, $messenger_name, false);
-        }
-        if ($update_option) {
-            $this->update_active_messengers_option();
-            $this->update_has_activated_messengers_option();
-        }
-    }
-
-
-    /**
-     * Activates the specified messenger.
-     *
-     * @param string $messenger_name
-     * @param array  $message_type_names        An array of message type names to activate with this messenger.
-     *                                          If included we do NOT setup the default message types
-     *                                          (assuming they are already setup.)
-     * @param bool   $update_active_messengers_option
-     * @return array of generated templates
-     * @throws \EE_Error
-     */
-    public function activate_messenger(
-        $messenger_name,
-        $message_type_names = array(),
-        $update_active_messengers_option = true
-    ) {
-        $templates = array();
-        // grab the messenger to work with.
-        $messenger = $this->messenger_collection()->get_by_info($messenger_name);
-        // it's inactive. Activate it.
-        if ($messenger instanceof EE_messenger) {
-            $this->_active_messengers[$messenger->name] = $messenger;
-            //activate incoming message types set to be activated with messenger.
-            $message_type_names = $this->_activate_message_types($messenger, $message_type_names);
-            // setup any initial settings for the messenger if necessary.
-            $this->add_settings_for_messenger($messenger->name);
-            if ($update_active_messengers_option) {
-                $this->update_active_messengers_option();
-                $this->update_has_activated_messengers_option();
-            }
-            //generate new templates if necessary and ensure all related templates that are already in the database are
-            //marked active.  Note, this will also deactivate a message type for a messenger if the template
-            //cannot be successfully created during its attempt (only happens for global template attempts).
-            if (! empty($message_type_names)) {
-                $templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
-                EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
-            }
-        }
-        return $templates;
-    }
-
-
-    /**
-     * Activates given message types for the given EE_messenger object.
-     * Note: (very important) This method does not persist the activation to the database.
-     * See code implementing this method in this class for examples of how to persist.
-     *
-     * @param \EE_messenger $messenger
-     * @param  array        $message_type_names
-     * @return array
-     */
-    protected function _activate_message_types(EE_messenger $messenger, $message_type_names = array())
-    {
-        //If $message_type_names is empty, AND $this->_active_message_types is empty, then that means
-        //things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
-        //So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
-        //only override _active_message_types when an explicit array of $message_type_names has been provided.
-        $message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[$messenger->name])
-            ? $messenger->get_default_message_types()
-            : (array)$message_type_names;
-
-        //now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
-        if (! isset($this->_active_message_types[$messenger->name])) {
-            $this->_active_message_types[$messenger->name]['settings'] = array();
-        }
-
-        if ($message_type_names) {
-            // cycle thru message types
-            foreach ($message_type_names as $message_type_name) {
-                //only register the message type as active IF it isn't already active
-                //and if its actually installed.
-                if (
-                ! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
-                ) {
-                    $this->add_settings_for_message_type($messenger->name, $message_type_name);
-                    $this->_set_messenger_has_activated_message_type(
-                        $messenger,
-                        $message_type_name
-                    );
-                }
-            }
-        }
-        return $message_type_names;
-    }
-
-
-    /**
-     * add_settings_for_message_type
-     * NOTE This does NOT automatically persist any settings to the db.  Client code should call
-     * $this->update_active_messengers_option to persist.
-     *
-     * @param  string $messenger_name    The name of the messenger adding the settings for
-     * @param  string $message_type_name The name of the message type adding the settings for
-     * @param  array  $new_settings      Any new settings being set for the message type and messenger
-     */
-    public function add_settings_for_message_type($messenger_name, $message_type_name, $new_settings = array())
-    {
-        // get installed message type from collection
-        $message_type      = $this->message_type_collection()->get_by_info($message_type_name);
-        $existing_settings = $this->get_message_type_settings_for_messenger($messenger_name, $message_type_name);
-        //we need to setup any initial settings for message types
-        if ($message_type instanceof EE_message_type) {
-            $default_settings = $message_type->get_admin_settings_fields();
-            foreach ($default_settings as $field => $values) {
-                if (isset($new_settings[$field])) {
-                    $existing_settings[$field] = $new_settings[$field];
-                    continue;
-                }
-                if (! isset($existing_settings[$field])) {
-                    $existing_settings[$field] = $values['default'];
-                }
-            }
-        }
-        $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings'] = $existing_settings;
-    }
-
-
-    /**
-     * Updates the internal cached _has_activated_messengers_and_message_types property with the given messenger
-     * and message type.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @access protected
-     * @param \EE_messenger $messenger
-     * @param string        $message_type_name
-     */
-    protected function _set_messenger_has_activated_message_type(EE_messenger $messenger, $message_type_name)
-    {
-
-        //if _has_activated_messengers_and_message_types is empty then lets ensure its initialized
-        if (empty($this->_has_activated_messengers_and_message_types)) {
-            $this->get_has_activated_messengers_option();
-        }
-
-        // make sure this messenger has a record in the has_activated array
-        if (! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
-            $this->_has_activated_messengers_and_message_types[$messenger->name] = array();
-        }
-        // check if message type has already been added
-        if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
-            $this->_has_activated_messengers_and_message_types[$messenger->name][] = $message_type_name;
-        }
-    }
-
-
-    /**
-     * add_settings_for_messenger
-     * NOTE This does NOT automatically persist any settings to the db.  Client code should call
-     * $this->update_active_messengers_option to persist.
-     *
-     * @param string $messenger_name The name of the messenger the settings is being added for.
-     * @param array  $new_settings   An array of settings to update the existing settings.
-     */
-    public function add_settings_for_messenger($messenger_name, $new_settings = array())
-    {
-        $messenger = $this->get_messenger($messenger_name);
-        if ($messenger instanceof EE_messenger) {
-            $msgr_settings = $messenger->get_admin_settings_fields();
-            if (! empty($msgr_settings)) {
-                foreach ($msgr_settings as $field => $value) {
-                    //is there a new setting for this?
-                    if (isset($new_settings[$field])) {
-                        $this->_active_message_types[$messenger->name]['settings'][$field] = $new_settings[$field];
-                        continue;
-                    }
-                    //only set the default if it isn't already set.
-                    if (! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
-                        $this->_active_message_types[$messenger->name]['settings'][$field] = $value;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * deactivate_messenger
-     *
-     * @param  string|EE_messenger $messenger_name name of messenger
-     * @return void
-     */
-    public function deactivate_messenger($messenger_name)
-    {
-        $this->_initialize_collections();
-        if ($messenger_name instanceof EE_messenger) {
-            $messenger_name = $messenger_name->name;
-        }
-        unset($this->_active_messengers[$messenger_name]);
-        unset($this->_active_message_types[$messenger_name]);
-        $this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
-        $this->update_active_messengers_option();
-    }
-
-
-    /**
-     * Deactivates a message type (note this will deactivate across all messenger's it is active on.
-     *
-     * @param  string $message_type_name     name of message type being deactivated
-     * @param bool    $set_has_active_record By default we always record the has_active record when deactivating a message
-     *                                       type.  However, this can be overridden if we don't want this set (usually when
-     *                                       this is called as a part of deregistration of a custom message type)
-     */
-    public function deactivate_message_type($message_type_name, $set_has_active_record = true)
-    {
-        $this->_initialize_collections();
-        if ($message_type_name instanceof EE_message_type) {
-            $message_type_name = $message_type_name->name;
-        }
-        foreach ($this->_active_message_types as $messenger_name => $settings) {
-            unset(
-                $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]
-            );
-
-            //we always record (even on deactivation) that a message type has been activated because there should at
-            //least be a record in the "has_activated" option that it WAS active at one point.
-            if ($set_has_active_record) {
-                $messenger = $this->get_messenger($messenger_name);
-                $this->_set_messenger_has_activated_message_type($messenger, $message_type_name);
-            }
-        }
-        $this->_message_template_group_model->deactivate_message_template_groups_for('', $message_type_name);
-        $this->update_active_messengers_option();
-        $this->update_has_activated_messengers_option();
-    }
-
-
-    /**
-     * Deactivates a message type for a specific messenger as opposed to all messengers.
-     *
-     * @param string $message_type_name Name of message type being deactivated.
-     * @param string $messenger_name    Name of messenger the message type is being deactivated for.
-     */
-    public function deactivate_message_type_for_messenger($message_type_name, $messenger_name)
-    {
-        $this->_initialize_collections();
-        if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
-            unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]);
-        }
-        $this->_message_template_group_model->deactivate_message_template_groups_for(array($messenger_name),
-            array($message_type_name));
-        $this->update_active_messengers_option();
-    }
-
-
-    /**
-     * Used to verify if a message can be sent for the given messenger and message type
-     * and that it is a generating messenger (used for generating message templates).
-     *
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        //get the $messengers the message type says it can be used with.
-        foreach ($message_type->with_messengers() as $generating_messenger => $secondary_messengers) {
-            if (
-                $messenger->name === $generating_messenger
-                && $this->is_message_type_active_for_messenger($messenger->name, $message_type->name)
-            ) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * This returns all the contexts that are registered by all message types.
-     * If $slugs_only is true,
-     * then just an array indexed by unique context slugs with the latest label representation for that slug.
-     * array(
-     *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
-     * );
-     * If $slugs_only is false, then the format is:
-     * array(
-     *      'message_type_name' => array(
-     *          'context_slug' => array(
-     *              'label' => 'localized label for context',
-     *              'description' => 'localized description for context'
-     *          )
-     *      )
-     * );
-     * Keep in mind that although different message types may share the same context slugs,
-     * it is possible that the context is described differently by the message type.
-     *
-     * @since 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true)
-     *                           or all contexts indexed by message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        $key = $slugs_only ? 'slugs' : 'all';
-        // check if contexts has been setup yet.
-        if (empty($this->_contexts[$key])) {
-            // So let's get all active message type objects and loop through to get all unique contexts
-            foreach ($this->get_active_message_type_objects() as $message_type) {
-                if ($message_type instanceof EE_message_type) {
-                    $message_type_contexts = $message_type->get_contexts();
-                    if ($slugs_only) {
-                        foreach ($message_type_contexts as $context => $context_details) {
-                            $this->_contexts[$key][$context] = $context_details['label'];
-                        }
-                    } else {
-                        $this->_contexts[$key][$message_type->name] = $message_type_contexts;
-                    }
-                }
-            }
-        }
-        return ! empty($this->_contexts[$key]) ? $this->_contexts[$key] : array();
-    }
-
-
-    /**
-     * This checks the internal record of what message types are considered "active" and verifies that
-     * there is an installed class definition for that message type.  If the active message type does not have a
-     * corresponding accessible message type class then it will be deactivated from all messengers it is active on and
-     * any related message templates will be inactivated as well.
-     *
-     * @return bool   true means all active message types are valid, false means at least one message type was
-     *                deactivated.
-     */
-    public function validate_active_message_types_are_installed()
-    {
-        $list_of_active_message_type_names = $this->list_of_active_message_types();
-        $installed_message_types           = $this->installed_message_types();
-        $all_message_types_valid           = true;
-        //loop through list of active message types and verify they are installed.
-        foreach ($list_of_active_message_type_names as $message_type_name) {
-            if (! isset($installed_message_types[$message_type_name])) {
-                $this->remove_message_type_has_been_activated_from_all_messengers(
-                    $message_type_name,
-                    true
-                );
-                $this->deactivate_message_type($message_type_name, false);
-                $all_message_types_valid = false;
-            }
-        }
-        return $all_message_types_valid;
-    }
-
-
-    /**
-     * This method checks the `ee_has_activated_messenger` option to see if the message type has ever been
-     * activated for the given messenger.  This can be called by client code on plugin updates etc to determine whether
-     * to attempt automatically reactivating message types that should be activated by default or not.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param $message_type_name
-     * @param $messenger_name
-     * @return bool
-     */
-    public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
-    {
-        $has_activated = $this->get_has_activated_messengers_option();
-        return isset($has_activated[$messenger_name])
-               && in_array($message_type_name, $has_activated[$messenger_name]);
-    }
-
-
-    /**
-     * This method unsets a message type from the given messenger has activated option.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param string $message_type_name
-     * @param string $messenger_name
-     * @param bool   $consider_current_state  Whether to consider whether the  message type is currently active or not.
-     *                                        If it is currently active, then remove.  Otherwise leave it alone.
-     */
-    public function remove_message_type_has_been_activated_for_messenger(
-        $message_type_name,
-        $messenger_name,
-        $consider_current_state = false
-    ) {
-        if ($consider_current_state
-            && ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
-        ) {
-            //when consider current state is true, this means we don't want to change anything on the "has_activated"
-            //record if the message type is currently active for this messenger.  This is used when we want to retain
-            //the record for user initiated inactivations of the message type.
-            return;
-        }
-        $has_activated = $this->get_has_activated_messengers_option();
-        $key_for_message_type = isset($has_activated[$messenger_name])
-            ? array_search($message_type_name, $has_activated[$messenger_name], true)
-            : false;
-        if ($key_for_message_type !== false) {
-            unset($has_activated[$messenger_name][$key_for_message_type]);
-            $this->update_has_activated_messengers_option($has_activated);
-            //reset the internal cached property
-            $this->get_has_activated_messengers_option(true);
-        }
-    }
-
-
-    /**
-     * Removes a message type active record from all messengers it is attached to.
-     *
-     * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
-     *
-     * @param      $message_type_name
-     * @param bool $consider_current_state  Whether to consider whether the  message type is currently active or not.
-     *                                      If it is currently active, then remove.  Otherwise leave it alone.
-     */
-    public function remove_message_type_has_been_activated_from_all_messengers(
-        $message_type_name,
-        $consider_current_state = false
-    ) {
-        foreach(array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
-            $this->remove_message_type_has_been_activated_for_messenger(
-                $message_type_name,
-                $messenger_name,
-                $consider_current_state
-            );
-        }
-    }
+	/**
+	 * This option in the database is used to keep a record of message types that have been activated for a messenger
+	 * at some point in the history of the site.  It is utilized by the implementation of the 'force' flag in
+	 * EE_Register_Message_Type.  The force flag is an indication of whether a message type should be activated by
+	 * default when the message type is registered.  However, if a user has explicitly deactivated a message type, then
+	 * the force flag is ignored.  The method by which the code knows whether to ignore this flag is via this option.
+	 * Note, that this is NOT a historical record.  Its entirely possible for a message type to have been activated for
+	 * a messenger and yet not have a record in this option.  This occurs when a message type is inactivated through an
+	 * automated process (when an add-on registering the message type deactivates, or when some other code calls the
+	 * EE_Registery_Message_Type::deregister method) and the related record(s) is(are) removed from this option to ensure
+	 * the "force" flag is respected if that message type is later re-registered.
+	 *
+	 * This option should NOT be used to determine the current "active" state of a message type for a given messenger.
+	 *
+	 * The name of this option (and related methods/properties) is due to matching the original intended purpose for the
+	 * option that got superseded by later behaviour requirements.
+	 */
+	const HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME = 'ee_has_activated_messenger';
+
+	/**
+	 * @type boolean $_initialized
+	 */
+	protected $_initialized = false;
+
+	/**
+	 * @type EE_Messenger_Collection $_messenger_collection_loader
+	 */
+	protected $_messenger_collection_loader;
+
+	/**
+	 * @type EE_Message_Type_Collection $_message_type_collection_loader
+	 */
+	protected $_message_type_collection_loader;
+
+	/**
+	 * @type EEM_Message_Template_Group $_message_template_group_model
+	 */
+	protected $_message_template_group_model;
+
+	/**
+	 * @type EE_messenger[]
+	 */
+	protected $_installed_messengers = array();
+
+	/**
+	 * @type EE_message_type[]
+	 */
+	protected $_installed_message_types = array();
+
+	/**
+	 * Array of active messengers.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => EE_messenger
+	 * )
+	 *
+	 * @type EE_messenger[]
+	 */
+	protected $_active_messengers = array();
+
+	/**
+	 * Formatted array of active message types grouped per messenger.
+	 * Format is this:
+	 * array(
+	 *      'messenger_name' => array(
+	 *          'settings' => array(
+	 *              '{messenger_name}-message_types' => array(
+	 *                  'message_type_name' => array() //variable array of settings corresponding to message type.
+	 *              )
+	 *          )
+	 *      )
+	 * )
+	 *
+	 * @type array
+	 */
+	protected $_active_message_types = array();
+
+
+	/**
+	 * This holds the array of messengers and their corresponding message types that have
+	 * been activated on a site at some point.  This is an important record that helps the messages system
+	 * not accidentally reactivate something that was intentionally deactivated by a user.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @type array
+	 */
+	protected $_has_activated_messengers_and_message_types = array();
+
+	/**
+	 * An array of unique message type contexts across all active message types.
+	 * The array will be indexed by either 'slugs' or 'all'.
+	 * The slugs index contains an array indexed by unique context slugs with the latest label representation for that
+	 * slug. array(
+	 *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
+	 * );
+	 * The all index returns an array in this format:
+	 * array(
+	 *      'message_type_name' => array(
+	 *          'context_slug' => array(
+	 *              'label' => 'localized label for context',
+	 *              'description' => 'localized description for context'
+	 *          )
+	 *      )
+	 * );
+	 *
+	 * @type array
+	 */
+	protected $_contexts = array();
+
+
+	/**
+	 * EE_Message_Resource_Manager constructor.
+	 *
+	 * @param \EE_Messenger_Collection_Loader    $Messenger_Collection_Loader
+	 * @param \EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader
+	 * @param \EEM_Message_Template_Group        $Message_Template_Group_Model
+	 */
+	function __construct(
+		EE_Messenger_Collection_Loader $Messenger_Collection_Loader,
+		EE_Message_Type_Collection_Loader $Message_Type_Collection_Loader,
+		EEM_Message_Template_Group $Message_Template_Group_Model
+	) {
+		$this->_messenger_collection_loader    = $Messenger_Collection_Loader;
+		$this->_message_type_collection_loader = $Message_Type_Collection_Loader;
+		$this->_message_template_group_model   = $Message_Template_Group_Model;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function _initialize_collections()
+	{
+		if ($this->_initialized) {
+			return;
+		}
+		$this->_initialized = true;
+		$this->_messenger_collection_loader->load_messengers_from_folder();
+		$this->_message_type_collection_loader->load_message_types_from_folder();
+		$this->get_has_activated_messengers_option(true);
+		$this->_set_active_messengers_and_message_types();
+	}
+
+
+	/**
+	 * @return EE_Messenger_Collection
+	 */
+	public function messenger_collection()
+	{
+		$this->_initialize_collections();
+		return $this->_messenger_collection_loader->messenger_collection();
+	}
+
+
+	/**
+	 * @return EE_messenger[]
+	 */
+	public function active_messengers()
+	{
+		$this->_initialize_collections();
+		return $this->_active_messengers;
+	}
+
+
+	/**
+	 * @param string $messenger_name
+	 * @return \EE_messenger
+	 */
+	public function get_messenger($messenger_name)
+	{
+		return $this->messenger_collection()->get_by_info($messenger_name);
+	}
+
+
+	/**
+	 * This returns the corresponding EE_messenger object for the given string if it is active.
+	 *
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_active_messenger($messenger)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_messengers[$messenger]) ? $this->_active_messengers[$messenger] : null;
+	}
+
+
+	/**
+	 * @return \EE_messenger[]
+	 */
+	public function installed_messengers()
+	{
+		if (empty($this->_installed_messengers)) {
+			$this->_installed_messengers = array();
+			$this->messenger_collection()->rewind();
+			while ($this->messenger_collection()->valid()) {
+				$this->_installed_messengers[$this->messenger_collection()->current()->name] = $this->messenger_collection()->current();
+				$this->messenger_collection()->next();
+			}
+		}
+		return $this->_installed_messengers;
+	}
+
+
+	/**
+	 * @param string $messenger_name
+	 * @return \EE_messenger
+	 * @throws \EE_Error
+	 */
+	public function valid_messenger($messenger_name)
+	{
+		$messenger = $this->get_messenger($messenger_name);
+		if ($messenger instanceof EE_messenger) {
+			return $messenger;
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The "%1$s" messenger is either invalid or not installed', 'event_espresso'),
+				$messenger_name
+			)
+		);
+	}
+
+
+	/**
+	 * @return EE_Message_Type_Collection
+	 */
+	public function message_type_collection()
+	{
+		$this->_initialize_collections();
+		return $this->_message_type_collection_loader->message_type_collection();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function active_message_types()
+	{
+		$this->_initialize_collections();
+		return $this->_active_message_types;
+	}
+
+
+	/**
+	 * @param string $message_type_name
+	 * @return \EE_message_type
+	 */
+	public function get_message_type($message_type_name)
+	{
+		return $this->message_type_collection()->get_by_info($message_type_name);
+	}
+
+
+	/**
+	 * This returns the EE_message_type from the active message types array ( if present );
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name
+	 * @return \EE_message_type|null
+	 */
+	public function get_active_message_type_for_messenger($messenger_name, $message_type_name)
+	{
+		return $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
+			? $this->get_message_type($message_type_name)
+			: null;
+	}
+
+
+	/**
+	 * Returns whether the given message type is active for the given messenger.
+	 *
+	 * @param string $messenger_name
+	 * @param string $message_type_name
+	 * @return bool
+	 */
+	public function is_message_type_active_for_messenger($messenger_name, $message_type_name)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]);
+	}
+
+
+	/**
+	 * Returns whether the given messenger is active.
+	 *
+	 * @param string $messenger_name the name of the messenger to check if active.
+	 * @return bool
+	 */
+	public function is_messenger_active($messenger_name)
+	{
+		$this->_initialize_collections();
+		return ! empty($this->_active_message_types[$messenger_name]);
+	}
+
+
+	/**
+	 * This returns any settings that might be on a message type for a messenger
+	 *
+	 * @param string $messenger_name    The slug of the messenger
+	 * @param string $message_type_name The slug of the message type getting the settings for.
+	 * @return array
+	 */
+	public function get_message_type_settings_for_messenger($messenger_name, $message_type_name)
+	{
+		$settings = array();
+		if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+			$settings = isset($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings'])
+				? $this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings']
+				: array();
+		}
+		return $settings;
+	}
+
+
+	/**
+	 * Returns whether the given messenger name has active message types on it.
+	 * Infers whether the messenger is active or not as well.
+	 *
+	 * @param string $messenger_name
+	 * @return bool
+	 */
+	public function messenger_has_active_message_types($messenger_name)
+	{
+		$this->_initialize_collections();
+		return
+			! empty($this->_active_message_types[$messenger_name])
+			&& ! empty($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types']);
+	}
+
+
+	/**
+	 * This checks the _active_message_types property for any active message types
+	 * that are present for the given messenger and returns them.
+	 *
+	 * @since 4.9.0
+	 * @param string $messenger_name The messenger being checked
+	 * @return EE_message_type[]|array    (empty array if no active_message_types)
+	 */
+	public function get_active_message_types_for_messenger($messenger_name)
+	{
+		$message_types = array();
+		if (! $this->messenger_has_active_message_types($messenger_name)) {
+			return $message_types;
+		}
+		$installed_message_types = $this->installed_message_types();
+		foreach ($installed_message_types as $message_type_name => $message_type) {
+			if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+				$message_types[$message_type_name] = $message_type;
+			}
+		}
+		return $message_types;
+	}
+
+
+	/**
+	 * This does NOT return the _active_message_types property but
+	 * simply returns an array of active message type names from that property.
+	 * (The _active_message_types property is indexed by messenger and active message_types per messenger).
+	 *
+	 * @return array message_type references (string)
+	 */
+	public function list_of_active_message_types()
+	{
+		$active_message_type_names = array();
+		$this->_initialize_collections();
+		foreach ($this->_active_message_types as $messenger => $messenger_settings) {
+			if (! isset($messenger_settings['settings'][$messenger . '-message_types'])) {
+				continue;
+			}
+			foreach ($messenger_settings['settings'][$messenger . '-message_types'] as $message_type_name => $message_type_config) {
+				if (! in_array($message_type_name, $active_message_type_names)) {
+					$active_message_type_names[] = $message_type_name;
+				}
+			}
+		}
+		return $active_message_type_names;
+	}
+
+
+	/**
+	 * Same as list_of_active_message_types() except this returns actual EE_message_type objects
+	 *
+	 * @since 4.9.0
+	 * @return \EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		$active_message_types      = array();
+		$installed_message_types   = $this->installed_message_types();
+		$active_message_type_names = $this->list_of_active_message_types();
+		foreach ($active_message_type_names as $active_message_type_name) {
+			if (isset($installed_message_types[$active_message_type_name])) {
+				$active_message_types[$active_message_type_name] = $installed_message_types[$active_message_type_name];
+			}
+		}
+		return $active_message_types;
+	}
+
+
+	/**
+	 * @return \EE_message_type[]
+	 */
+	public function installed_message_types()
+	{
+		if (empty($this->_installed_message_types)) {
+			$this->message_type_collection()->rewind();
+			while ($this->message_type_collection()->valid()) {
+				$this->_installed_message_types[$this->message_type_collection()->current()->name] = $this->message_type_collection()->current();
+				$this->message_type_collection()->next();
+			}
+		}
+		return $this->_installed_message_types;
+	}
+
+
+	/**
+	 * @param string $message_type_name
+	 * @return \EE_message_type
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type($message_type_name)
+	{
+		$message_type = $this->get_message_type($message_type_name);
+		if ($message_type instanceof EE_message_type) {
+			return $message_type;
+		}
+		throw new EE_Error(
+			sprintf(
+				__('The "%1$s" message type is either invalid or not installed', 'event_espresso'),
+				$message_type_name
+			)
+		);
+	}
+
+
+	/**
+	 * valid_message_type_for_messenger
+	 *
+	 * @param EE_messenger $messenger
+	 * @param string       $message_type_name
+	 * @return boolean
+	 * @throws \EE_Error
+	 */
+	public function valid_message_type_for_messenger(EE_messenger $messenger, $message_type_name)
+	{
+		$valid_message_types = $messenger->get_valid_message_types();
+		if (! in_array($message_type_name, $valid_message_types)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'The message type (%1$s) sent to "%2$s" is not valid for the "%3$s" messenger.  Double-check the spelling and verify that message type has been registered as a valid type with the messenger.',
+						'event_espresso'
+					),
+					$message_type_name,
+					__METHOD__,
+					$messenger->name
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * Used to return active messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 *
+	 * @param   bool $reset     If true then we ignore whether the option is cached on the _active_message_types
+	 *                          property and pull directly from the db.  Otherwise whatever is currently on the
+	 *                          $_active_message_types property is pulled.
+	 * @return array
+	 */
+	public function get_active_messengers_option($reset = false)
+	{
+		if ($reset) {
+			$this->_active_message_types = get_option('ee_active_messengers', array());
+		}
+		return $this->_active_message_types;
+	}
+
+
+	/**
+	 * Used to update the active messengers array stored in the wp options table.
+	 *
+	 * @param array $active_messenger_settings Incoming data to save.  If empty, then the internal cached property
+	 *                                         representing this data is used.
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public function update_active_messengers_option($active_messenger_settings = array())
+	{
+		$active_messenger_settings = empty($active_messenger_settings) ? $this->_active_message_types : $active_messenger_settings;
+		//make sure _active_message_types is updated (this is the internal cache for the settings).
+		$this->_active_message_types = $active_messenger_settings;
+		return update_option('ee_active_messengers', $active_messenger_settings);
+	}
+
+
+	/**
+	 * Used to return has activated message types for messengers array stored in the wp options table.
+	 * If no value is present in the option then an empty array is returned.
+	 * The value is cached on the $_has_activated_messengers_and_message_types property for future calls.
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param   bool $reset Used to indicate that any cached value should be ignored.
+	 * @return array
+	 */
+	public function get_has_activated_messengers_option($reset = false)
+	{
+		if ($reset || empty($this->_has_activated_messengers_and_message_types)) {
+			$this->_has_activated_messengers_and_message_types = get_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, array());
+		}
+		return $this->_has_activated_messengers_and_message_types;
+	}
+
+
+	/**
+	 * Used to update the has activated option in the db.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param array $has_activated_messengers Incoming data to save.  If empty, then the internal cached property
+	 *                                        representing this data is used.
+	 * @return bool FALSE if not updated, TRUE if updated.
+	 */
+	public function update_has_activated_messengers_option($has_activated_messengers = array())
+	{
+		//make sure the option has been retrieved from first so we don't overwrite it accidentally.
+		if (empty($has_activated_messengers) && empty($this->_has_activated_messengers_and_message_types)) {
+			$this->get_has_activated_messengers_option();
+		}
+		$has_activated_messengers = empty($has_activated_messengers)
+			? $this->_has_activated_messengers_and_message_types
+			: $has_activated_messengers;
+		return update_option(self::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME, $has_activated_messengers);
+	}
+
+
+	/**
+	 * wrapper for _set_active_messengers_and_message_types()
+	 */
+	public function reset_active_messengers_and_message_types()
+	{
+		$this->_set_active_messengers_and_message_types();
+	}
+
+
+	/**
+	 * Generate list of active messengers and message types from collection.
+	 * This sets up the active messengers from what is present in the database.
+	 */
+	protected function _set_active_messengers_and_message_types()
+	{
+		//echo "\n\n " . __LINE__ . ") " . __METHOD__ . "() \n";
+		// list of activated messengers as set via the admin
+		// note calling `get_active_messengers_options` also initializes the _active_message_types property.
+		$this->get_active_messengers_option(true);
+		$this->ensure_messengers_are_active(array(), false, true);
+		$this->update_active_messengers_option();
+		$this->update_has_activated_messengers_option();
+	}
+
+
+	/**
+	 * Ensures that the specified messenger is currently active.
+	 * If not, activates it and its default message types.
+	 *
+	 * @param string $messenger_name
+	 * @param bool   $update_option Whether to update the option in the db or not.
+	 * @return boolean true if either already active or successfully activated.
+	 */
+	public function ensure_messenger_is_active($messenger_name, $update_option = true)
+	{
+		if (! isset($this->_active_messengers[$messenger_name])) {
+			try {
+				$this->activate_messenger($messenger_name, array(), $update_option);
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					$e->getMessage(),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This ensures the given array of messenger names is active in the system.
+	 * Note, this method will not activate any NEW message types for the messenger when it is called. Instead,
+	 * it will automatically activate the default message types for the messenger if its not active.
+	 *
+	 * @param array $messenger_names  Array of messenger names for messengers to be activated.  If an empty array
+	 *                                (default) then will attempt to set the active messengers from the
+	 *                                activated_messengers option
+	 *                                (stored in $_active_message_types property).
+	 * @param bool  $update_option    Whether to update the related active messengers option.
+	 * @param bool  $verify           Whether to verify the messengers are installed before activating. Note if this is
+	 *                                set to true and a messenger is indicated as active, but is NOT installed, then it
+	 *                                will automatically be deactivated.
+	 */
+	public function ensure_messengers_are_active($messenger_names = array(), $update_option = true, $verify = false)
+	{
+		$messenger_names = empty($messenger_names) ? array_keys($this->_active_message_types) : $messenger_names;
+
+		$not_installed = array();
+		foreach ($messenger_names as $messenger_name) {
+			if ($verify && ! $this->messenger_collection()->has_by_name($messenger_name)) {
+				$not_installed[] = $messenger_name;
+				$this->deactivate_messenger($messenger_name);
+				continue;
+			}
+			$this->ensure_messenger_is_active($messenger_name, $update_option);
+		}
+
+		if (! empty($not_installed_messenger)) {
+			EE_Error::add_error(
+				sprintf(
+					__('The following messengers are either not installed or are invalid:%1$s %2$s', 'event_espresso'),
+					'<br />',
+					implode(', ', $not_installed_messenger)
+				),
+				__FILE__, __FUNCTION__, __LINE__
+			);
+		}
+	}
+
+
+	/**
+	 * Ensures that the specified message type for the given messenger is currently active, if not activates it.
+	 * This ALSO ensures that the given messenger is active as well!
+	 *
+	 * @param string $message_type_name message type name.
+	 * @param        $messenger_name
+	 * @param bool   $update_option     Whether to update the option in the db or not.
+	 * @return bool  Returns true if already is active or if was activated successfully.
+	 * @throws \EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type_name, $messenger_name, $update_option = true)
+	{
+		// grab the messenger to work with.
+		$messenger = $this->valid_messenger($messenger_name);
+		if ($this->valid_message_type_for_messenger($messenger, $message_type_name)) {
+			//ensure messenger is active (that's an inherent coupling between active message types and the
+			//messenger they are being activated for.
+			try {
+				if (! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+					//all is good so let's just get it active
+					$this->activate_messenger($messenger_name, array($message_type_name), $update_option);
+				}
+			} catch (EE_Error $e) {
+				EE_Error::add_error(
+					$e->getMessage(),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This is a wrapper for `ensure_message_type_is_active` that will handle ensuring multiple message types for a
+	 * messenger are active in one go.
+	 *
+	 * @param array  $message_type_names Array of message type names to ensure are active.
+	 * @param string $messenger_name     The name of the messenger that the message types are to be activated on.
+	 * @param bool   $update_option      Whether to persist the activation to the database or not (default true).
+	 */
+	public function ensure_message_types_are_active($message_type_names, $messenger_name, $update_option = true)
+	{
+		$message_type_names = (array)$message_type_names;
+		foreach ($message_type_names as $message_type_name) {
+			// note, intentionally not updating option here because we're in a loop.
+			// We'll follow the instructions of the incoming $update_option argument after the loop.
+			$this->ensure_message_type_is_active($message_type_name, $messenger_name, false);
+		}
+		if ($update_option) {
+			$this->update_active_messengers_option();
+			$this->update_has_activated_messengers_option();
+		}
+	}
+
+
+	/**
+	 * Activates the specified messenger.
+	 *
+	 * @param string $messenger_name
+	 * @param array  $message_type_names        An array of message type names to activate with this messenger.
+	 *                                          If included we do NOT setup the default message types
+	 *                                          (assuming they are already setup.)
+	 * @param bool   $update_active_messengers_option
+	 * @return array of generated templates
+	 * @throws \EE_Error
+	 */
+	public function activate_messenger(
+		$messenger_name,
+		$message_type_names = array(),
+		$update_active_messengers_option = true
+	) {
+		$templates = array();
+		// grab the messenger to work with.
+		$messenger = $this->messenger_collection()->get_by_info($messenger_name);
+		// it's inactive. Activate it.
+		if ($messenger instanceof EE_messenger) {
+			$this->_active_messengers[$messenger->name] = $messenger;
+			//activate incoming message types set to be activated with messenger.
+			$message_type_names = $this->_activate_message_types($messenger, $message_type_names);
+			// setup any initial settings for the messenger if necessary.
+			$this->add_settings_for_messenger($messenger->name);
+			if ($update_active_messengers_option) {
+				$this->update_active_messengers_option();
+				$this->update_has_activated_messengers_option();
+			}
+			//generate new templates if necessary and ensure all related templates that are already in the database are
+			//marked active.  Note, this will also deactivate a message type for a messenger if the template
+			//cannot be successfully created during its attempt (only happens for global template attempts).
+			if (! empty($message_type_names)) {
+				$templates = EEH_MSG_Template::generate_new_templates($messenger->name, $message_type_names, 0, true);
+				EEH_MSG_Template::update_to_active(array($messenger->name), $message_type_names);
+			}
+		}
+		return $templates;
+	}
+
+
+	/**
+	 * Activates given message types for the given EE_messenger object.
+	 * Note: (very important) This method does not persist the activation to the database.
+	 * See code implementing this method in this class for examples of how to persist.
+	 *
+	 * @param \EE_messenger $messenger
+	 * @param  array        $message_type_names
+	 * @return array
+	 */
+	protected function _activate_message_types(EE_messenger $messenger, $message_type_names = array())
+	{
+		//If $message_type_names is empty, AND $this->_active_message_types is empty, then that means
+		//things have never been initialized (which should happen on EEH_Activation::generate_message_templates).
+		//So ONLY then do we need to actually grab defaults and cycle through them.  Otherwise we
+		//only override _active_message_types when an explicit array of $message_type_names has been provided.
+		$message_type_names = empty($message_type_names) && ! isset($this->_active_message_types[$messenger->name])
+			? $messenger->get_default_message_types()
+			: (array)$message_type_names;
+
+		//now we ALWAYS need to make sure that the messenger is active for the message types we're activating!
+		if (! isset($this->_active_message_types[$messenger->name])) {
+			$this->_active_message_types[$messenger->name]['settings'] = array();
+		}
+
+		if ($message_type_names) {
+			// cycle thru message types
+			foreach ($message_type_names as $message_type_name) {
+				//only register the message type as active IF it isn't already active
+				//and if its actually installed.
+				if (
+				! $this->is_message_type_active_for_messenger($messenger->name, $message_type_name)
+				) {
+					$this->add_settings_for_message_type($messenger->name, $message_type_name);
+					$this->_set_messenger_has_activated_message_type(
+						$messenger,
+						$message_type_name
+					);
+				}
+			}
+		}
+		return $message_type_names;
+	}
+
+
+	/**
+	 * add_settings_for_message_type
+	 * NOTE This does NOT automatically persist any settings to the db.  Client code should call
+	 * $this->update_active_messengers_option to persist.
+	 *
+	 * @param  string $messenger_name    The name of the messenger adding the settings for
+	 * @param  string $message_type_name The name of the message type adding the settings for
+	 * @param  array  $new_settings      Any new settings being set for the message type and messenger
+	 */
+	public function add_settings_for_message_type($messenger_name, $message_type_name, $new_settings = array())
+	{
+		// get installed message type from collection
+		$message_type      = $this->message_type_collection()->get_by_info($message_type_name);
+		$existing_settings = $this->get_message_type_settings_for_messenger($messenger_name, $message_type_name);
+		//we need to setup any initial settings for message types
+		if ($message_type instanceof EE_message_type) {
+			$default_settings = $message_type->get_admin_settings_fields();
+			foreach ($default_settings as $field => $values) {
+				if (isset($new_settings[$field])) {
+					$existing_settings[$field] = $new_settings[$field];
+					continue;
+				}
+				if (! isset($existing_settings[$field])) {
+					$existing_settings[$field] = $values['default'];
+				}
+			}
+		}
+		$this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]['settings'] = $existing_settings;
+	}
+
+
+	/**
+	 * Updates the internal cached _has_activated_messengers_and_message_types property with the given messenger
+	 * and message type.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @access protected
+	 * @param \EE_messenger $messenger
+	 * @param string        $message_type_name
+	 */
+	protected function _set_messenger_has_activated_message_type(EE_messenger $messenger, $message_type_name)
+	{
+
+		//if _has_activated_messengers_and_message_types is empty then lets ensure its initialized
+		if (empty($this->_has_activated_messengers_and_message_types)) {
+			$this->get_has_activated_messengers_option();
+		}
+
+		// make sure this messenger has a record in the has_activated array
+		if (! isset($this->_has_activated_messengers_and_message_types[$messenger->name])) {
+			$this->_has_activated_messengers_and_message_types[$messenger->name] = array();
+		}
+		// check if message type has already been added
+		if (! in_array($message_type_name, $this->_has_activated_messengers_and_message_types[$messenger->name])) {
+			$this->_has_activated_messengers_and_message_types[$messenger->name][] = $message_type_name;
+		}
+	}
+
+
+	/**
+	 * add_settings_for_messenger
+	 * NOTE This does NOT automatically persist any settings to the db.  Client code should call
+	 * $this->update_active_messengers_option to persist.
+	 *
+	 * @param string $messenger_name The name of the messenger the settings is being added for.
+	 * @param array  $new_settings   An array of settings to update the existing settings.
+	 */
+	public function add_settings_for_messenger($messenger_name, $new_settings = array())
+	{
+		$messenger = $this->get_messenger($messenger_name);
+		if ($messenger instanceof EE_messenger) {
+			$msgr_settings = $messenger->get_admin_settings_fields();
+			if (! empty($msgr_settings)) {
+				foreach ($msgr_settings as $field => $value) {
+					//is there a new setting for this?
+					if (isset($new_settings[$field])) {
+						$this->_active_message_types[$messenger->name]['settings'][$field] = $new_settings[$field];
+						continue;
+					}
+					//only set the default if it isn't already set.
+					if (! isset($this->_active_message_types[$messenger->name]['settings'][$field])) {
+						$this->_active_message_types[$messenger->name]['settings'][$field] = $value;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * deactivate_messenger
+	 *
+	 * @param  string|EE_messenger $messenger_name name of messenger
+	 * @return void
+	 */
+	public function deactivate_messenger($messenger_name)
+	{
+		$this->_initialize_collections();
+		if ($messenger_name instanceof EE_messenger) {
+			$messenger_name = $messenger_name->name;
+		}
+		unset($this->_active_messengers[$messenger_name]);
+		unset($this->_active_message_types[$messenger_name]);
+		$this->_message_template_group_model->deactivate_message_template_groups_for($messenger_name);
+		$this->update_active_messengers_option();
+	}
+
+
+	/**
+	 * Deactivates a message type (note this will deactivate across all messenger's it is active on.
+	 *
+	 * @param  string $message_type_name     name of message type being deactivated
+	 * @param bool    $set_has_active_record By default we always record the has_active record when deactivating a message
+	 *                                       type.  However, this can be overridden if we don't want this set (usually when
+	 *                                       this is called as a part of deregistration of a custom message type)
+	 */
+	public function deactivate_message_type($message_type_name, $set_has_active_record = true)
+	{
+		$this->_initialize_collections();
+		if ($message_type_name instanceof EE_message_type) {
+			$message_type_name = $message_type_name->name;
+		}
+		foreach ($this->_active_message_types as $messenger_name => $settings) {
+			unset(
+				$this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]
+			);
+
+			//we always record (even on deactivation) that a message type has been activated because there should at
+			//least be a record in the "has_activated" option that it WAS active at one point.
+			if ($set_has_active_record) {
+				$messenger = $this->get_messenger($messenger_name);
+				$this->_set_messenger_has_activated_message_type($messenger, $message_type_name);
+			}
+		}
+		$this->_message_template_group_model->deactivate_message_template_groups_for('', $message_type_name);
+		$this->update_active_messengers_option();
+		$this->update_has_activated_messengers_option();
+	}
+
+
+	/**
+	 * Deactivates a message type for a specific messenger as opposed to all messengers.
+	 *
+	 * @param string $message_type_name Name of message type being deactivated.
+	 * @param string $messenger_name    Name of messenger the message type is being deactivated for.
+	 */
+	public function deactivate_message_type_for_messenger($message_type_name, $messenger_name)
+	{
+		$this->_initialize_collections();
+		if ($this->is_message_type_active_for_messenger($messenger_name, $message_type_name)) {
+			unset($this->_active_message_types[$messenger_name]['settings'][$messenger_name . '-message_types'][$message_type_name]);
+		}
+		$this->_message_template_group_model->deactivate_message_template_groups_for(array($messenger_name),
+			array($message_type_name));
+		$this->update_active_messengers_option();
+	}
+
+
+	/**
+	 * Used to verify if a message can be sent for the given messenger and message type
+	 * and that it is a generating messenger (used for generating message templates).
+	 *
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		//get the $messengers the message type says it can be used with.
+		foreach ($message_type->with_messengers() as $generating_messenger => $secondary_messengers) {
+			if (
+				$messenger->name === $generating_messenger
+				&& $this->is_message_type_active_for_messenger($messenger->name, $message_type->name)
+			) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * This returns all the contexts that are registered by all message types.
+	 * If $slugs_only is true,
+	 * then just an array indexed by unique context slugs with the latest label representation for that slug.
+	 * array(
+	 *      'context_slug' => 'localized label for context obtained from latest message type in the loop'.
+	 * );
+	 * If $slugs_only is false, then the format is:
+	 * array(
+	 *      'message_type_name' => array(
+	 *          'context_slug' => array(
+	 *              'label' => 'localized label for context',
+	 *              'description' => 'localized description for context'
+	 *          )
+	 *      )
+	 * );
+	 * Keep in mind that although different message types may share the same context slugs,
+	 * it is possible that the context is described differently by the message type.
+	 *
+	 * @since 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true)
+	 *                           or all contexts indexed by message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		$key = $slugs_only ? 'slugs' : 'all';
+		// check if contexts has been setup yet.
+		if (empty($this->_contexts[$key])) {
+			// So let's get all active message type objects and loop through to get all unique contexts
+			foreach ($this->get_active_message_type_objects() as $message_type) {
+				if ($message_type instanceof EE_message_type) {
+					$message_type_contexts = $message_type->get_contexts();
+					if ($slugs_only) {
+						foreach ($message_type_contexts as $context => $context_details) {
+							$this->_contexts[$key][$context] = $context_details['label'];
+						}
+					} else {
+						$this->_contexts[$key][$message_type->name] = $message_type_contexts;
+					}
+				}
+			}
+		}
+		return ! empty($this->_contexts[$key]) ? $this->_contexts[$key] : array();
+	}
+
+
+	/**
+	 * This checks the internal record of what message types are considered "active" and verifies that
+	 * there is an installed class definition for that message type.  If the active message type does not have a
+	 * corresponding accessible message type class then it will be deactivated from all messengers it is active on and
+	 * any related message templates will be inactivated as well.
+	 *
+	 * @return bool   true means all active message types are valid, false means at least one message type was
+	 *                deactivated.
+	 */
+	public function validate_active_message_types_are_installed()
+	{
+		$list_of_active_message_type_names = $this->list_of_active_message_types();
+		$installed_message_types           = $this->installed_message_types();
+		$all_message_types_valid           = true;
+		//loop through list of active message types and verify they are installed.
+		foreach ($list_of_active_message_type_names as $message_type_name) {
+			if (! isset($installed_message_types[$message_type_name])) {
+				$this->remove_message_type_has_been_activated_from_all_messengers(
+					$message_type_name,
+					true
+				);
+				$this->deactivate_message_type($message_type_name, false);
+				$all_message_types_valid = false;
+			}
+		}
+		return $all_message_types_valid;
+	}
+
+
+	/**
+	 * This method checks the `ee_has_activated_messenger` option to see if the message type has ever been
+	 * activated for the given messenger.  This can be called by client code on plugin updates etc to determine whether
+	 * to attempt automatically reactivating message types that should be activated by default or not.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param $message_type_name
+	 * @param $messenger_name
+	 * @return bool
+	 */
+	public function has_message_type_been_activated_for_messenger($message_type_name, $messenger_name)
+	{
+		$has_activated = $this->get_has_activated_messengers_option();
+		return isset($has_activated[$messenger_name])
+			   && in_array($message_type_name, $has_activated[$messenger_name]);
+	}
+
+
+	/**
+	 * This method unsets a message type from the given messenger has activated option.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param string $message_type_name
+	 * @param string $messenger_name
+	 * @param bool   $consider_current_state  Whether to consider whether the  message type is currently active or not.
+	 *                                        If it is currently active, then remove.  Otherwise leave it alone.
+	 */
+	public function remove_message_type_has_been_activated_for_messenger(
+		$message_type_name,
+		$messenger_name,
+		$consider_current_state = false
+	) {
+		if ($consider_current_state
+			&& ! $this->is_message_type_active_for_messenger($messenger_name, $message_type_name)
+		) {
+			//when consider current state is true, this means we don't want to change anything on the "has_activated"
+			//record if the message type is currently active for this messenger.  This is used when we want to retain
+			//the record for user initiated inactivations of the message type.
+			return;
+		}
+		$has_activated = $this->get_has_activated_messengers_option();
+		$key_for_message_type = isset($has_activated[$messenger_name])
+			? array_search($message_type_name, $has_activated[$messenger_name], true)
+			: false;
+		if ($key_for_message_type !== false) {
+			unset($has_activated[$messenger_name][$key_for_message_type]);
+			$this->update_has_activated_messengers_option($has_activated);
+			//reset the internal cached property
+			$this->get_has_activated_messengers_option(true);
+		}
+	}
+
+
+	/**
+	 * Removes a message type active record from all messengers it is attached to.
+	 *
+	 * @see phpdocs on EE_Message_Resource_Manager::HAS_ACTIVATED_MESSAGE_TYPE_FOR_MESSENGER_OPTION_NAME for more details.
+	 *
+	 * @param      $message_type_name
+	 * @param bool $consider_current_state  Whether to consider whether the  message type is currently active or not.
+	 *                                      If it is currently active, then remove.  Otherwise leave it alone.
+	 */
+	public function remove_message_type_has_been_activated_from_all_messengers(
+		$message_type_name,
+		$consider_current_state = false
+	) {
+		foreach(array_keys($this->get_has_activated_messengers_option()) as $messenger_name) {
+			$this->remove_message_type_has_been_activated_for_messenger(
+				$message_type_name,
+				$messenger_name,
+				$consider_current_state
+			);
+		}
+	}
 }
 // End of file EE_Message_Resource_Manager.lib.php
 // Location: /EE_Message_Resource_Manager.lib.php
\ No newline at end of file

core/services/formatters/Windows1252.php

Indentation +27 added lines, -27 removed lines

@@ -20,33 +20,33 @@
 class Windows1252 extends FormatterBase
 {
 
-    /**
-     * Converts the string to windows-1252 encoding.
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input)
-    {
-        //in case an int or float etc was passed in
-        $input = (string)$input;
-        if (function_exists('iconv')) {
-            $input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
-        } elseif ( WP_DEBUG) {
-            trigger_error(
-                sprintf(
-                    // @codingStandardsIgnoreStart
-                    esc_html__('%1$s could not format the string "%2$s" because the function "%3$s" does not exist. Please verify PHP is installed with this function, see %4$s', 'event_espresso'),
-                    // @codingStandardsIgnoreEnd
-                    get_class($this),
-                    $input,
-                    'iconv',
-                    '<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
-                )
-            );
-        }
-        return $input;
-    }
+	/**
+	 * Converts the string to windows-1252 encoding.
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input)
+	{
+		//in case an int or float etc was passed in
+		$input = (string)$input;
+		if (function_exists('iconv')) {
+			$input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
+		} elseif ( WP_DEBUG) {
+			trigger_error(
+				sprintf(
+					// @codingStandardsIgnoreStart
+					esc_html__('%1$s could not format the string "%2$s" because the function "%3$s" does not exist. Please verify PHP is installed with this function, see %4$s', 'event_espresso'),
+					// @codingStandardsIgnoreEnd
+					get_class($this),
+					$input,
+					'iconv',
+					'<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
+				)
+			);
+		}
+		return $input;
+	}
 }
 // End of file EmojiRemoval.php
 // Location: core\services\formatters/EmojiRemoval.php

Spacing +2 added lines, -2 removed lines

@@ -29,10 +29,10 @@
     public function format($input)
     {
         //in case an int or float etc was passed in
-        $input = (string)$input;
+        $input = (string) $input;
         if (function_exists('iconv')) {
             $input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
-        } elseif ( WP_DEBUG) {
+        } elseif (WP_DEBUG) {
             trigger_error(
                 sprintf(
                     // @codingStandardsIgnoreStart