eventespresso / event-espresso-core

core/domain/entities/routing/handlers/frontend/FrontendRequests.php

Indentation +39 added lines, -39 removed lines

@@ -15,47 +15,47 @@
  */
 class FrontendRequests extends PublicRoute
 {
-    /**
-     * returns true if the current request matches this route
-     * child classes can override and use Request directly to match route with request
-     * or supply a RouteMatchSpecification class and just use the below
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return ($this->request->isFrontend() || $this->request->isFrontAjax() || $this->request->isIframe())
-               && MaintenanceStatus::isDisabled();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 * child classes can override and use Request directly to match route with request
+	 * or supply a RouteMatchSpecification class and just use the below
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return ($this->request->isFrontend() || $this->request->isFrontAjax() || $this->request->isIframe())
+			   && MaintenanceStatus::isDisabled();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EE_Front_Controller',
-            [
-                'EE_Registry'                                     => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
-                'EE_Module_Request_Router'                        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EE_Front_Controller',
+			[
+				'EE_Registry'                                     => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\CurrentPage' => EE_Dependency_Map::load_from_cache,
+				'EE_Module_Request_Router'                        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-        $this->loader->getShared('EE_Front_Controller');
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+		$this->loader->getShared('EE_Front_Controller');
+		return true;
+	}
 }

core/admin/EE_Admin.core.php

Indentation +987 added lines, -987 removed lines

@@ -22,991 +22,991 @@
  */
 final class EE_Admin implements InterminableInterface
 {
-    private static ?EE_Admin $_instance = null;
-
-    private ?PersistentAdminNoticeManager $persistent_admin_notice_manager = null;
-
-    protected LoaderInterface $loader;
-
-    protected RequestInterface $request;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null  $loader
-     * @param RequestInterface|null $request
-     * @return EE_Admin|null
-     * @throws EE_Error
-     */
-    public static function instance(?LoaderInterface $loader = null, ?RequestInterface $request = null): ?EE_Admin
-    {
-        // check if class object is instantiated
-        if (! EE_Admin::$_instance instanceof EE_Admin) {
-            EE_Admin::$_instance = new EE_Admin($loader, $request);
-        }
-        return EE_Admin::$_instance;
-    }
-
-
-    /**
-     * @return EE_Admin|null
-     * @throws EE_Error
-     */
-    public static function reset(): ?EE_Admin
-    {
-        EE_Admin::$_instance = null;
-        $loader = LoaderFactory::getLoader();
-        $request = $loader->getShared('EventEspresso\core\services\request\Request');
-        return EE_Admin::instance($loader, $request);
-    }
-
-
-    /**
-     * @param LoaderInterface  $loader
-     * @param RequestInterface $request
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct(LoaderInterface $loader, RequestInterface $request)
-    {
-        $this->loader = $loader;
-        $this->request = $request;
-        // define global EE_Admin constants
-        $this->_define_all_constants();
-        // set autoloaders for our admin page classes based on included path information
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_ADMIN);
-        // reset Environment config (we only do this on admin page loads);
-        EE_Registry::instance()->CFG->environment->recheck_values();
-        // load EE_Request_Handler early
-        add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
-        add_action('admin_init', [$this, 'admin_init'], 100);
-        if (! $this->request->isAjax()) {
-            // admin hooks
-            add_action('admin_notices', [$this, 'display_admin_notices']);
-            add_action('network_admin_notices', [$this, 'display_admin_notices']);
-            add_filter('pre_update_option', [$this, 'check_for_invalid_datetime_formats'], 100, 2);
-            add_filter('plugin_action_links', [$this, 'filter_plugin_actions'], 10, 2);
-            add_filter('admin_footer_text', [$this, 'espresso_admin_footer']);
-            add_action('display_post_states', [$this, 'displayStateForCriticalPages'], 10, 2);
-            add_filter('plugin_row_meta', [$this, 'addLinksToPluginRowMeta'], 10, 2);
-        }
-        do_action('AHEE__EE_Admin__loaded');
-    }
-
-
-    /**
-     * _define_all_constants
-     * define constants that are set globally for all admin pages
-     *
-     * @return void
-     */
-    private function _define_all_constants()
-    {
-        if (! defined('EE_ADMIN_URL')) {
-            define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
-            define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
-            define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
-            define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
-            define('WP_AJAX_URL', admin_url('admin-ajax.php'));
-        }
-    }
-
-
-    /**
-     * filter_plugin_actions - adds links to the Plugins page listing
-     *
-     * @param array  $links
-     * @param string $plugin
-     * @return    array
-     */
-    public function filter_plugin_actions($links, $plugin)
-    {
-        // set $main_file in stone
-        static $main_file;
-        // if $main_file is not set yet
-        if (! $main_file) {
-            $main_file = EE_PLUGIN_BASENAME;
-        }
-        if ($plugin === $main_file) {
-            // compare current plugin to this one
-            if (MaintenanceStatus::isFullSite()) {
-                $maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
-                                    . ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
-                                    . esc_html__('Maintenance Mode Active', 'event_espresso')
-                                    . '</a>';
-                array_unshift($links, $maintenance_link);
-            } else {
-                $org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
-                                     . esc_html__('Settings', 'event_espresso')
-                                     . '</a>';
-                $events_link       = '<a href="admin.php?page=espresso_events">'
-                                     . esc_html__('Events', 'event_espresso')
-                                     . '</a>';
-                // add before other links
-                array_unshift($links, $org_settings_link, $events_link);
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * hide_admin_pages_except_maintenance_mode
-     *
-     * @param array $admin_page_folder_names
-     * @return array
-     */
-    public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
-    {
-        return [
-            'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
-            'about'       => EE_ADMIN_PAGES . 'about/',
-            'support'     => EE_ADMIN_PAGES . 'support/',
-        ];
-    }
-
-
-    /**
-     * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
-     * EE_Front_Controller's init phases have run
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws ServiceNotFoundException
-     */
-    public function init()
-    {
-        // only enable most of the EE_Admin IF we're not in full maintenance mode
-        if (DbStatus::isOnline()) {
-            $this->initModelsReady();
-        }
-        // run the admin page factory but ONLY if:
-        // - it is a regular non ajax admin request
-        // - we are doing an ee admin ajax request
-        if ($this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation()) {
-            try {
-                // this loads the controller for the admin pages which will setup routing etc
-                $admin_page_loader = $this->loader->getShared('EE_Admin_Page_Loader', [$this->loader]);
-                /** @var EE_Admin_Page_Loader $admin_page_loader */
-                $admin_page_loader->init();
-            } catch (EE_Error $e) {
-                $e->get_error();
-            }
-        }
-        if ($this->request->isAjax()) {
-            return;
-        }
-        add_filter('content_save_pre', [$this, 'its_eSpresso']);
-        // make sure our CPTs and custom taxonomy metaboxes get shown for first time users
-        add_action('admin_head', [$this, 'enable_hidden_ee_nav_menu_metaboxes']);
-        add_action('admin_head', [$this, 'register_custom_nav_menu_boxes']);
-        // exclude EE critical pages from all nav menus and wp_list_pages
-        add_filter('nav_menu_meta_box_object', [$this, 'remove_pages_from_nav_menu']);
-    }
-
-
-    /**
-     * Gets the loader (and if it wasn't previously set, sets it)
-     *
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function getLoader()
-    {
-        return $this->loader;
-    }
-
-
-    /**
-     * Method that's fired on admin requests (including admin ajax) but only when the models are usable
-     * (ie, the site isn't in maintenance mode)
-     *
-     * @return void
-     * @throws EE_Error
-     * @since 4.9.63.p
-     */
-    protected function initModelsReady()
-    {
-        // ok so we want to enable the entire admin
-        $this->persistent_admin_notice_manager = $this->loader->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        $this->persistent_admin_notice_manager->setReturnUrl(
-            EE_Admin_Page::add_query_args_and_nonce(
-                [
-                    'page'   => $this->request->getRequestParam('page', ''),
-                    'action' => $this->request->getRequestParam('action', ''),
-                ],
-                EE_ADMIN_URL
-            )
-        );
-        $this->maybeSetDatetimeWarningNotice();
-        // at a glance dashboard widget
-        add_filter('dashboard_glance_items', [$this, 'dashboard_glance_items']);
-        // filter for get_edit_post_link used on comments for custom post types
-        add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
-    }
-
-
-    /**
-     *    get_persistent_admin_notices
-     *
-     * @access    public
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function maybeSetDatetimeWarningNotice()
-    {
-        // add dismissible notice for datetime changes.  Only valid if site does not have a timezone_string set.
-        // @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
-        // with this.  But after enough time (indeterminate at this point) we can just remove this notice.
-        // this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
-        if (
-            apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
-            && ! get_option('timezone_string')
-            && EEM_Event::instance()->count() > 0
-        ) {
-            new PersistentAdminNotice(
-                'datetime_fix_notice',
-                sprintf(
-                    esc_html__(
-                        '%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
-                        'event_espresso'
-                    ),
-                    '<strong>',
-                    '</strong>',
-                    '<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
-                    '</a>',
-                    '<a href="' . EE_Admin_Page::add_query_args_and_nonce(
-                        [
-                            'page'   => 'espresso_maintenance_settings',
-                            'action' => 'datetime_tools',
-                        ],
-                        admin_url('admin.php')
-                    ) . '">'
-                ),
-                false,
-                'manage_options',
-                'datetime_fix_persistent_notice'
-            );
-        }
-    }
-
-
-    /**
-     * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
-     * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
-     * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
-     * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
-     * normal property on the post_type object.  It's found ONLY in this particular context.
-     *
-     * @param WP_Post $post_type WP post type object
-     * @return WP_Post
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function remove_pages_from_nav_menu($post_type)
-    {
-        // if this isn't the "pages" post type let's get out
-        if ($post_type->name !== 'page') {
-            return $post_type;
-        }
-        $critical_pages            = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-        $post_type->_default_query = [
-            'post__not_in' => $critical_pages,
-        ];
-        return $post_type;
-    }
-
-
-    /**
-     * WP by default only shows three metaboxes in "nav-menus.php" for first times users.
-     * We want to make sure our metaboxes get shown as well
-     *
-     * @return void
-     */
-    public function enable_hidden_ee_nav_menu_metaboxes()
-    {
-        global $wp_meta_boxes, $pagenow;
-        if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
-            return;
-        }
-        $user = wp_get_current_user();
-        // has this been done yet?
-        if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
-            return;
-        }
-
-        $hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
-        $initial_meta_boxes = apply_filters(
-            'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
-            [
-                'nav-menu-theme-locations',
-                'add-page',
-                'add-custom-links',
-                'add-category',
-                'add-espresso_events',
-                'add-espresso_venues',
-                'add-espresso_event_categories',
-                'add-espresso_venue_categories',
-                'add-post-type-post',
-                'add-post-type-page',
-            ]
-        );
-
-        if (is_array($hidden_meta_boxes)) {
-            foreach ($hidden_meta_boxes as $key => $meta_box_id) {
-                if (in_array($meta_box_id, $initial_meta_boxes, true)) {
-                    unset($hidden_meta_boxes[ $key ]);
-                }
-            }
-        }
-        update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
-        update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
-    }
-
-
-    /**
-     * This method simply registers custom nav menu boxes for "nav_menus.php route"
-     * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
-     *
-     * @return void
-     * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
-     *         addons etc.
-     */
-    public function register_custom_nav_menu_boxes()
-    {
-        add_meta_box(
-            'add-extra-nav-menu-pages',
-            esc_html__('Event Espresso Pages', 'event_espresso'),
-            [$this, 'ee_cpt_archive_pages'],
-            'nav-menus',
-            'side',
-            'core'
-        );
-        add_filter(
-            "postbox_classes_nav-menus_add-extra-nav-menu-pages",
-            function ($classes) {
-                $classes[] = 'ee-admin-container';
-                return $classes;
-            }
-        );
-    }
-
-
-    /**
-     * Use this to edit the post link for our cpts so that the edit link points to the correct page.
-     *
-     * @param string $link the original link generated by wp
-     * @param int    $id   post id
-     * @return string  the (maybe) modified link
-     * @since   4.3.0
-     */
-    public function modify_edit_post_link($link, $id)
-    {
-        if (! $post = get_post($id)) {
-            return $link;
-        }
-        if ($post->post_type === 'espresso_attendees') {
-            $query_args = [
-                'action' => 'edit_attendee',
-                'post'   => $id,
-            ];
-            return EEH_URL::add_query_args_and_nonce(
-                $query_args,
-                admin_url('admin.php?page=espresso_registrations')
-            );
-        }
-        return $link;
-    }
-
-
-    public function ee_cpt_archive_pages()
-    {
-        global $nav_menu_selected_id;
-        $removed_args = [
-            'action',
-            'customlink-tab',
-            'edit-menu-item',
-            'menu-item',
-            'page-tab',
-            '_wpnonce',
-        ];
-        $nav_tab_link = $nav_menu_selected_id
-            ? esc_url(
-                add_query_arg(
-                    'extra-nav-menu-pages-tab',
-                    'event-archives',
-                    remove_query_arg($removed_args)
-                )
-            )
-            : '';
-        $select_all_link = esc_url(
-            add_query_arg(
-                [
-                    'extra-nav-menu-pages-tab' => 'event-archives',
-                    'selectall'                => 1,
-                ],
-                remove_query_arg($removed_args)
-            )
-        );
-        $pages = $this->_get_extra_nav_menu_pages_items();
-        $args['walker'] = new Walker_Nav_Menu_Checklist(false);
-        $nav_menu_pages_items = walk_nav_menu_tree(
-            array_map(
-                [$this, '_setup_extra_nav_menu_pages_items'],
-                $pages
-            ),
-            0,
-            (object) $args
-        );
-        EEH_Template::display_template(
-            EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
-            [
-                'nav_menu_selected_id' => $nav_menu_selected_id,
-                'nav_menu_pages_items' => $nav_menu_pages_items,
-                'nav_tab_link'         => $nav_tab_link,
-                'select_all_link'      => $select_all_link,
-            ]
-        );
-    }
-
-
-    /**
-     * Returns an array of event archive nav items.
-     *
-     * @return array
-     * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
-     *        method we use for getting the extra nav menu items
-     */
-    private function _get_extra_nav_menu_pages_items()
-    {
-        $menuitems[] = [
-            'title'       => esc_html__('Event List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_events'),
-            'description' => esc_html__('Archive page for all events.', 'event_espresso'),
-        ];
-        return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
-    }
-
-
-    /**
-     * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
-     * the properties and converts it to the menu item object.
-     *
-     * @param $menu_item_values
-     * @return stdClass
-     * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
-     */
-    private function _setup_extra_nav_menu_pages_items($menu_item_values)
-    {
-        $menu_item = new stdClass();
-        $keys      = [
-            'ID'               => 0,
-            'db_id'            => 0,
-            'menu_item_parent' => 0,
-            'object_id'        => -1,
-            'post_parent'      => 0,
-            'type'             => 'custom',
-            'object'           => '',
-            'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
-            'title'            => '',
-            'url'              => '',
-            'target'           => '',
-            'attr_title'       => '',
-            'description'      => '',
-            'classes'          => [],
-            'xfn'              => '',
-        ];
-        foreach ($keys as $key => $value) {
-            $menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
-        }
-        return $menu_item;
-    }
-
-
-    /**
-     * admin_init
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function admin_init()
-    {
-        /**
-         * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
-         * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
-         * - check if doing post processing.
-         * - check if doing post processing of one of EE CPTs
-         * - instantiate the corresponding EE CPT model for the post_type being processed.
-         */
-        $action    = $this->request->getRequestParam('action');
-        $post_type = $this->request->getRequestParam('post_type');
-        if ($post_type && $action === 'editpost') {
-            /** @var CustomPostTypeDefinitions $custom_post_types */
-            $custom_post_types = $this->loader->getShared(CustomPostTypeDefinitions::class);
-            $custom_post_types->getCustomPostTypeModels($post_type);
-        }
-
-
-        if (! $this->request->isAjax()) {
-            /**
-             * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
-             * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
-             * Pages" tab in the EE General Settings Admin page.
-             * This is for user-proofing.
-             */
-            add_filter('wp_dropdown_pages', [$this, 'modify_dropdown_pages']);
-            if (DbStatus::isOnline()) {
-                $this->adminInitModelsReady();
-            }
-        }
-    }
-
-
-    /**
-     * Runs on admin_init but only if models are usable (ie, we're not in maintenance mode)
-     */
-    protected function adminInitModelsReady()
-    {
-        if (function_exists('wp_add_privacy_policy_content')) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
-        }
-    }
-
-
-    /**
-     * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
-     *
-     * @param string $output Current output.
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function modify_dropdown_pages($output)
-    {
-        // get critical pages
-        $critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
-
-        // split current output by line break for easier parsing.
-        $split_output = explode("\n", $output);
-
-        // loop through to remove any critical pages from the array.
-        foreach ($critical_pages as $page_id) {
-            $needle = 'value="' . $page_id . '"';
-            foreach ($split_output as $key => $haystack) {
-                if (strpos($haystack, $needle) !== false) {
-                    unset($split_output[ $key ]);
-                }
-            }
-        }
-        // replace output with the new contents
-        return implode("\n", $split_output);
-    }
-
-
-    /**
-     * display_admin_notices
-     *
-     * @return void
-     */
-    public function display_admin_notices()
-    {
-        echo EE_Error::get_notices(); // already escaped
-    }
-
-
-    /**
-     * @param array $elements
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function dashboard_glance_items($elements)
-    {
-        $elements                        = is_array($elements) ? $elements : [$elements];
-        $events                          = EEM_Event::instance()->count();
-        $items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
-            ['page' => 'espresso_events'],
-            admin_url('admin.php')
-        );
-        $items['events']['text']         = sprintf(
-            esc_html(
-                _n('%s Event', '%s Events', $events, 'event_espresso')
-            ),
-            number_format_i18n($events)
-        );
-        $items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
-        $registrations                   = EEM_Registration::instance()->count(
-            [
-                [
-                    'STS_ID' => ['!=', EEM_Registration::status_id_incomplete],
-                ],
-            ]
-        );
-        $items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
-            ['page' => 'espresso_registrations'],
-            admin_url('admin.php')
-        );
-        $items['registrations']['text']  = sprintf(
-            esc_html(
-                _n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
-            ),
-            number_format_i18n($registrations)
-        );
-        $items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
-
-        $items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
-
-        foreach ($items as $type => $item_properties) {
-            $elements[] = sprintf(
-                '<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
-                $item_properties['url'],
-                $item_properties['title'],
-                $item_properties['text']
-            );
-        }
-        return $elements;
-    }
-
-
-    /**
-     * check_for_invalid_datetime_formats
-     * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
-     * their selected format can be parsed by PHP
-     *
-     * @param    $value
-     * @param    $option
-     * @return    string
-     */
-    public function check_for_invalid_datetime_formats($value, $option)
-    {
-        // check for date_format or time_format
-        switch ($option) {
-            case 'date_format':
-                $date_time_format = $value . ' ' . get_option('time_format');
-                break;
-            case 'time_format':
-                $date_time_format = get_option('date_format') . ' ' . $value;
-                break;
-            default:
-                $date_time_format = false;
-        }
-        // do we have a date_time format to check ?
-        if ($date_time_format) {
-            $error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
-
-            if (is_array($error_msg)) {
-                $msg = '<p>'
-                       . sprintf(
-                           esc_html__(
-                               'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
-                               'event_espresso'
-                           ),
-                           date($date_time_format),
-                           $date_time_format
-                       )
-                       . '</p><p><ul>';
-
-
-                foreach ($error_msg as $error) {
-                    $msg .= '<li>' . $error . '</li>';
-                }
-
-                $msg .= '</ul></p><p>'
-                        . sprintf(
-                            esc_html__(
-                                '%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
-                                'event_espresso'
-                            ),
-                            '<span style="color:#D54E21;">',
-                            '</span>'
-                        )
-                        . '</p>';
-
-                // trigger WP settings error
-                add_settings_error(
-                    'date_format',
-                    'date_format',
-                    $msg
-                );
-
-                // set format to something valid
-                switch ($option) {
-                    case 'date_format':
-                        $value = 'F j, Y';
-                        break;
-                    case 'time_format':
-                        $value = 'g:i a';
-                        break;
-                }
-            }
-        }
-        return $value;
-    }
-
-
-    /**
-     * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
-     *
-     * @param $content
-     * @return    string
-     */
-    public function its_eSpresso($content)
-    {
-        return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
-    }
-
-
-    /**
-     * espresso_admin_footer
-     *
-     * @return    string
-     */
-    public function espresso_admin_footer()
-    {
-        return EEH_Template::powered_by_event_espresso('aln-cntr', '', ['utm_content' => 'admin_footer']);
-    }
-
-
-    /**
-     * Hooks into the "post states" filter in a wp post type list table.
-     *
-     * @param array   $post_states
-     * @param WP_Post $post
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function displayStateForCriticalPages($post_states, $post)
-    {
-        $post_states = (array) $post_states;
-        if (! $post instanceof WP_Post || $post->post_type !== 'page') {
-            return $post_states;
-        }
-        /** @var EE_Core_Config $config */
-        $config = $this->loader->getShared('EE_Config')->core;
-        if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
-            $post_states[] = sprintf(
-            /* Translators: Using company name - Event Espresso Critical Page */
-                esc_html__('%s Critical Page', 'event_espresso'),
-                'Event Espresso'
-            );
-        }
-        return $post_states;
-    }
-
-
-    /**
-     * Show documentation links on the plugins page
-     *
-     * @param mixed $meta Plugin Row Meta
-     * @param mixed $file Plugin Base file
-     * @return array
-     */
-    public function addLinksToPluginRowMeta($meta, $file)
-    {
-        if (EE_PLUGIN_BASENAME === $file) {
-            $row_meta = [
-                'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso documentation', 'event_espresso')
-                          . '">'
-                          . esc_html__('Docs', 'event_espresso')
-                          . '</a>',
-                'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
-                          . ' aria-label="'
-                          . esc_attr__('View Event Espresso API docs', 'event_espresso')
-                          . '">'
-                          . esc_html__('API docs', 'event_espresso')
-                          . '</a>',
-            ];
-            return array_merge($meta, $row_meta);
-        }
-        return (array) $meta;
-    }
-
-     /**************************************************************************************/
-     /************************************* DEPRECATED *************************************/
-     /**************************************************************************************/
-
-
-    /**
-     * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
-     * EE_Admin_Page route is called.
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-    }
-
-
-    /**
-     * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
-     *
-     * @return void
-     */
-    public function wp_loaded()
-    {
-    }
-
-
-    /**
-     * static method for registering ee admin page.
-     * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
-     *
-     * @param       $page_basename
-     * @param       $page_path
-     * @param array $config
-     * @return void
-     * @throws EE_Error
-     * @see        EE_Register_Admin_Page::register()
-     * @since      4.3.0
-     * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
-     */
-    public static function register_ee_admin_page($page_basename, $page_path, $config = [])
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
-                    'event_espresso'
-                ),
-                $page_basename
-            ),
-            '4.3'
-        );
-        if (class_exists('EE_Register_Admin_Page')) {
-            $config['page_path'] = $page_path;
-        }
-        EE_Register_Admin_Page::register($page_basename, $config);
-    }
-
-
-    /**
-     * @param int     $post_ID
-     * @param WP_Post $post
-     * @return void
-     * @deprecated 4.8.41
-     */
-    public static function parse_post_content_on_save($post_ID, $post)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @param  $option
-     * @param  $old_value
-     * @param  $value
-     * @return void
-     * @deprecated 4.8.41
-     */
-    public function reset_page_for_posts_on_change($option, $old_value, $value)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__('Usage is deprecated', 'event_espresso'),
-            '4.8.41'
-        );
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 4.9.27
-     */
-    public function get_persistent_admin_notices()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-    }
-
-
-    /**
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @deprecated 4.9.27
-     */
-    public function dismiss_ee_nag_notice_callback()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                '\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-            ),
-            '4.9.27'
-        );
-        $this->persistent_admin_notice_manager->dismissNotice();
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public function enqueue_admin_scripts()
-    {
-    }
-
-
-
-    /**
-     * @return RequestInterface
-     * @deprecated 5.0.0.p
-     */
-    public function get_request()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
-                'EventEspresso\core\services\request\Request'
-            ),
-            '5.0.0.p'
-        );
-        return $this->request;
-    }
-
-
-    /**
-     * @deprecated 5.0.0.p
-     */
-    public function hookIntoWpPluginsPage()
-    {
-    }
+	private static ?EE_Admin $_instance = null;
+
+	private ?PersistentAdminNoticeManager $persistent_admin_notice_manager = null;
+
+	protected LoaderInterface $loader;
+
+	protected RequestInterface $request;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null  $loader
+	 * @param RequestInterface|null $request
+	 * @return EE_Admin|null
+	 * @throws EE_Error
+	 */
+	public static function instance(?LoaderInterface $loader = null, ?RequestInterface $request = null): ?EE_Admin
+	{
+		// check if class object is instantiated
+		if (! EE_Admin::$_instance instanceof EE_Admin) {
+			EE_Admin::$_instance = new EE_Admin($loader, $request);
+		}
+		return EE_Admin::$_instance;
+	}
+
+
+	/**
+	 * @return EE_Admin|null
+	 * @throws EE_Error
+	 */
+	public static function reset(): ?EE_Admin
+	{
+		EE_Admin::$_instance = null;
+		$loader = LoaderFactory::getLoader();
+		$request = $loader->getShared('EventEspresso\core\services\request\Request');
+		return EE_Admin::instance($loader, $request);
+	}
+
+
+	/**
+	 * @param LoaderInterface  $loader
+	 * @param RequestInterface $request
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct(LoaderInterface $loader, RequestInterface $request)
+	{
+		$this->loader = $loader;
+		$this->request = $request;
+		// define global EE_Admin constants
+		$this->_define_all_constants();
+		// set autoloaders for our admin page classes based on included path information
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_ADMIN);
+		// reset Environment config (we only do this on admin page loads);
+		EE_Registry::instance()->CFG->environment->recheck_values();
+		// load EE_Request_Handler early
+		add_action('AHEE__EE_System__initialize_last', [$this, 'init']);
+		add_action('admin_init', [$this, 'admin_init'], 100);
+		if (! $this->request->isAjax()) {
+			// admin hooks
+			add_action('admin_notices', [$this, 'display_admin_notices']);
+			add_action('network_admin_notices', [$this, 'display_admin_notices']);
+			add_filter('pre_update_option', [$this, 'check_for_invalid_datetime_formats'], 100, 2);
+			add_filter('plugin_action_links', [$this, 'filter_plugin_actions'], 10, 2);
+			add_filter('admin_footer_text', [$this, 'espresso_admin_footer']);
+			add_action('display_post_states', [$this, 'displayStateForCriticalPages'], 10, 2);
+			add_filter('plugin_row_meta', [$this, 'addLinksToPluginRowMeta'], 10, 2);
+		}
+		do_action('AHEE__EE_Admin__loaded');
+	}
+
+
+	/**
+	 * _define_all_constants
+	 * define constants that are set globally for all admin pages
+	 *
+	 * @return void
+	 */
+	private function _define_all_constants()
+	{
+		if (! defined('EE_ADMIN_URL')) {
+			define('EE_ADMIN_URL', EE_PLUGIN_DIR_URL . 'core/admin/');
+			define('EE_ADMIN_PAGES_URL', EE_PLUGIN_DIR_URL . 'admin_pages/');
+			define('EE_ADMIN_TEMPLATE', EE_ADMIN . 'templates/');
+			define('WP_ADMIN_PATH', ABSPATH . 'wp-admin/');
+			define('WP_AJAX_URL', admin_url('admin-ajax.php'));
+		}
+	}
+
+
+	/**
+	 * filter_plugin_actions - adds links to the Plugins page listing
+	 *
+	 * @param array  $links
+	 * @param string $plugin
+	 * @return    array
+	 */
+	public function filter_plugin_actions($links, $plugin)
+	{
+		// set $main_file in stone
+		static $main_file;
+		// if $main_file is not set yet
+		if (! $main_file) {
+			$main_file = EE_PLUGIN_BASENAME;
+		}
+		if ($plugin === $main_file) {
+			// compare current plugin to this one
+			if (MaintenanceStatus::isFullSite()) {
+				$maintenance_link = '<a href="admin.php?page=espresso_maintenance_settings"'
+									. ' title="Event Espresso is in maintenance mode.  Click this link to learn why.">'
+									. esc_html__('Maintenance Mode Active', 'event_espresso')
+									. '</a>';
+				array_unshift($links, $maintenance_link);
+			} else {
+				$org_settings_link = '<a href="admin.php?page=espresso_general_settings">'
+									 . esc_html__('Settings', 'event_espresso')
+									 . '</a>';
+				$events_link       = '<a href="admin.php?page=espresso_events">'
+									 . esc_html__('Events', 'event_espresso')
+									 . '</a>';
+				// add before other links
+				array_unshift($links, $org_settings_link, $events_link);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * hide_admin_pages_except_maintenance_mode
+	 *
+	 * @param array $admin_page_folder_names
+	 * @return array
+	 */
+	public function hide_admin_pages_except_maintenance_mode($admin_page_folder_names = [])
+	{
+		return [
+			'maintenance' => EE_ADMIN_PAGES . 'maintenance/',
+			'about'       => EE_ADMIN_PAGES . 'about/',
+			'support'     => EE_ADMIN_PAGES . 'support/',
+		];
+	}
+
+
+	/**
+	 * init- should fire after shortcode, module,  addon, other plugin (default priority), and even
+	 * EE_Front_Controller's init phases have run
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws ServiceNotFoundException
+	 */
+	public function init()
+	{
+		// only enable most of the EE_Admin IF we're not in full maintenance mode
+		if (DbStatus::isOnline()) {
+			$this->initModelsReady();
+		}
+		// run the admin page factory but ONLY if:
+		// - it is a regular non ajax admin request
+		// - we are doing an ee admin ajax request
+		if ($this->request->isAdmin() || $this->request->isAdminAjax() || $this->request->isActivation()) {
+			try {
+				// this loads the controller for the admin pages which will setup routing etc
+				$admin_page_loader = $this->loader->getShared('EE_Admin_Page_Loader', [$this->loader]);
+				/** @var EE_Admin_Page_Loader $admin_page_loader */
+				$admin_page_loader->init();
+			} catch (EE_Error $e) {
+				$e->get_error();
+			}
+		}
+		if ($this->request->isAjax()) {
+			return;
+		}
+		add_filter('content_save_pre', [$this, 'its_eSpresso']);
+		// make sure our CPTs and custom taxonomy metaboxes get shown for first time users
+		add_action('admin_head', [$this, 'enable_hidden_ee_nav_menu_metaboxes']);
+		add_action('admin_head', [$this, 'register_custom_nav_menu_boxes']);
+		// exclude EE critical pages from all nav menus and wp_list_pages
+		add_filter('nav_menu_meta_box_object', [$this, 'remove_pages_from_nav_menu']);
+	}
+
+
+	/**
+	 * Gets the loader (and if it wasn't previously set, sets it)
+	 *
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function getLoader()
+	{
+		return $this->loader;
+	}
+
+
+	/**
+	 * Method that's fired on admin requests (including admin ajax) but only when the models are usable
+	 * (ie, the site isn't in maintenance mode)
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @since 4.9.63.p
+	 */
+	protected function initModelsReady()
+	{
+		// ok so we want to enable the entire admin
+		$this->persistent_admin_notice_manager = $this->loader->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		$this->persistent_admin_notice_manager->setReturnUrl(
+			EE_Admin_Page::add_query_args_and_nonce(
+				[
+					'page'   => $this->request->getRequestParam('page', ''),
+					'action' => $this->request->getRequestParam('action', ''),
+				],
+				EE_ADMIN_URL
+			)
+		);
+		$this->maybeSetDatetimeWarningNotice();
+		// at a glance dashboard widget
+		add_filter('dashboard_glance_items', [$this, 'dashboard_glance_items']);
+		// filter for get_edit_post_link used on comments for custom post types
+		add_filter('get_edit_post_link', [$this, 'modify_edit_post_link'], 10, 2);
+	}
+
+
+	/**
+	 *    get_persistent_admin_notices
+	 *
+	 * @access    public
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function maybeSetDatetimeWarningNotice()
+	{
+		// add dismissible notice for datetime changes.  Only valid if site does not have a timezone_string set.
+		// @todo This needs to stay in core for a bit to catch anyone upgrading from a version without this to a version
+		// with this.  But after enough time (indeterminate at this point) we can just remove this notice.
+		// this was added with https://events.codebasehq.com/projects/event-espresso/tickets/10626
+		if (
+			apply_filters('FHEE__EE_Admin__maybeSetDatetimeWarningNotice', true)
+			&& ! get_option('timezone_string')
+			&& EEM_Event::instance()->count() > 0
+		) {
+			new PersistentAdminNotice(
+				'datetime_fix_notice',
+				sprintf(
+					esc_html__(
+						'%1$sImportant announcement related to your install of Event Espresso%2$s: There are some changes made to your site that could affect how dates display for your events and other related items with dates and times.  Read more about it %3$shere%4$s. If your dates and times are displaying incorrectly (incorrect offset), you can fix it using the tool on %5$sthis page%4$s.',
+						'event_espresso'
+					),
+					'<strong>',
+					'</strong>',
+					'<a href="https://eventespresso.com/2017/08/important-upcoming-changes-dates-times">',
+					'</a>',
+					'<a href="' . EE_Admin_Page::add_query_args_and_nonce(
+						[
+							'page'   => 'espresso_maintenance_settings',
+							'action' => 'datetime_tools',
+						],
+						admin_url('admin.php')
+					) . '">'
+				),
+				false,
+				'manage_options',
+				'datetime_fix_persistent_notice'
+			);
+		}
+	}
+
+
+	/**
+	 * this simply hooks into the nav menu setup of pages metabox and makes sure that we remove EE critical pages from
+	 * the list of options. the wp function "wp_nav_menu_item_post_type_meta_box" found in
+	 * wp-admin/includes/nav-menu.php looks for the "_default_query" property on the post_type object and it uses that
+	 * to override any queries found in the existing query for the given post type.  Note that _default_query is not a
+	 * normal property on the post_type object.  It's found ONLY in this particular context.
+	 *
+	 * @param WP_Post $post_type WP post type object
+	 * @return WP_Post
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function remove_pages_from_nav_menu($post_type)
+	{
+		// if this isn't the "pages" post type let's get out
+		if ($post_type->name !== 'page') {
+			return $post_type;
+		}
+		$critical_pages            = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+		$post_type->_default_query = [
+			'post__not_in' => $critical_pages,
+		];
+		return $post_type;
+	}
+
+
+	/**
+	 * WP by default only shows three metaboxes in "nav-menus.php" for first times users.
+	 * We want to make sure our metaboxes get shown as well
+	 *
+	 * @return void
+	 */
+	public function enable_hidden_ee_nav_menu_metaboxes()
+	{
+		global $wp_meta_boxes, $pagenow;
+		if (! is_array($wp_meta_boxes) || $pagenow !== 'nav-menus.php') {
+			return;
+		}
+		$user = wp_get_current_user();
+		// has this been done yet?
+		if (get_user_option('ee_nav_menu_initialized', $user->ID)) {
+			return;
+		}
+
+		$hidden_meta_boxes  = get_user_option('metaboxhidden_nav-menus', $user->ID);
+		$initial_meta_boxes = apply_filters(
+			'FHEE__EE_Admin__enable_hidden_ee_nav_menu_boxes__initial_meta_boxes',
+			[
+				'nav-menu-theme-locations',
+				'add-page',
+				'add-custom-links',
+				'add-category',
+				'add-espresso_events',
+				'add-espresso_venues',
+				'add-espresso_event_categories',
+				'add-espresso_venue_categories',
+				'add-post-type-post',
+				'add-post-type-page',
+			]
+		);
+
+		if (is_array($hidden_meta_boxes)) {
+			foreach ($hidden_meta_boxes as $key => $meta_box_id) {
+				if (in_array($meta_box_id, $initial_meta_boxes, true)) {
+					unset($hidden_meta_boxes[ $key ]);
+				}
+			}
+		}
+		update_user_option($user->ID, 'metaboxhidden_nav-menus', $hidden_meta_boxes, true);
+		update_user_option($user->ID, 'ee_nav_menu_initialized', 1, true);
+	}
+
+
+	/**
+	 * This method simply registers custom nav menu boxes for "nav_menus.php route"
+	 * Currently EE is using this to make sure there are menu options for our CPT archive page routes.
+	 *
+	 * @return void
+	 * @todo   modify this so its more dynamic and automatic for all ee CPTs and setups and can also be hooked into by
+	 *         addons etc.
+	 */
+	public function register_custom_nav_menu_boxes()
+	{
+		add_meta_box(
+			'add-extra-nav-menu-pages',
+			esc_html__('Event Espresso Pages', 'event_espresso'),
+			[$this, 'ee_cpt_archive_pages'],
+			'nav-menus',
+			'side',
+			'core'
+		);
+		add_filter(
+			"postbox_classes_nav-menus_add-extra-nav-menu-pages",
+			function ($classes) {
+				$classes[] = 'ee-admin-container';
+				return $classes;
+			}
+		);
+	}
+
+
+	/**
+	 * Use this to edit the post link for our cpts so that the edit link points to the correct page.
+	 *
+	 * @param string $link the original link generated by wp
+	 * @param int    $id   post id
+	 * @return string  the (maybe) modified link
+	 * @since   4.3.0
+	 */
+	public function modify_edit_post_link($link, $id)
+	{
+		if (! $post = get_post($id)) {
+			return $link;
+		}
+		if ($post->post_type === 'espresso_attendees') {
+			$query_args = [
+				'action' => 'edit_attendee',
+				'post'   => $id,
+			];
+			return EEH_URL::add_query_args_and_nonce(
+				$query_args,
+				admin_url('admin.php?page=espresso_registrations')
+			);
+		}
+		return $link;
+	}
+
+
+	public function ee_cpt_archive_pages()
+	{
+		global $nav_menu_selected_id;
+		$removed_args = [
+			'action',
+			'customlink-tab',
+			'edit-menu-item',
+			'menu-item',
+			'page-tab',
+			'_wpnonce',
+		];
+		$nav_tab_link = $nav_menu_selected_id
+			? esc_url(
+				add_query_arg(
+					'extra-nav-menu-pages-tab',
+					'event-archives',
+					remove_query_arg($removed_args)
+				)
+			)
+			: '';
+		$select_all_link = esc_url(
+			add_query_arg(
+				[
+					'extra-nav-menu-pages-tab' => 'event-archives',
+					'selectall'                => 1,
+				],
+				remove_query_arg($removed_args)
+			)
+		);
+		$pages = $this->_get_extra_nav_menu_pages_items();
+		$args['walker'] = new Walker_Nav_Menu_Checklist(false);
+		$nav_menu_pages_items = walk_nav_menu_tree(
+			array_map(
+				[$this, '_setup_extra_nav_menu_pages_items'],
+				$pages
+			),
+			0,
+			(object) $args
+		);
+		EEH_Template::display_template(
+			EE_ADMIN_TEMPLATE . 'cpt_archive_page.template.php',
+			[
+				'nav_menu_selected_id' => $nav_menu_selected_id,
+				'nav_menu_pages_items' => $nav_menu_pages_items,
+				'nav_tab_link'         => $nav_tab_link,
+				'select_all_link'      => $select_all_link,
+			]
+		);
+	}
+
+
+	/**
+	 * Returns an array of event archive nav items.
+	 *
+	 * @return array
+	 * @todo  for now this method is just in place so when it gets abstracted further we can substitute in whatever
+	 *        method we use for getting the extra nav menu items
+	 */
+	private function _get_extra_nav_menu_pages_items()
+	{
+		$menuitems[] = [
+			'title'       => esc_html__('Event List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_events'),
+			'description' => esc_html__('Archive page for all events.', 'event_espresso'),
+		];
+		return apply_filters('FHEE__EE_Admin__get_extra_nav_menu_pages_items', $menuitems);
+	}
+
+
+	/**
+	 * Setup nav menu walker item for usage in the event archive nav menu metabox.  It receives a menu_item array with
+	 * the properties and converts it to the menu item object.
+	 *
+	 * @param $menu_item_values
+	 * @return stdClass
+	 * @see wp_setup_nav_menu_item() in wp-includes/nav-menu.php
+	 */
+	private function _setup_extra_nav_menu_pages_items($menu_item_values)
+	{
+		$menu_item = new stdClass();
+		$keys      = [
+			'ID'               => 0,
+			'db_id'            => 0,
+			'menu_item_parent' => 0,
+			'object_id'        => -1,
+			'post_parent'      => 0,
+			'type'             => 'custom',
+			'object'           => '',
+			'type_label'       => esc_html__('Extra Nav Menu Item', 'event_espresso'),
+			'title'            => '',
+			'url'              => '',
+			'target'           => '',
+			'attr_title'       => '',
+			'description'      => '',
+			'classes'          => [],
+			'xfn'              => '',
+		];
+		foreach ($keys as $key => $value) {
+			$menu_item->{$key} = $menu_item_values[ $key ] ?? $value;
+		}
+		return $menu_item;
+	}
+
+
+	/**
+	 * admin_init
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function admin_init()
+	{
+		/**
+		 * our cpt models must be instantiated on WordPress post processing routes (wp-admin/post.php),
+		 * so any hooking into core WP routes is taken care of.  So in this next few lines of code:
+		 * - check if doing post processing.
+		 * - check if doing post processing of one of EE CPTs
+		 * - instantiate the corresponding EE CPT model for the post_type being processed.
+		 */
+		$action    = $this->request->getRequestParam('action');
+		$post_type = $this->request->getRequestParam('post_type');
+		if ($post_type && $action === 'editpost') {
+			/** @var CustomPostTypeDefinitions $custom_post_types */
+			$custom_post_types = $this->loader->getShared(CustomPostTypeDefinitions::class);
+			$custom_post_types->getCustomPostTypeModels($post_type);
+		}
+
+
+		if (! $this->request->isAjax()) {
+			/**
+			 * This code excludes EE critical pages anywhere `wp_dropdown_pages` is used to create a dropdown for selecting
+			 * critical pages.  The only place critical pages need included in a generated dropdown is on the "Critical
+			 * Pages" tab in the EE General Settings Admin page.
+			 * This is for user-proofing.
+			 */
+			add_filter('wp_dropdown_pages', [$this, 'modify_dropdown_pages']);
+			if (DbStatus::isOnline()) {
+				$this->adminInitModelsReady();
+			}
+		}
+	}
+
+
+	/**
+	 * Runs on admin_init but only if models are usable (ie, we're not in maintenance mode)
+	 */
+	protected function adminInitModelsReady()
+	{
+		if (function_exists('wp_add_privacy_policy_content')) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\policy\PrivacyPolicyManager');
+		}
+	}
+
+
+	/**
+	 * Callback for wp_dropdown_pages hook to remove ee critical pages from the dropdown selection.
+	 *
+	 * @param string $output Current output.
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function modify_dropdown_pages($output)
+	{
+		// get critical pages
+		$critical_pages = EE_Registry::instance()->CFG->core->get_critical_pages_array();
+
+		// split current output by line break for easier parsing.
+		$split_output = explode("\n", $output);
+
+		// loop through to remove any critical pages from the array.
+		foreach ($critical_pages as $page_id) {
+			$needle = 'value="' . $page_id . '"';
+			foreach ($split_output as $key => $haystack) {
+				if (strpos($haystack, $needle) !== false) {
+					unset($split_output[ $key ]);
+				}
+			}
+		}
+		// replace output with the new contents
+		return implode("\n", $split_output);
+	}
+
+
+	/**
+	 * display_admin_notices
+	 *
+	 * @return void
+	 */
+	public function display_admin_notices()
+	{
+		echo EE_Error::get_notices(); // already escaped
+	}
+
+
+	/**
+	 * @param array $elements
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function dashboard_glance_items($elements)
+	{
+		$elements                        = is_array($elements) ? $elements : [$elements];
+		$events                          = EEM_Event::instance()->count();
+		$items['events']['url']          = EE_Admin_Page::add_query_args_and_nonce(
+			['page' => 'espresso_events'],
+			admin_url('admin.php')
+		);
+		$items['events']['text']         = sprintf(
+			esc_html(
+				_n('%s Event', '%s Events', $events, 'event_espresso')
+			),
+			number_format_i18n($events)
+		);
+		$items['events']['title']        = esc_html__('Click to view all Events', 'event_espresso');
+		$registrations                   = EEM_Registration::instance()->count(
+			[
+				[
+					'STS_ID' => ['!=', EEM_Registration::status_id_incomplete],
+				],
+			]
+		);
+		$items['registrations']['url']   = EE_Admin_Page::add_query_args_and_nonce(
+			['page' => 'espresso_registrations'],
+			admin_url('admin.php')
+		);
+		$items['registrations']['text']  = sprintf(
+			esc_html(
+				_n('%s Registration', '%s Registrations', $registrations, 'event_espresso')
+			),
+			number_format_i18n($registrations)
+		);
+		$items['registrations']['title'] = esc_html__('Click to view all registrations', 'event_espresso');
+
+		$items = (array) apply_filters('FHEE__EE_Admin__dashboard_glance_items__items', $items);
+
+		foreach ($items as $type => $item_properties) {
+			$elements[] = sprintf(
+				'<a class="ee-dashboard-link-' . $type . '" href="%s" title="%s">%s</a>',
+				$item_properties['url'],
+				$item_properties['title'],
+				$item_properties['text']
+			);
+		}
+		return $elements;
+	}
+
+
+	/**
+	 * check_for_invalid_datetime_formats
+	 * if an admin changes their date or time format settings on the WP General Settings admin page, verify that
+	 * their selected format can be parsed by PHP
+	 *
+	 * @param    $value
+	 * @param    $option
+	 * @return    string
+	 */
+	public function check_for_invalid_datetime_formats($value, $option)
+	{
+		// check for date_format or time_format
+		switch ($option) {
+			case 'date_format':
+				$date_time_format = $value . ' ' . get_option('time_format');
+				break;
+			case 'time_format':
+				$date_time_format = get_option('date_format') . ' ' . $value;
+				break;
+			default:
+				$date_time_format = false;
+		}
+		// do we have a date_time format to check ?
+		if ($date_time_format) {
+			$error_msg = EEH_DTT_Helper::validate_format_string($date_time_format);
+
+			if (is_array($error_msg)) {
+				$msg = '<p>'
+					   . sprintf(
+						   esc_html__(
+							   'The following date time "%s" ( %s ) is difficult to be properly parsed by PHP for the following reasons:',
+							   'event_espresso'
+						   ),
+						   date($date_time_format),
+						   $date_time_format
+					   )
+					   . '</p><p><ul>';
+
+
+				foreach ($error_msg as $error) {
+					$msg .= '<li>' . $error . '</li>';
+				}
+
+				$msg .= '</ul></p><p>'
+						. sprintf(
+							esc_html__(
+								'%sPlease note that your date and time formats have been reset to "F j, Y" and "g:i a" respectively.%s',
+								'event_espresso'
+							),
+							'<span style="color:#D54E21;">',
+							'</span>'
+						)
+						. '</p>';
+
+				// trigger WP settings error
+				add_settings_error(
+					'date_format',
+					'date_format',
+					$msg
+				);
+
+				// set format to something valid
+				switch ($option) {
+					case 'date_format':
+						$value = 'F j, Y';
+						break;
+					case 'time_format':
+						$value = 'g:i a';
+						break;
+				}
+			}
+		}
+		return $value;
+	}
+
+
+	/**
+	 * its_eSpresso - converts the less commonly used spelling of "Expresso" to "Espresso"
+	 *
+	 * @param $content
+	 * @return    string
+	 */
+	public function its_eSpresso($content)
+	{
+		return str_replace('[EXPRESSO_', '[ESPRESSO_', $content);
+	}
+
+
+	/**
+	 * espresso_admin_footer
+	 *
+	 * @return    string
+	 */
+	public function espresso_admin_footer()
+	{
+		return EEH_Template::powered_by_event_espresso('aln-cntr', '', ['utm_content' => 'admin_footer']);
+	}
+
+
+	/**
+	 * Hooks into the "post states" filter in a wp post type list table.
+	 *
+	 * @param array   $post_states
+	 * @param WP_Post $post
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function displayStateForCriticalPages($post_states, $post)
+	{
+		$post_states = (array) $post_states;
+		if (! $post instanceof WP_Post || $post->post_type !== 'page') {
+			return $post_states;
+		}
+		/** @var EE_Core_Config $config */
+		$config = $this->loader->getShared('EE_Config')->core;
+		if (in_array($post->ID, $config->get_critical_pages_array(), true)) {
+			$post_states[] = sprintf(
+			/* Translators: Using company name - Event Espresso Critical Page */
+				esc_html__('%s Critical Page', 'event_espresso'),
+				'Event Espresso'
+			);
+		}
+		return $post_states;
+	}
+
+
+	/**
+	 * Show documentation links on the plugins page
+	 *
+	 * @param mixed $meta Plugin Row Meta
+	 * @param mixed $file Plugin Base file
+	 * @return array
+	 */
+	public function addLinksToPluginRowMeta($meta, $file)
+	{
+		if (EE_PLUGIN_BASENAME === $file) {
+			$row_meta = [
+				'docs' => '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso documentation', 'event_espresso')
+						  . '">'
+						  . esc_html__('Docs', 'event_espresso')
+						  . '</a>',
+				'api'  => '<a href="https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API"'
+						  . ' aria-label="'
+						  . esc_attr__('View Event Espresso API docs', 'event_espresso')
+						  . '">'
+						  . esc_html__('API docs', 'event_espresso')
+						  . '</a>',
+			];
+			return array_merge($meta, $row_meta);
+		}
+		return (array) $meta;
+	}
+
+	 /**************************************************************************************/
+	 /************************************* DEPRECATED *************************************/
+	 /**************************************************************************************/
+
+
+	/**
+	 * This is the action hook for the AHEE__EE_Admin_Page__route_admin_request hook that fires off right before an
+	 * EE_Admin_Page route is called.
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+	}
+
+
+	/**
+	 * wp_loaded should fire on the WordPress wp_loaded hook.  This fires on a VERY late priority.
+	 *
+	 * @return void
+	 */
+	public function wp_loaded()
+	{
+	}
+
+
+	/**
+	 * static method for registering ee admin page.
+	 * This method is deprecated in favor of the new location in EE_Register_Admin_Page::register.
+	 *
+	 * @param       $page_basename
+	 * @param       $page_path
+	 * @param array $config
+	 * @return void
+	 * @throws EE_Error
+	 * @see        EE_Register_Admin_Page::register()
+	 * @since      4.3.0
+	 * @deprecated 4.3.0    Use EE_Register_Admin_Page::register() instead
+	 */
+	public static function register_ee_admin_page($page_basename, $page_path, $config = [])
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'Usage is deprecated.  Use EE_Register_Admin_Page::register() for registering the %s admin page.',
+					'event_espresso'
+				),
+				$page_basename
+			),
+			'4.3'
+		);
+		if (class_exists('EE_Register_Admin_Page')) {
+			$config['page_path'] = $page_path;
+		}
+		EE_Register_Admin_Page::register($page_basename, $config);
+	}
+
+
+	/**
+	 * @param int     $post_ID
+	 * @param WP_Post $post
+	 * @return void
+	 * @deprecated 4.8.41
+	 */
+	public static function parse_post_content_on_save($post_ID, $post)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @param  $option
+	 * @param  $old_value
+	 * @param  $value
+	 * @return void
+	 * @deprecated 4.8.41
+	 */
+	public function reset_page_for_posts_on_change($option, $old_value, $value)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__('Usage is deprecated', 'event_espresso'),
+			'4.8.41'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 4.9.27
+	 */
+	public function get_persistent_admin_notices()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+	}
+
+
+	/**
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @deprecated 4.9.27
+	 */
+	public function dismiss_ee_nag_notice_callback()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'\EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+			),
+			'4.9.27'
+		);
+		$this->persistent_admin_notice_manager->dismissNotice();
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public function enqueue_admin_scripts()
+	{
+	}
+
+
+
+	/**
+	 * @return RequestInterface
+	 * @deprecated 5.0.0.p
+	 */
+	public function get_request()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('Usage is deprecated. Use "%1$s" instead.', 'event_espresso'),
+				'EventEspresso\core\services\request\Request'
+			),
+			'5.0.0.p'
+		);
+		return $this->request;
+	}
+
+
+	/**
+	 * @deprecated 5.0.0.p
+	 */
+	public function hookIntoWpPluginsPage()
+	{
+	}
 }

core/admin/EE_Admin_List_Table.core.php

Indentation +949 added lines, -949 removed lines

@@ -6,7 +6,7 @@ 
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
 if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+	require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -24,931 +24,931 @@ 
  */
 abstract class EE_Admin_List_Table extends WP_List_Table
 {
-    const ACTION_COPY    = 'duplicate';
-
-    const ACTION_DELETE  = 'delete';
-
-    const ACTION_EDIT    = 'edit';
-
-    const ACTION_RESTORE = 'restore';
-
-    const ACTION_TRASH   = 'trash';
-
-    protected static array $actions = [
-        self::ACTION_COPY,
-        self::ACTION_DELETE,
-        self::ACTION_EDIT,
-        self::ACTION_RESTORE,
-        self::ACTION_TRASH,
-    ];
-
-    /**
-     * holds the data that will be processed for the table
-     *
-     * @var array $_data
-     */
-    protected array $_data;
-
-
-    /**
-     * This holds the value of all the data available for the given view (for all pages).
-     *
-     * @var int $_all_data_count
-     */
-    protected int $_all_data_count;
-
-
-    /**
-     * Will contain the count of trashed items for the view label.
-     *
-     * @var int $_trashed_count
-     */
-    protected int $_trashed_count;
-
-
-    /**
-     * This is what will be referenced as the slug for the current screen
-     *
-     * @var string $_screen
-     */
-    protected string $_screen;
-
-
-    /**
-     * this is the EE_Admin_Page object
-     *
-     * @var EE_Admin_Page $_admin_page
-     */
-    protected EE_Admin_Page $_admin_page;
-
-
-    /**
-     * The current view
-     *
-     * @var string $_view
-     */
-    protected string $_view;
-
-
-    /**
-     * array of possible views for this table
-     *
-     * @var array $_views
-     */
-    protected array $_views;
-
-
-    /**
-     * An array of key => value pairs containing information about the current table
-     * array(
-     *        'plural' => 'plural label',
-     *        'singular' => 'singular label',
-     *        'ajax' => false, //whether to use ajax or not
-     *        'screen' => null, //string used to reference what screen this is
-     *        (WP_List_table converts to screen object)
-     * )
-     *
-     * @var array $_wp_list_args
-     */
-    protected array $_wp_list_args;
-
-    /**
-     * an array of column names
-     * array(
-     *    'internal-name' => 'Title'
-     * )
-     *
-     * @var array $_columns
-     */
-    protected array $_columns;
-
-    /**
-     * An array of sortable columns
-     * array(
-     *    'internal-name' => 'orderby' //or
-     *    'internal-name' => array( 'orderby', true )
-     * )
-     *
-     * @var array $_sortable_columns
-     */
-    protected array $_sortable_columns;
-
-    /**
-     * callback method used to perform AJAX row reordering
-     *
-     * @var string|null $_ajax_sorting_callback
-     */
-    protected ?string $_ajax_sorting_callback = null;
-
-    /**
-     * An array of hidden columns (if needed)
-     * array('internal-name', 'internal-name')
-     *
-     * @var array $_hidden_columns
-     */
-    protected array $_hidden_columns;
-
-    /**
-     * holds the per_page value
-     *
-     * @var int $_per_page
-     */
-    protected int $_per_page;
-
-    /**
-     * holds what page number is currently being viewed
-     *
-     * @var int $_current_page
-     */
-    protected int $_current_page;
-
-    /**
-     * the reference string for the nonce_action
-     *
-     * @var string $_nonce_action_ref
-     */
-    protected string $_nonce_action_ref;
-
-    /**
-     * property to hold incoming request data (as set by the admin_page_core)
-     *
-     * @var array $_req_data
-     */
-    protected array $_req_data;
-
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array $_yes_no
-     */
-    protected array $_yes_no = [];
-
-    /**
-     * Array describing buttons that should appear at the bottom of the page
-     * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
-     * and the values are another array with the following keys
-     * array(
-     *    'route' => 'page_route',
-     *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
-     * )
-     *
-     * @var array $_bottom_buttons
-     */
-    protected array $_bottom_buttons = [];
-
-
-    /**
-     * Used to indicate what should be the primary column for the list table.
-     * If not present then falls back to what WP calculates
-     * as the primary column.
-     *
-     * @type string $_primary_column
-     */
-    protected string $_primary_column = '';
-
-
-    /**
-     * Used to indicate whether the table has a checkbox column or not.
-     *
-     * @type bool $_has_checkbox_column
-     */
-    protected bool $_has_checkbox_column = false;
-
-    /**
-     * @var AdminListTableFilters|null
-     */
-    protected ?AdminListTableFilters $admin_list_table_filters = null;
-
-    protected ?RequestInterface    $request            = null;
-
-
-    /**
-     * @param EE_Admin_Page              $admin_page we use this for obtaining everything we need in the list table
-     * @param AdminListTableFilters|null $filters    to display list table filters
-     */
-    public function __construct(EE_Admin_Page $admin_page, ?AdminListTableFilters $filters = null)
-    {
-        $this->request       = LoaderFactory::getShared(RequestInterface::class);
-        $this->_admin_page   = $admin_page;
-        $this->_req_data     = $this->_admin_page->get_request_data();
-        $this->_view         = $this->_admin_page->get_view();
-        $this->_views        = $this->_admin_page->get_list_table_view_RLs();
-        $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
-        $this->_yes_no       = [
-            esc_html__('No', 'event_espresso'),
-            esc_html__('Yes', 'event_espresso')
-        ];
-
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
-
-        $this->admin_list_table_filters = $filters instanceof AdminListTableFilters
-            ? $filters
-            : LoaderFactory::getShared(AdminListTableFilters::class);
-
-        $this->_setup_data();
-        $this->_add_view_counts();
-
-        $this->_nonce_action_ref = $this->_view;
-
-        $this->_set_properties();
-
-        // set primary column
-        add_filter('list_table_primary_column', [$this, 'set_primary_column']);
-
-        // set parent defaults
-        parent::__construct($this->_wp_list_args);
-
-        $this->prepare_items();
-    }
-
-
-    /**
-     * _setup_data
-     * this method is used to setup the $_data, $_all_data_count, and _per_page properties
-     *
-     * @return void
-     * @uses $this->_admin_page
-     */
-    abstract protected function _setup_data();
-
-
-    /**
-     * set the properties that this class needs to be able to execute wp_list_table properly
-     * properties set:
-     * _wp_list_args = what the arguments required for the parent _wp_list_table.
-     * _columns = set the columns in an array.
-     * _sortable_columns = columns that are sortable (array).
-     * _hidden_columns = columns that are hidden (array)
-     * _default_orderby = the default orderby for sorting.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_properties();
-
-
-    /**
-     * _get_table_filters
-     * We use this to assemble and return any filters that are associated with this table that help further refine what
-     * gets shown in the table.
-     *
-     * @abstract
-     * @access protected
-     * @return string[]
-     */
-    abstract protected function _get_table_filters();
-
-
-    /**
-     * this is a method that child class will do to add counts to the views array so when views are displayed the
-     * counts of the views is accurate.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _add_view_counts();
-
-
-    /**
-     * _get_hidden_fields
-     * returns a html string of hidden fields so if any table filters are used the current view will be respected.
-     *
-     * @return string
-     */
-    protected function _get_hidden_fields()
-    {
-        $action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
-        $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
-        // if action is STILL empty, then we set it to default
-        $action = empty($action) ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($this->_req_data['page']) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
-
-        $bulk_actions = $this->_get_bulk_actions();
-        foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                      . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
-        }
-
-        return $field;
-    }
-
-
-    /**
-     * _set_column_info
-     * we're using this to set the column headers property.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _set_column_info()
-    {
-        $columns   = $this->get_columns();
-        $hidden    = $this->get_hidden_columns();
-        $_sortable = $this->get_sortable_columns();
-
-        /**
-         * Dynamic hook allowing for adding sortable columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array
-         */
-        $_sortable = apply_filters(
-            "FHEE_manage_{$this->screen->id}_sortable_columns",
-            $_sortable,
-            $this->_screen,
-            $this
-        );
-
-        $sortable = [];
-        foreach ($_sortable as $id => $data) {
-            if (empty($data)) {
-                continue;
-            }
-            // fix for offset errors with WP_List_Table default get_columninfo()
-            if (is_array($data)) {
-                $_data[0] = key($data);
-                $_data[1] = isset($data[1]) ? $data[1] : false;
-            } else {
-                $_data[0] = $data;
-            }
-
-            $data = (array) $data;
-
-            if (! isset($data[1])) {
-                $_data[1] = false;
-            }
-
-            $sortable[ $id ] = $_data;
-        }
-        $primary               = $this->get_primary_column_name();
-        $this->_column_headers = [$columns, $hidden, $sortable, $primary];
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @return string
-     */
-    protected function get_primary_column_name()
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
-                return parent::get_primary_column_name();
-            }
-        }
-        return $this->_primary_column;
-    }
-
-
-    /**
-     * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name
-     * @param string        $primary
-     * @return string
-     */
-    protected function handle_row_actions($item, $column_name, $primary)
-    {
-        foreach (class_parents($this) as $parent) {
-            if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
-                return parent::handle_row_actions($item, $column_name, $primary);
-            }
-        }
-        return '';
-    }
-
-
-    /**
-     * _get_bulk_actions
-     * This is a wrapper called by WP_List_Table::get_bulk_actions()
-     *
-     * @access protected
-     * @return array bulk_actions
-     */
-    protected function _get_bulk_actions(): array
-    {
-        $actions = [];
-        // the _views property should have the bulk_actions, so let's go through and extract them into a properly
-        // formatted array for the wp_list_table();
-        foreach ($this->_views as $view => $args) {
-            if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
-                // each bulk action will correspond with a admin page route, so we can check whatever the capability is
-                // for that page route and skip adding the bulk action if no access for the current logged in user.
-                foreach ($args['bulk_action'] as $route => $label) {
-                    if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[ $route ] = $label;
-                    }
-                }
-            }
-        }
-        return $actions;
-    }
-
-
-    /**
-     * Generate the table navigation above or below the table.
-     * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
-     *
-     * @throws EE_Error
-     * @since 4.9.44.rc.001
-     */
-    public function display_tablenav($which)
-    {
-        if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
-        }
-        ?>
+	const ACTION_COPY    = 'duplicate';
+
+	const ACTION_DELETE  = 'delete';
+
+	const ACTION_EDIT    = 'edit';
+
+	const ACTION_RESTORE = 'restore';
+
+	const ACTION_TRASH   = 'trash';
+
+	protected static array $actions = [
+		self::ACTION_COPY,
+		self::ACTION_DELETE,
+		self::ACTION_EDIT,
+		self::ACTION_RESTORE,
+		self::ACTION_TRASH,
+	];
+
+	/**
+	 * holds the data that will be processed for the table
+	 *
+	 * @var array $_data
+	 */
+	protected array $_data;
+
+
+	/**
+	 * This holds the value of all the data available for the given view (for all pages).
+	 *
+	 * @var int $_all_data_count
+	 */
+	protected int $_all_data_count;
+
+
+	/**
+	 * Will contain the count of trashed items for the view label.
+	 *
+	 * @var int $_trashed_count
+	 */
+	protected int $_trashed_count;
+
+
+	/**
+	 * This is what will be referenced as the slug for the current screen
+	 *
+	 * @var string $_screen
+	 */
+	protected string $_screen;
+
+
+	/**
+	 * this is the EE_Admin_Page object
+	 *
+	 * @var EE_Admin_Page $_admin_page
+	 */
+	protected EE_Admin_Page $_admin_page;
+
+
+	/**
+	 * The current view
+	 *
+	 * @var string $_view
+	 */
+	protected string $_view;
+
+
+	/**
+	 * array of possible views for this table
+	 *
+	 * @var array $_views
+	 */
+	protected array $_views;
+
+
+	/**
+	 * An array of key => value pairs containing information about the current table
+	 * array(
+	 *        'plural' => 'plural label',
+	 *        'singular' => 'singular label',
+	 *        'ajax' => false, //whether to use ajax or not
+	 *        'screen' => null, //string used to reference what screen this is
+	 *        (WP_List_table converts to screen object)
+	 * )
+	 *
+	 * @var array $_wp_list_args
+	 */
+	protected array $_wp_list_args;
+
+	/**
+	 * an array of column names
+	 * array(
+	 *    'internal-name' => 'Title'
+	 * )
+	 *
+	 * @var array $_columns
+	 */
+	protected array $_columns;
+
+	/**
+	 * An array of sortable columns
+	 * array(
+	 *    'internal-name' => 'orderby' //or
+	 *    'internal-name' => array( 'orderby', true )
+	 * )
+	 *
+	 * @var array $_sortable_columns
+	 */
+	protected array $_sortable_columns;
+
+	/**
+	 * callback method used to perform AJAX row reordering
+	 *
+	 * @var string|null $_ajax_sorting_callback
+	 */
+	protected ?string $_ajax_sorting_callback = null;
+
+	/**
+	 * An array of hidden columns (if needed)
+	 * array('internal-name', 'internal-name')
+	 *
+	 * @var array $_hidden_columns
+	 */
+	protected array $_hidden_columns;
+
+	/**
+	 * holds the per_page value
+	 *
+	 * @var int $_per_page
+	 */
+	protected int $_per_page;
+
+	/**
+	 * holds what page number is currently being viewed
+	 *
+	 * @var int $_current_page
+	 */
+	protected int $_current_page;
+
+	/**
+	 * the reference string for the nonce_action
+	 *
+	 * @var string $_nonce_action_ref
+	 */
+	protected string $_nonce_action_ref;
+
+	/**
+	 * property to hold incoming request data (as set by the admin_page_core)
+	 *
+	 * @var array $_req_data
+	 */
+	protected array $_req_data;
+
+
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array $_yes_no
+	 */
+	protected array $_yes_no = [];
+
+	/**
+	 * Array describing buttons that should appear at the bottom of the page
+	 * Keys are strings that represent the button's function (specifically a key in _labels['buttons']),
+	 * and the values are another array with the following keys
+	 * array(
+	 *    'route' => 'page_route',
+	 *    'extra_request' => array('evt_id' => 1 ); //extra request vars that need to be included in the button.
+	 * )
+	 *
+	 * @var array $_bottom_buttons
+	 */
+	protected array $_bottom_buttons = [];
+
+
+	/**
+	 * Used to indicate what should be the primary column for the list table.
+	 * If not present then falls back to what WP calculates
+	 * as the primary column.
+	 *
+	 * @type string $_primary_column
+	 */
+	protected string $_primary_column = '';
+
+
+	/**
+	 * Used to indicate whether the table has a checkbox column or not.
+	 *
+	 * @type bool $_has_checkbox_column
+	 */
+	protected bool $_has_checkbox_column = false;
+
+	/**
+	 * @var AdminListTableFilters|null
+	 */
+	protected ?AdminListTableFilters $admin_list_table_filters = null;
+
+	protected ?RequestInterface    $request            = null;
+
+
+	/**
+	 * @param EE_Admin_Page              $admin_page we use this for obtaining everything we need in the list table
+	 * @param AdminListTableFilters|null $filters    to display list table filters
+	 */
+	public function __construct(EE_Admin_Page $admin_page, ?AdminListTableFilters $filters = null)
+	{
+		$this->request       = LoaderFactory::getShared(RequestInterface::class);
+		$this->_admin_page   = $admin_page;
+		$this->_req_data     = $this->_admin_page->get_request_data();
+		$this->_view         = $this->_admin_page->get_view();
+		$this->_views        = $this->_admin_page->get_list_table_view_RLs();
+		$this->_current_page = $this->get_pagenum();
+		$this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+		$this->_yes_no       = [
+			esc_html__('No', 'event_espresso'),
+			esc_html__('Yes', 'event_espresso')
+		];
+
+		$this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
+
+		$this->admin_list_table_filters = $filters instanceof AdminListTableFilters
+			? $filters
+			: LoaderFactory::getShared(AdminListTableFilters::class);
+
+		$this->_setup_data();
+		$this->_add_view_counts();
+
+		$this->_nonce_action_ref = $this->_view;
+
+		$this->_set_properties();
+
+		// set primary column
+		add_filter('list_table_primary_column', [$this, 'set_primary_column']);
+
+		// set parent defaults
+		parent::__construct($this->_wp_list_args);
+
+		$this->prepare_items();
+	}
+
+
+	/**
+	 * _setup_data
+	 * this method is used to setup the $_data, $_all_data_count, and _per_page properties
+	 *
+	 * @return void
+	 * @uses $this->_admin_page
+	 */
+	abstract protected function _setup_data();
+
+
+	/**
+	 * set the properties that this class needs to be able to execute wp_list_table properly
+	 * properties set:
+	 * _wp_list_args = what the arguments required for the parent _wp_list_table.
+	 * _columns = set the columns in an array.
+	 * _sortable_columns = columns that are sortable (array).
+	 * _hidden_columns = columns that are hidden (array)
+	 * _default_orderby = the default orderby for sorting.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_properties();
+
+
+	/**
+	 * _get_table_filters
+	 * We use this to assemble and return any filters that are associated with this table that help further refine what
+	 * gets shown in the table.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return string[]
+	 */
+	abstract protected function _get_table_filters();
+
+
+	/**
+	 * this is a method that child class will do to add counts to the views array so when views are displayed the
+	 * counts of the views is accurate.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _add_view_counts();
+
+
+	/**
+	 * _get_hidden_fields
+	 * returns a html string of hidden fields so if any table filters are used the current view will be respected.
+	 *
+	 * @return string
+	 */
+	protected function _get_hidden_fields()
+	{
+		$action = isset($this->_req_data['route']) ? $this->_req_data['route'] : '';
+		$action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
+		// if action is STILL empty, then we set it to default
+		$action = empty($action) ? 'default' : $action;
+		$field  = '<input type="hidden" name="page" value="' . esc_attr($this->_req_data['page']) . '" />' . "\n";
+		$field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
+		$field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
+
+		$bulk_actions = $this->_get_bulk_actions();
+		foreach ($bulk_actions as $bulk_action => $label) {
+			$field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
+					  . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+		}
+
+		return $field;
+	}
+
+
+	/**
+	 * _set_column_info
+	 * we're using this to set the column headers property.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _set_column_info()
+	{
+		$columns   = $this->get_columns();
+		$hidden    = $this->get_hidden_columns();
+		$_sortable = $this->get_sortable_columns();
+
+		/**
+		 * Dynamic hook allowing for adding sortable columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array
+		 */
+		$_sortable = apply_filters(
+			"FHEE_manage_{$this->screen->id}_sortable_columns",
+			$_sortable,
+			$this->_screen,
+			$this
+		);
+
+		$sortable = [];
+		foreach ($_sortable as $id => $data) {
+			if (empty($data)) {
+				continue;
+			}
+			// fix for offset errors with WP_List_Table default get_columninfo()
+			if (is_array($data)) {
+				$_data[0] = key($data);
+				$_data[1] = isset($data[1]) ? $data[1] : false;
+			} else {
+				$_data[0] = $data;
+			}
+
+			$data = (array) $data;
+
+			if (! isset($data[1])) {
+				$_data[1] = false;
+			}
+
+			$sortable[ $id ] = $_data;
+		}
+		$primary               = $this->get_primary_column_name();
+		$this->_column_headers = [$columns, $hidden, $sortable, $primary];
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @return string
+	 */
+	protected function get_primary_column_name()
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'get_primary_column_name')) {
+				return parent::get_primary_column_name();
+			}
+		}
+		return $this->_primary_column;
+	}
+
+
+	/**
+	 * Added for WP4.1 backward compat (@see https://events.codebasehq.com/projects/event-espresso/tickets/8814)
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name
+	 * @param string        $primary
+	 * @return string
+	 */
+	protected function handle_row_actions($item, $column_name, $primary)
+	{
+		foreach (class_parents($this) as $parent) {
+			if ($parent === 'WP_List_Table' && method_exists($parent, 'handle_row_actions')) {
+				return parent::handle_row_actions($item, $column_name, $primary);
+			}
+		}
+		return '';
+	}
+
+
+	/**
+	 * _get_bulk_actions
+	 * This is a wrapper called by WP_List_Table::get_bulk_actions()
+	 *
+	 * @access protected
+	 * @return array bulk_actions
+	 */
+	protected function _get_bulk_actions(): array
+	{
+		$actions = [];
+		// the _views property should have the bulk_actions, so let's go through and extract them into a properly
+		// formatted array for the wp_list_table();
+		foreach ($this->_views as $view => $args) {
+			if ($this->_view === $view && isset($args['bulk_action']) && is_array($args['bulk_action'])) {
+				// each bulk action will correspond with a admin page route, so we can check whatever the capability is
+				// for that page route and skip adding the bulk action if no access for the current logged in user.
+				foreach ($args['bulk_action'] as $route => $label) {
+					if ($this->_admin_page->check_user_access($route, true)) {
+						$actions[ $route ] = $label;
+					}
+				}
+			}
+		}
+		return $actions;
+	}
+
+
+	/**
+	 * Generate the table navigation above or below the table.
+	 * Overrides the parent table nav in WP_List_Table so we can hide the bulk action div if there are no bulk actions.
+	 *
+	 * @throws EE_Error
+	 * @since 4.9.44.rc.001
+	 */
+	public function display_tablenav($which)
+	{
+		if ('top' === $which) {
+			wp_nonce_field('bulk-' . $this->_args['plural']);
+		}
+		?>
         <div class="tablenav <?php echo esc_attr($which); ?>">
             <?php if ($this->_get_bulk_actions()) { ?>
                 <div class="alignleft actions bulkactions">
                     <?php $this->bulk_actions(); ?>
                 </div>
             <?php }
-            $this->extra_tablenav($which);
-            $this->pagination($which);
-            ?>
+			$this->extra_tablenav($which);
+			$this->pagination($which);
+			?>
 
             <br class="clear" />
         </div>
         <?php
-    }
-
-
-    /**
-     * _filters
-     * This receives the filters array from children _get_table_filters() and assembles the string including the filter
-     * button.
-     *
-     * @access private
-     * @return void  echos html showing filters
-     */
-    private function _filters(): void
-    {
-        $classname = get_class($this);
-        $filters   = apply_filters(
-            "FHEE__{$classname}__filters",
-            $this->_get_table_filters(),
-            $this,
-            $this->_screen
-        );
-
-        if (empty($filters)) {
-            return;
-        }
-
-        $this->admin_list_table_filters->filters(
-            $filters,
-            $this->get_admin_page()->get_current_page_view_url()
-        );
-    }
-
-
-    /**
-     * Callback for 'list_table_primary_column' WordPress filter
-     * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
-     * column when class is instantiated.
-     *
-     * @param string $column_name
-     * @return string
-     * @see WP_List_Table::get_primary_column_name
-     */
-    public function set_primary_column($column_name)
-    {
-        return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
-    }
-
-
-    /**
-     *
-     */
-    public function prepare_items()
-    {
-        $this->_set_column_info();
-        $this->process_bulk_action();
-
-        $this->items = $this->_data;
-        $this->set_pagination_args(
-            [
-                'total_items' => $this->_all_data_count,
-                'per_page'    => $this->_per_page,
-                'total_pages' => (int) ceil($this->_all_data_count / $this->_per_page),
-            ]
-        );
-    }
-
-
-    /**
-     * @param object|array $item
-     * @return string html content for the column
-     */
-    protected function column_cb($item)
-    {
-        return '';
-    }
-
-
-    /**
-     * This column is the default for when there is no defined column method for a registered column.
-     * This can be overridden by child classes, but allows for hooking in for custom columns.
-     *
-     * @param EE_Base_Class $item
-     * @param string        $column_name The column being called.
-     * @return string html content for the column
-     */
-    public function column_default($item, $column_name)
-    {
-        /**
-         * Dynamic hook allowing for adding additional column content in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         */
-        ob_start();
-        do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
-            $item,
-            $this->_screen
-        );
-        $content = ob_get_clean();
-        return $column_name === 'actions' ? $this->actionsModalMenu($content) : $content;
-    }
-
-
-    /**
-     * Get a list of columns. The format is:
-     * 'internal-name' => 'Title'
-     *
-     * @return array
-     * @since  3.1.0
-     * @access public
-     * @abstract
-     */
-    public function get_columns()
-    {
-        /**
-         * Dynamic hook allowing for adding additional columns in this list table.
-         * Note that $this->screen->id is in the format
-         * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
-         * table it is: event-espresso_page_espresso_messages.
-         * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
-         * hook prefix ("event-espresso") will be different.
-         *
-         * @var array
-         */
-        return apply_filters("FHEE_manage_{$this->screen->id}_columns", $this->_columns, $this->_screen, $this);
-    }
-
-
-    /**
-     * Get an associative array ( id => link ) with the list
-     * of views available on this table.
-     *
-     * @return array
-     * @since  3.1.0
-     * @access protected
-     */
-    public function get_views()
-    {
-        return $this->_views;
-    }
-
-
-    /**
-     * Generate the views html.
-     */
-    public function display_views()
-    {
-        $views           = $this->get_views();
-        $assembled_views = [];
-
-        if (empty($views)) {
-            return;
-        }
-        echo "<ul class='subsubsub'>\n";
-        foreach ($views as $view) {
-            $count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
-            if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
-                $filter = "<li";
-                $filter .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
-                $filter .= ">";
-                $filter .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html($view['label']) . '</a>';
-                $filter .= '<span class="count">(' . $count . ')</span>';
-                $filter .= '</li>';
-                $assembled_views[ $view['slug'] ] = $filter;
-            }
-        }
-
-        echo ! empty($assembled_views)
-            ? implode("<li style='margin:0 .5rem;'>|</li>", $assembled_views)
-            : '';
-        echo "</ul>";
-    }
-
-
-    /**
-     * Generates content for a single row of the table
-     *
-     * @param EE_Base_Class $item The current item
-     * @since  4.1
-     * @access public
-     */
-    public function single_row($item)
-    {
-        $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
-        $this->single_row_columns($item); // already escaped
-        echo '</tr>';
-    }
-
-
-    /**
-     * This simply sets up the row class for the table rows.
-     * Allows for easier overriding of child methods for setting up sorting.
-     *
-     * @param EE_Base_Class $item the current item
-     * @return string
-     */
-    protected function _get_row_class($item)
-    {
-        static $row_class = '';
-        $row_class = ($row_class === '' ? 'alternate' : '');
-
-        $new_row_class = $row_class;
-
-        if (! empty($this->_ajax_sorting_callback)) {
-            $new_row_class .= ' rowsortable';
-        }
-
-        return $new_row_class;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_sortable_columns()
-    {
-        return (array) $this->_sortable_columns;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function get_ajax_sorting_callback()
-    {
-        return $this->_ajax_sorting_callback;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_hidden_columns()
-    {
-        $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
-        if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
-        }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
-        return (array) get_user_option($ref, $user_id);
-    }
-
-
-    /**
-     * Generates the columns for a single row of the table.
-     * Overridden from wp_list_table so as to allow us to filter the column content for a given
-     * column.
-     *
-     * @param EE_Base_Class $item The current item
-     * @since 3.1.0
-     */
-    public function single_row_columns($item)
-    {
-        [$columns, $hidden, $sortable, $primary] = $this->get_column_info();
-
-        foreach ($columns as $column_name => $column_display_name) {
-
-            /**
-             * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
-             * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
-             */
-            $hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
-
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
-            if ($primary === $column_name) {
-                $classes .= ' has-row-actions column-primary';
-            }
-
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
-
-            $class = 'class="' . esc_attr($classes) . '"';
-
-            $attributes = "{$class}{$data}";
-
-            if ($column_name === 'cb') {
-                echo '<th scope="row" class="check-column">';
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
-                    $this->column_cb($item), // already escaped
-                    $item,
-                    $this
-                );
-                echo '</th>';
-            } elseif (method_exists($this, "column_$column_name")) {
-                echo "<td $attributes>"; // already escaped
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
-                    call_user_func([$this, "column_$column_name"], $item),
-                    $item,
-                    $this
-                );
-                echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
-                echo "</td>";
-            } else {
-                echo "<td $attributes>"; // already escaped
-                echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
-                    $this->column_default($item, $column_name),
-                    $item,
-                    $column_name,
-                    $this
-                );
-                echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
-                echo "</td>";
-            }
-        }
-    }
-
-
-    /**
-     * Extra controls to be displayed between bulk actions and pagination
-     *
-     * @access public
-     * @param string $which
-     * @throws EE_Error
-     */
-    public function extra_tablenav($which)
-    {
-        if ($which === 'top') {
-            $this->_filters();
-            echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
-        } else {
-            echo '<div class="list-table-bottom-buttons alignleft actions">';
-            foreach ($this->_bottom_buttons as $type => $action) {
-                $route         = $action['route'] ?? '';
-                $extra_request = $action['extra_request'] ?? [];
-                $btn_class     = $action['btn_class'] ?? 'button button--secondary';
-                // already escaped
-                echo wp_kses($this->_admin_page->get_action_link_or_button(
-                    $route,
-                    $type,
-                    $extra_request,
-                    $btn_class
-                ), AllowedTags::getWithFormTags());
-            }
-            do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
-            echo '</div>';
-        }
-    }
-
-
-    /**
-     * Get an associative array ( option_name => option_title ) with the list
-     * of bulk actions available on this table.
-     *
-     * @return array
-     * @since  3.1.0
-     * @access protected
-     */
-    public function get_bulk_actions()
-    {
-        return (array) $this->_get_bulk_actions();
-    }
-
-
-    /**
-     * Processing bulk actions.
-     */
-    public function process_bulk_action()
-    {
-        // this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
-        // reference in case there is a case where it gets used.
-    }
-
-
-    /**
-     * returns the EE admin page this list table is associated with
-     *
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page()
-    {
-        return $this->_admin_page;
-    }
-
-
-    /**
-     * A "helper" function for all children to provide an html string of
-     * actions to output in their content.  It is preferable for child classes
-     * to use this method for generating their actions content so that it's
-     * filterable by plugins
-     *
-     * @param string        $action_container           what are the html container
-     *                                                  elements for this actions string?
-     * @param string        $action_class               What class is for the container
-     *                                                  element.
-     * @param string        $action_items               The contents for the action items
-     *                                                  container.  This is filtered before
-     *                                                  returned.
-     * @param string        $action_id                  What id (optional) is used for the
-     *                                                  container element.
-     * @param EE_Base_Class $item                       The object for the column displaying
-     *                                                  the actions.
-     * @return string The assembled action elements container.
-     */
-    protected function _action_string(
-        $action_items,
-        $item,
-        $action_container = 'ul',
-        $action_class = '',
-        $action_id = ''
-    ) {
-        $action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
-        $open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        $close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
-        try {
-            $content = apply_filters(
-                'FHEE__EE_Admin_List_Table___action_string__action_items',
-                $action_items,
-                $item,
-                $this
-            );
-        } catch (Exception $e) {
-            if (WP_DEBUG) {
-                EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            }
-            $content = $action_items;
-        }
-        return "{$open_tag}{$content}{$close_tag}";
-    }
-
-
-    /**
-     * @return string
-     */
-    protected function getReturnUrl()
-    {
-        $host = $this->_admin_page->get_request()->getServerParam('HTTP_HOST');
-        $uri  = $this->_admin_page->get_request()->getServerParam('REQUEST_URI');
-        return urlencode(esc_url_raw("//{$host}{$uri}"));
-    }
-
-
-    /**
-     * @param string $id
-     * @param string $content
-     * @param string $align     start (default), center, end
-     * @return string
-     * @since   5.0.0.p
-     */
-    protected function columnContent($id, $content, $align = 'start')
-    {
-        if (! isset($this->_columns[ $id ])) {
-            throw new DomainException('missing column id');
-        }
-        $heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
-        $align = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
-        $align = "ee-responsive-table-cell--{$align}";
-
-        $html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-{$id} {$align} ee-layout-row'>";
-        $html .= "<div class='ee-responsive-table-cell__heading'>{$heading}</div>";
-        $html .= "<div class='ee-responsive-table-cell__content ee-layout-row'>{$content}</div>";
-        $html .= "</div>";
-        return $html;
-    }
-
-
-    protected function actionsModalMenu($actions): string
-    {
-        return '
+	}
+
+
+	/**
+	 * _filters
+	 * This receives the filters array from children _get_table_filters() and assembles the string including the filter
+	 * button.
+	 *
+	 * @access private
+	 * @return void  echos html showing filters
+	 */
+	private function _filters(): void
+	{
+		$classname = get_class($this);
+		$filters   = apply_filters(
+			"FHEE__{$classname}__filters",
+			$this->_get_table_filters(),
+			$this,
+			$this->_screen
+		);
+
+		if (empty($filters)) {
+			return;
+		}
+
+		$this->admin_list_table_filters->filters(
+			$filters,
+			$this->get_admin_page()->get_current_page_view_url()
+		);
+	}
+
+
+	/**
+	 * Callback for 'list_table_primary_column' WordPress filter
+	 * If child EE_Admin_List_Table classes set the _primary_column property then that will be set as the primary
+	 * column when class is instantiated.
+	 *
+	 * @param string $column_name
+	 * @return string
+	 * @see WP_List_Table::get_primary_column_name
+	 */
+	public function set_primary_column($column_name)
+	{
+		return ! empty($this->_primary_column) ? $this->_primary_column : $column_name;
+	}
+
+
+	/**
+	 *
+	 */
+	public function prepare_items()
+	{
+		$this->_set_column_info();
+		$this->process_bulk_action();
+
+		$this->items = $this->_data;
+		$this->set_pagination_args(
+			[
+				'total_items' => $this->_all_data_count,
+				'per_page'    => $this->_per_page,
+				'total_pages' => (int) ceil($this->_all_data_count / $this->_per_page),
+			]
+		);
+	}
+
+
+	/**
+	 * @param object|array $item
+	 * @return string html content for the column
+	 */
+	protected function column_cb($item)
+	{
+		return '';
+	}
+
+
+	/**
+	 * This column is the default for when there is no defined column method for a registered column.
+	 * This can be overridden by child classes, but allows for hooking in for custom columns.
+	 *
+	 * @param EE_Base_Class $item
+	 * @param string        $column_name The column being called.
+	 * @return string html content for the column
+	 */
+	public function column_default($item, $column_name)
+	{
+		/**
+		 * Dynamic hook allowing for adding additional column content in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 */
+		ob_start();
+		do_action(
+			'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+			$item,
+			$this->_screen
+		);
+		$content = ob_get_clean();
+		return $column_name === 'actions' ? $this->actionsModalMenu($content) : $content;
+	}
+
+
+	/**
+	 * Get a list of columns. The format is:
+	 * 'internal-name' => 'Title'
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access public
+	 * @abstract
+	 */
+	public function get_columns()
+	{
+		/**
+		 * Dynamic hook allowing for adding additional columns in this list table.
+		 * Note that $this->screen->id is in the format
+		 * {sanitize_title($top_level_menu_label)}_page_{$espresso_admin_page_slug}.  So for the messages list
+		 * table it is: event-espresso_page_espresso_messages.
+		 * However, take note that if the top level menu label has been translated (i.e. "Event Espresso"). then the
+		 * hook prefix ("event-espresso") will be different.
+		 *
+		 * @var array
+		 */
+		return apply_filters("FHEE_manage_{$this->screen->id}_columns", $this->_columns, $this->_screen, $this);
+	}
+
+
+	/**
+	 * Get an associative array ( id => link ) with the list
+	 * of views available on this table.
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access protected
+	 */
+	public function get_views()
+	{
+		return $this->_views;
+	}
+
+
+	/**
+	 * Generate the views html.
+	 */
+	public function display_views()
+	{
+		$views           = $this->get_views();
+		$assembled_views = [];
+
+		if (empty($views)) {
+			return;
+		}
+		echo "<ul class='subsubsub'>\n";
+		foreach ($views as $view) {
+			$count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
+			if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
+				$filter = "<li";
+				$filter .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
+				$filter .= ">";
+				$filter .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html($view['label']) . '</a>';
+				$filter .= '<span class="count">(' . $count . ')</span>';
+				$filter .= '</li>';
+				$assembled_views[ $view['slug'] ] = $filter;
+			}
+		}
+
+		echo ! empty($assembled_views)
+			? implode("<li style='margin:0 .5rem;'>|</li>", $assembled_views)
+			: '';
+		echo "</ul>";
+	}
+
+
+	/**
+	 * Generates content for a single row of the table
+	 *
+	 * @param EE_Base_Class $item The current item
+	 * @since  4.1
+	 * @access public
+	 */
+	public function single_row($item)
+	{
+		$row_class = $this->_get_row_class($item);
+		echo '<tr class="' . esc_attr($row_class) . '">';
+		$this->single_row_columns($item); // already escaped
+		echo '</tr>';
+	}
+
+
+	/**
+	 * This simply sets up the row class for the table rows.
+	 * Allows for easier overriding of child methods for setting up sorting.
+	 *
+	 * @param EE_Base_Class $item the current item
+	 * @return string
+	 */
+	protected function _get_row_class($item)
+	{
+		static $row_class = '';
+		$row_class = ($row_class === '' ? 'alternate' : '');
+
+		$new_row_class = $row_class;
+
+		if (! empty($this->_ajax_sorting_callback)) {
+			$new_row_class .= ' rowsortable';
+		}
+
+		return $new_row_class;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_sortable_columns()
+	{
+		return (array) $this->_sortable_columns;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function get_ajax_sorting_callback()
+	{
+		return $this->_ajax_sorting_callback;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_hidden_columns()
+	{
+		$user_id     = get_current_user_id();
+		$has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+		if (empty($has_default) && ! empty($this->_hidden_columns)) {
+			update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
+			update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+		}
+		$ref = 'manage' . $this->screen->id . 'columnshidden';
+		return (array) get_user_option($ref, $user_id);
+	}
+
+
+	/**
+	 * Generates the columns for a single row of the table.
+	 * Overridden from wp_list_table so as to allow us to filter the column content for a given
+	 * column.
+	 *
+	 * @param EE_Base_Class $item The current item
+	 * @since 3.1.0
+	 */
+	public function single_row_columns($item)
+	{
+		[$columns, $hidden, $sortable, $primary] = $this->get_column_info();
+
+		foreach ($columns as $column_name => $column_display_name) {
+
+			/**
+			 * With WordPress version 4.3.RC+ WordPress started using the hidden css class to control whether columns
+			 * are hidden or not instead of using "display:none;".  This bit of code provides backward compat.
+			 */
+			$hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
+
+			$classes = $column_name . ' column-' . $column_name . $hidden_class;
+			if ($primary === $column_name) {
+				$classes .= ' has-row-actions column-primary';
+			}
+
+			$data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+
+			$class = 'class="' . esc_attr($classes) . '"';
+
+			$attributes = "{$class}{$data}";
+
+			if ($column_name === 'cb') {
+				echo '<th scope="row" class="check-column">';
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_cb_content',
+					$this->column_cb($item), // already escaped
+					$item,
+					$this
+				);
+				echo '</th>';
+			} elseif (method_exists($this, "column_$column_name")) {
+				echo "<td $attributes>"; // already escaped
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+					call_user_func([$this, "column_$column_name"], $item),
+					$item,
+					$this
+				);
+				echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
+				echo "</td>";
+			} else {
+				echo "<td $attributes>"; // already escaped
+				echo apply_filters(
+					'FHEE__EE_Admin_List_Table__single_row_columns__column_default__column_content',
+					$this->column_default($item, $column_name),
+					$item,
+					$column_name,
+					$this
+				);
+				echo wp_kses($this->handle_row_actions($item, $column_name, $primary), AllowedTags::getWithFormTags());
+				echo "</td>";
+			}
+		}
+	}
+
+
+	/**
+	 * Extra controls to be displayed between bulk actions and pagination
+	 *
+	 * @access public
+	 * @param string $which
+	 * @throws EE_Error
+	 */
+	public function extra_tablenav($which)
+	{
+		if ($which === 'top') {
+			$this->_filters();
+			echo wp_kses($this->_get_hidden_fields(), AllowedTags::getWithFormTags());
+		} else {
+			echo '<div class="list-table-bottom-buttons alignleft actions">';
+			foreach ($this->_bottom_buttons as $type => $action) {
+				$route         = $action['route'] ?? '';
+				$extra_request = $action['extra_request'] ?? [];
+				$btn_class     = $action['btn_class'] ?? 'button button--secondary';
+				// already escaped
+				echo wp_kses($this->_admin_page->get_action_link_or_button(
+					$route,
+					$type,
+					$extra_request,
+					$btn_class
+				), AllowedTags::getWithFormTags());
+			}
+			do_action('AHEE__EE_Admin_List_Table__extra_tablenav__after_bottom_buttons', $this, $this->_screen);
+			echo '</div>';
+		}
+	}
+
+
+	/**
+	 * Get an associative array ( option_name => option_title ) with the list
+	 * of bulk actions available on this table.
+	 *
+	 * @return array
+	 * @since  3.1.0
+	 * @access protected
+	 */
+	public function get_bulk_actions()
+	{
+		return (array) $this->_get_bulk_actions();
+	}
+
+
+	/**
+	 * Processing bulk actions.
+	 */
+	public function process_bulk_action()
+	{
+		// this is not used it is handled by the child EE_Admin_Page class (routes).  However, including here for
+		// reference in case there is a case where it gets used.
+	}
+
+
+	/**
+	 * returns the EE admin page this list table is associated with
+	 *
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page()
+	{
+		return $this->_admin_page;
+	}
+
+
+	/**
+	 * A "helper" function for all children to provide an html string of
+	 * actions to output in their content.  It is preferable for child classes
+	 * to use this method for generating their actions content so that it's
+	 * filterable by plugins
+	 *
+	 * @param string        $action_container           what are the html container
+	 *                                                  elements for this actions string?
+	 * @param string        $action_class               What class is for the container
+	 *                                                  element.
+	 * @param string        $action_items               The contents for the action items
+	 *                                                  container.  This is filtered before
+	 *                                                  returned.
+	 * @param string        $action_id                  What id (optional) is used for the
+	 *                                                  container element.
+	 * @param EE_Base_Class $item                       The object for the column displaying
+	 *                                                  the actions.
+	 * @return string The assembled action elements container.
+	 */
+	protected function _action_string(
+		$action_items,
+		$item,
+		$action_container = 'ul',
+		$action_class = '',
+		$action_id = ''
+	) {
+		$action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
+		$action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
+		$open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
+		$close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
+		try {
+			$content = apply_filters(
+				'FHEE__EE_Admin_List_Table___action_string__action_items',
+				$action_items,
+				$item,
+				$this
+			);
+		} catch (Exception $e) {
+			if (WP_DEBUG) {
+				EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			}
+			$content = $action_items;
+		}
+		return "{$open_tag}{$content}{$close_tag}";
+	}
+
+
+	/**
+	 * @return string
+	 */
+	protected function getReturnUrl()
+	{
+		$host = $this->_admin_page->get_request()->getServerParam('HTTP_HOST');
+		$uri  = $this->_admin_page->get_request()->getServerParam('REQUEST_URI');
+		return urlencode(esc_url_raw("//{$host}{$uri}"));
+	}
+
+
+	/**
+	 * @param string $id
+	 * @param string $content
+	 * @param string $align     start (default), center, end
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	protected function columnContent($id, $content, $align = 'start')
+	{
+		if (! isset($this->_columns[ $id ])) {
+			throw new DomainException('missing column id');
+		}
+		$heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
+		$align = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
+		$align = "ee-responsive-table-cell--{$align}";
+
+		$html = "<div class='ee-responsive-table-cell ee-responsive-table-cell--column-{$id} {$align} ee-layout-row'>";
+		$html .= "<div class='ee-responsive-table-cell__heading'>{$heading}</div>";
+		$html .= "<div class='ee-responsive-table-cell__content ee-layout-row'>{$content}</div>";
+		$html .= "</div>";
+		return $html;
+	}
+
+
+	protected function actionsModalMenu($actions): string
+	{
+		return '
         <div class="ee-modal-menu">
             <button class="ee-modal-menu__button button button--secondary button--icon-only ee-aria-tooltip"
                     aria-label="' . esc_attr__('list table actions menu', 'event_espresso') . '"
@@ -960,43 +960,43 @@ 
                 ' . $actions . '
             </div>
         </div>';
-    }
+	}
 
 
-    public function actionsColumnHeader(): string
-    {
-        return '
+	public function actionsColumnHeader(): string
+	{
+		return '
             <span class="ee-actions-column-header-wrap">
                 <span class="dashicons dashicons-screenoptions"></span>
                 <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso') . '</span>
             </span>';
-    }
-
-
-    protected function getActionLink(string $url, string $display_text, string $label, $class = ''): string
-    {
-        $class = ! empty($class) ? "{$class} ee-list-table-action" : 'ee-list-table-action';
-        $class = ! empty($label) ? "{$class} ee-aria-tooltip" : $class;
-        $label = ! empty($label) ? " aria-label='{$label}'" : '';
-        return "<a href='{$url}' class='{$class}'{$label}>{$display_text}</a>";
-    }
-
-    /**
-     * Override the search box method of WP List Table to include a reset button
-     *
-     * @param string $text     The 'submit' button label.
-     * @param string $input_id ID attribute value for the search input field.
-     */
-    public function search_box($text, $input_id)
-    {
-        if (empty($_REQUEST['s']) && ! $this->has_items()) {
-            return;
-        }
-
-        $this->admin_list_table_filters->searchBox(
-            $text,
-            $input_id,
-            $this->get_admin_page()->get_current_page_view_url()
-        );
-    }
+	}
+
+
+	protected function getActionLink(string $url, string $display_text, string $label, $class = ''): string
+	{
+		$class = ! empty($class) ? "{$class} ee-list-table-action" : 'ee-list-table-action';
+		$class = ! empty($label) ? "{$class} ee-aria-tooltip" : $class;
+		$label = ! empty($label) ? " aria-label='{$label}'" : '';
+		return "<a href='{$url}' class='{$class}'{$label}>{$display_text}</a>";
+	}
+
+	/**
+	 * Override the search box method of WP List Table to include a reset button
+	 *
+	 * @param string $text     The 'submit' button label.
+	 * @param string $input_id ID attribute value for the search input field.
+	 */
+	public function search_box($text, $input_id)
+	{
+		if (empty($_REQUEST['s']) && ! $this->has_items()) {
+			return;
+		}
+
+		$this->admin_list_table_filters->searchBox(
+			$text,
+			$input_id,
+			$this->get_admin_page()->get_current_page_view_url()
+		);
+	}
 }

Spacing +38 added lines, -38 removed lines

@@ -5,8 +5,8 @@ 
 use EventEspresso\core\services\request\RequestInterface;
 use EventEspresso\core\services\request\sanitizers\AllowedTags;
 
-if (! class_exists('WP_List_Table')) {
-    require_once ABSPATH . 'wp-admin/includes/class-wp-list-table.php';
+if ( ! class_exists('WP_List_Table')) {
+    require_once ABSPATH.'wp-admin/includes/class-wp-list-table.php';
 }
 
 
@@ -220,7 +220,7 @@ 
      */
     protected ?AdminListTableFilters $admin_list_table_filters = null;
 
-    protected ?RequestInterface    $request            = null;
+    protected ?RequestInterface    $request = null;
 
 
     /**
@@ -235,13 +235,13 @@ 
         $this->_view         = $this->_admin_page->get_view();
         $this->_views        = $this->_admin_page->get_list_table_view_RLs();
         $this->_current_page = $this->get_pagenum();
-        $this->_screen       = $this->_admin_page->get_current_page() . '_' . $this->_admin_page->get_current_view();
+        $this->_screen       = $this->_admin_page->get_current_page().'_'.$this->_admin_page->get_current_view();
         $this->_yes_no       = [
             esc_html__('No', 'event_espresso'),
             esc_html__('Yes', 'event_espresso')
         ];
 
-        $this->_per_page = $this->get_items_per_page($this->_screen . '_per_page');
+        $this->_per_page = $this->get_items_per_page($this->_screen.'_per_page');
 
         $this->admin_list_table_filters = $filters instanceof AdminListTableFilters
             ? $filters
@@ -325,14 +325,14 @@ 
         $action = empty($action) && isset($this->_req_data['action']) ? $this->_req_data['action'] : $action;
         // if action is STILL empty, then we set it to default
         $action = empty($action) ? 'default' : $action;
-        $field  = '<input type="hidden" name="page" value="' . esc_attr($this->_req_data['page']) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="route" value="' . esc_attr($action) . '" />' . "\n";
-        $field  .= '<input type="hidden" name="perpage" value="' . esc_attr($this->_per_page) . '" />' . "\n";
+        $field  = '<input type="hidden" name="page" value="'.esc_attr($this->_req_data['page']).'" />'."\n";
+        $field  .= '<input type="hidden" name="route" value="'.esc_attr($action).'" />'."\n";
+        $field  .= '<input type="hidden" name="perpage" value="'.esc_attr($this->_per_page).'" />'."\n";
 
         $bulk_actions = $this->_get_bulk_actions();
         foreach ($bulk_actions as $bulk_action => $label) {
-            $field .= '<input type="hidden" name="' . $bulk_action . '_nonce"'
-                      . ' value="' . wp_create_nonce($bulk_action . '_nonce') . '" />' . "\n";
+            $field .= '<input type="hidden" name="'.$bulk_action.'_nonce"'
+                      . ' value="'.wp_create_nonce($bulk_action.'_nonce').'" />'."\n";
         }
 
         return $field;
@@ -384,11 +384,11 @@ 
 
             $data = (array) $data;
 
-            if (! isset($data[1])) {
+            if ( ! isset($data[1])) {
                 $_data[1] = false;
             }
 
-            $sortable[ $id ] = $_data;
+            $sortable[$id] = $_data;
         }
         $primary               = $this->get_primary_column_name();
         $this->_column_headers = [$columns, $hidden, $sortable, $primary];
@@ -448,7 +448,7 @@ 
                 // for that page route and skip adding the bulk action if no access for the current logged in user.
                 foreach ($args['bulk_action'] as $route => $label) {
                     if ($this->_admin_page->check_user_access($route, true)) {
-                        $actions[ $route ] = $label;
+                        $actions[$route] = $label;
                     }
                 }
             }
@@ -467,7 +467,7 @@ 
     public function display_tablenav($which)
     {
         if ('top' === $which) {
-            wp_nonce_field('bulk-' . $this->_args['plural']);
+            wp_nonce_field('bulk-'.$this->_args['plural']);
         }
         ?>
         <div class="tablenav <?php echo esc_attr($which); ?>">
@@ -579,7 +579,7 @@ 
          */
         ob_start();
         do_action(
-            'AHEE__EE_Admin_List_Table__column_' . $column_name . '__' . $this->screen->id,
+            'AHEE__EE_Admin_List_Table__column_'.$column_name.'__'.$this->screen->id,
             $item,
             $this->_screen
         );
@@ -643,12 +643,12 @@ 
             $count = isset($view['count']) && ! empty($view['count']) ? absint($view['count']) : 0;
             if (isset($view['slug'], $view['class'], $view['url'], $view['label'])) {
                 $filter = "<li";
-                $filter .= $view['class'] ? " class='" . esc_attr($view['class']) . "'" : '';
+                $filter .= $view['class'] ? " class='".esc_attr($view['class'])."'" : '';
                 $filter .= ">";
-                $filter .= '<a href="' . esc_url_raw($view['url']) . '">' . esc_html($view['label']) . '</a>';
-                $filter .= '<span class="count">(' . $count . ')</span>';
+                $filter .= '<a href="'.esc_url_raw($view['url']).'">'.esc_html($view['label']).'</a>';
+                $filter .= '<span class="count">('.$count.')</span>';
                 $filter .= '</li>';
-                $assembled_views[ $view['slug'] ] = $filter;
+                $assembled_views[$view['slug']] = $filter;
             }
         }
 
@@ -669,7 +669,7 @@ 
     public function single_row($item)
     {
         $row_class = $this->_get_row_class($item);
-        echo '<tr class="' . esc_attr($row_class) . '">';
+        echo '<tr class="'.esc_attr($row_class).'">';
         $this->single_row_columns($item); // already escaped
         echo '</tr>';
     }
@@ -689,7 +689,7 @@ 
 
         $new_row_class = $row_class;
 
-        if (! empty($this->_ajax_sorting_callback)) {
+        if ( ! empty($this->_ajax_sorting_callback)) {
             $new_row_class .= ' rowsortable';
         }
 
@@ -721,12 +721,12 @@ 
     public function get_hidden_columns()
     {
         $user_id     = get_current_user_id();
-        $has_default = get_user_option('default' . $this->screen->id . 'columnshidden', $user_id);
+        $has_default = get_user_option('default'.$this->screen->id.'columnshidden', $user_id);
         if (empty($has_default) && ! empty($this->_hidden_columns)) {
-            update_user_option($user_id, 'default' . $this->screen->id . 'columnshidden', true);
-            update_user_option($user_id, 'manage' . $this->screen->id . 'columnshidden', $this->_hidden_columns, true);
+            update_user_option($user_id, 'default'.$this->screen->id.'columnshidden', true);
+            update_user_option($user_id, 'manage'.$this->screen->id.'columnshidden', $this->_hidden_columns, true);
         }
-        $ref = 'manage' . $this->screen->id . 'columnshidden';
+        $ref = 'manage'.$this->screen->id.'columnshidden';
         return (array) get_user_option($ref, $user_id);
     }
 
@@ -751,14 +751,14 @@ 
              */
             $hidden_class = in_array($column_name, $hidden) ? ' hidden' : '';
 
-            $classes = $column_name . ' column-' . $column_name . $hidden_class;
+            $classes = $column_name.' column-'.$column_name.$hidden_class;
             if ($primary === $column_name) {
                 $classes .= ' has-row-actions column-primary';
             }
 
-            $data = ' data-colname="' . wp_strip_all_tags($column_display_name) . '"';
+            $data = ' data-colname="'.wp_strip_all_tags($column_display_name).'"';
 
-            $class = 'class="' . esc_attr($classes) . '"';
+            $class = 'class="'.esc_attr($classes).'"';
 
             $attributes = "{$class}{$data}";
 
@@ -774,7 +774,7 @@ 
             } elseif (method_exists($this, "column_$column_name")) {
                 echo "<td $attributes>"; // already escaped
                 echo apply_filters(
-                    'FHEE__EE_Admin_List_Table__single_row_columns__column_' . $column_name . '__column_content',
+                    'FHEE__EE_Admin_List_Table__single_row_columns__column_'.$column_name.'__column_content',
                     call_user_func([$this, "column_$column_name"], $item),
                     $item,
                     $this
@@ -890,10 +890,10 @@ 
         $action_class = '',
         $action_id = ''
     ) {
-        $action_class = ! empty($action_class) ? ' class="' . esc_attr($action_class) . '"' : '';
-        $action_id    = ! empty($action_id) ? ' id="' . esc_attr($action_id) . '"' : '';
-        $open_tag     = ! empty($action_container) ? '<' . $action_container . $action_class . $action_id . '>' : '';
-        $close_tag    = ! empty($action_container) ? '</' . $action_container . '>' : '';
+        $action_class = ! empty($action_class) ? ' class="'.esc_attr($action_class).'"' : '';
+        $action_id    = ! empty($action_id) ? ' id="'.esc_attr($action_id).'"' : '';
+        $open_tag     = ! empty($action_container) ? '<'.$action_container.$action_class.$action_id.'>' : '';
+        $close_tag    = ! empty($action_container) ? '</'.$action_container.'>' : '';
         try {
             $content = apply_filters(
                 'FHEE__EE_Admin_List_Table___action_string__action_items',
@@ -931,10 +931,10 @@ 
      */
     protected function columnContent($id, $content, $align = 'start')
     {
-        if (! isset($this->_columns[ $id ])) {
+        if ( ! isset($this->_columns[$id])) {
             throw new DomainException('missing column id');
         }
-        $heading = $id !== 'cb' ? $this->_columns[ $id ] : '';
+        $heading = $id !== 'cb' ? $this->_columns[$id] : '';
         $align = in_array($align, ['start', 'center', 'end']) ? $align : 'start';
         $align = "ee-responsive-table-cell--{$align}";
 
@@ -951,13 +951,13 @@ 
         return '
         <div class="ee-modal-menu">
             <button class="ee-modal-menu__button button button--secondary button--icon-only ee-aria-tooltip"
-                    aria-label="' . esc_attr__('list table actions menu', 'event_espresso') . '"
+                    aria-label="' . esc_attr__('list table actions menu', 'event_espresso').'"
             >
                 <span class="dashicons dashicons-menu"></span>
             </button>
             <div class="ee-modal-menu__content ee-admin-container">
                 <span class="ee-modal-menu__close dashicons dashicons-no"></span>
-                ' . $actions . '
+                ' . $actions.'
             </div>
         </div>';
     }
@@ -968,7 +968,7 @@ 
         return '
             <span class="ee-actions-column-header-wrap">
                 <span class="dashicons dashicons-screenoptions"></span>
-                <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso') . '</span>
+                <span class="ee-actions-column-header">' . esc_html__('Actions', 'event_espresso').'</span>
             </span>';
     }
 

core/admin/EE_Admin_Page_Loader.core.php

Indentation +433 added lines, -433 removed lines

@@ -17,437 +17,437 @@
  */
 class EE_Admin_Page_Loader
 {
-    /**
-     * @var AdminMenuManager $menu_manager
-     */
-    protected $menu_manager;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * _installed_pages
-     * objects for page_init objects detected and loaded
-     *
-     * @access private
-     * @var EE_Admin_Page_Init[]
-     */
-    private $_installed_pages = [];
-
-
-    /**
-     * this is used to hold the registry of menu slugs for all the installed admin pages
-     *
-     * @var array
-     */
-    private $_menu_slugs = [];
-
-
-    /**
-     * _caffeinated_extends
-     * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
-     * pieces needed to do so).  This property is defined in the _set_caffeinated method.
-     *
-     * @var array
-     */
-    private $_caffeinated_extends = [];
-
-
-    /**
-     * This property will hold the hook file for setting up the filter that does all the connections between admin
-     * pages.
-     *
-     * @var string
-     */
-    public $hook_file;
-
-    /**
-     * @var bool
-     * @since 5.0.0.p
-     */
-    private bool $full_site_maintenance = false;
-
-
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function __construct(?LoaderInterface $loader)
-    {
-        $this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
-        $this->menu_manager = $this->loader->getShared(AdminMenuManager::class, [$this->loader]);
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.0.p
-     */
-    public function init()
-    {
-        $this->menu_manager->initialize();
-        $this->full_site_maintenance = MaintenanceStatus::isFullSite();
-        // let's do a scan and see what installed pages we have
-        $this->findAndLoadAdminPages();
-    }
-
-
-    /**
-     * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
-     * files in the caffeinated folder.
-     *
-     * @access private
-     * @return void
-     */
-    private function defineCaffeinatedConstants()
-    {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
-        }
-    }
-
-
-    /**
-     * This just gets the list of installed EE_Admin_pages.
-     *
-     * @access private
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    private function findAndLoadAdminPages()
-    {
-        $admin_pages = $this->findAdminPages();
-        // this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
-        $admin_pages = $this->findCaffeinatedAdminPages($admin_pages);
-        // then extensions and hooks, although they don't get added to the admin pages array
-        $this->findAdminPageExtensions();
-        $this->findAdminPageHooks();
-        // allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
-        // loop through admin pages and setup the $_installed_pages array.
-        $hooks_ref = [];
-        $menu_pages = [];
-        foreach ($admin_pages as $page => $path) {
-            // don't load the page init class IF IT's ALREADY LOADED !!!
-            if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
-            ) {
-                continue;
-            }
-            // build list of installed pages
-            $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
-            $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
-            $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
-            // skip if in full maintenance mode and maintenance_mode_parent is NOT set
-            if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
-                continue;
-            }
-            $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
-            // now that we've got the admin_init objects...
-            // lets see if there are any caffeinated pages extending the originals.
-            // If there are then let's hook into the init admin filter and load our extend instead.
-            // Set flag for register hooks on extended pages b/c extended pages use the default INIT.
-            $extended_hooks = $admin_page_init->register_hooks(
-                $this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
-            );
-            $hooks_ref      += $extended_hooks;
-        }
-        // the hooks_ref is all the pages where we have $extended _Hooks files
-        // that will extend a class in a different folder.
-        // So we want to make sure we load the file for the parent.
-        // first make sure we've got unique values
-        $hooks_ref = array_unique($hooks_ref);
-        // now let's loop and require!
-        foreach ($hooks_ref as $path) {
-            require_once($path);
-        }
-        // make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
-        global $ee_menu_slugs;
-        $ee_menu_slugs = $this->_menu_slugs;
-        // we need to loop again to run any early code
-        foreach ($this->_installed_pages as $page) {
-            $page->do_initial_loads();
-        }
-        $this->menu_manager->setInstalledPages($menu_pages);
-        do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
-    }
-
-
-    /**
-     * @return array
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPages(): array
-    {
-
-        // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
-        $admin_page_folders = apply_filters(
-            'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
-            $admin_page_folders
-        );
-        if (! empty($admin_page_folders)) {
-            return $admin_page_folders;
-        }
-        $error_msg = esc_html__(
-            'There are no EE_Admin pages detected, it looks like EE did not install properly',
-            'event_espresso'
-        );
-        $error_msg .= '||';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
-                'event_espresso'
-            ),
-            EE_ADMIN_PAGES
-        );
-        throw new RuntimeException($error_msg);
-    }
-
-
-    /**
-     * get_admin_page_object
-     *
-     * @param string $page_slug
-     * @return EE_Admin_Page
-     */
-    public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
-    {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
-            : null;
-    }
-
-
-    /**
-     * generates an "Admin Page Init" class based on the directory  name
-     *
-     * @param string $dir_name
-     * @return string
-     */
-    private function getClassnameForAdminPageInit(string $dir_name = ''): string
-    {
-        $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
-    }
-
-
-    /**
-     * _load_admin_page
-     * Loads and instantiates page_init object for a single EE_admin page.
-     *
-     * @param string $page page_reference
-     * @return EE_Admin_Page_Init
-     * @throws EE_Error
-     */
-    private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
-    {
-        $class_name = $this->getClassnameForAdminPageInit($page);
-        if (class_exists($class_name)) {
-            $admin_page_init = $this->loader->getShared($class_name);
-            // verify returned object
-            if ($admin_page_init instanceof EE_Admin_Page_Init) {
-                return $admin_page_init;
-            }
-        }
-        $error_msg = sprintf(
-            esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '||'; // separates public from developer messages
-        $error_msg .= "\r\n";
-        $error_msg .= sprintf(
-            esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
-            $page
-        );
-        $error_msg .= '<br />';
-        $error_msg .= sprintf(
-            esc_html__(
-                'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
-                'event_espresso'
-            ),
-            '<strong>' . $class_name . '</strong>'
-        );
-        throw new EE_Error($error_msg);
-    }
-
-
-    /**
-     * This method is the "workhorse" for detecting and setting up caffeinated functionality.
-     * In this method there are three checks being done:
-     * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
-     * array) etc.  (new page sets are found in caffeinated/new/{page})
-     * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
-     * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
-     * Extend_Events_Admin_Page extends Events_Admin_Page.
-     * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
-     * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
-     * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
-     * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
-     * admin_pages)
-     *
-     * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
-     *                              loaded.
-     * @return array
-     * @throws EE_Error
-     */
-    private function findCaffeinatedAdminPages(array $admin_pages): array
-    {
-        // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if ((defined('EE_DECAF') && EE_DECAF) || ! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin')) {
-            return $admin_pages;
-        }
-        $this->defineCaffeinatedConstants();
-        // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', ['tickets']);
-
-        return apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
-            $admin_pages
-        );
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPageExtensions()
-    {
-        // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array
-        // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
-        if ($extensions) {
-            foreach ($extensions as $folder => $extension) {
-                // convert lowercase_snake_case to Uppercase_Snake_Case
-                $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
-                $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
-                // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
-            }
-        }
-        $this->_caffeinated_extends = apply_filters(
-            'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
-            $this->_caffeinated_extends
-        );
-    }
-
-
-    private function loadCaffeinatedExtensions(
-        EE_Admin_Page_Init $admin_page_init,
-        string $page,
-        string $menu_slug
-    ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
-            return false;
-        }
-        $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
-                return $caf_path;
-            }
-        );
-        add_filter(
-            "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
-                return $caf_admin_page;
-            }
-        );
-        return true;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function findAdminPageHooks()
-    {
-        // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
-        $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
-        if ($admin_page_hooks) {
-            foreach ($admin_page_hooks as $hook) {
-                if (is_readable($hook)) {
-                    require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
-                    if (class_exists($classname)) {
-                        $ee_admin_hooks[] = $this->loader->getShared($classname);
-                    }
-                }
-            }
-        }
-        apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
-    }
-
-
-    /**
-     * _default_header_link
-     * This is just a dummy method to use with header submenu items
-     *
-     * @return bool false
-     */
-    public function _default_header_link(): bool
-    {
-        return false;
-    }
-
-
-    /**
-     * @param string $path
-     * @param int    $flags
-     * @param array  $exclude
-     * @param bool   $register_autoloaders
-     * @return array
-     * @throws EE_Error
-     * @since 5.0.0.p
-     */
-    private function findAdminPageFolders(
-        string $path,
-        array $exclude = [],
-        int $flags = GLOB_ONLYDIR,
-        bool $register_autoloaders = true
-    ): array {
-        $folders = [];
-        $subfolders = glob($path, $flags);
-        if ($subfolders) {
-            foreach ($subfolders as $admin_screen) {
-                $admin_screen_name = basename($admin_screen);
-                // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
-                    // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
-                    if ($register_autoloaders) {
-                        // set autoloaders for our admin page classes based on included path information
-                        EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
-                    }
-                }
-            }
-        }
-        return $folders;
-    }
+	/**
+	 * @var AdminMenuManager $menu_manager
+	 */
+	protected $menu_manager;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * _installed_pages
+	 * objects for page_init objects detected and loaded
+	 *
+	 * @access private
+	 * @var EE_Admin_Page_Init[]
+	 */
+	private $_installed_pages = [];
+
+
+	/**
+	 * this is used to hold the registry of menu slugs for all the installed admin pages
+	 *
+	 * @var array
+	 */
+	private $_menu_slugs = [];
+
+
+	/**
+	 * _caffeinated_extends
+	 * This array is the generated configuration array for which core EE_Admin pages are extended (and the bits and
+	 * pieces needed to do so).  This property is defined in the _set_caffeinated method.
+	 *
+	 * @var array
+	 */
+	private $_caffeinated_extends = [];
+
+
+	/**
+	 * This property will hold the hook file for setting up the filter that does all the connections between admin
+	 * pages.
+	 *
+	 * @var string
+	 */
+	public $hook_file;
+
+	/**
+	 * @var bool
+	 * @since 5.0.0.p
+	 */
+	private bool $full_site_maintenance = false;
+
+
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function __construct(?LoaderInterface $loader)
+	{
+		$this->loader = $loader instanceof LoaderInterface ? $loader : LoaderFactory::getLoader();
+		$this->menu_manager = $this->loader->getShared(AdminMenuManager::class, [$this->loader]);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.0.p
+	 */
+	public function init()
+	{
+		$this->menu_manager->initialize();
+		$this->full_site_maintenance = MaintenanceStatus::isFullSite();
+		// let's do a scan and see what installed pages we have
+		$this->findAndLoadAdminPages();
+	}
+
+
+	/**
+	 * When caffeinated system is detected, this method is called to setup the caffeinated directory constants used by
+	 * files in the caffeinated folder.
+	 *
+	 * @access private
+	 * @return void
+	 */
+	private function defineCaffeinatedConstants()
+	{
+		if (! defined('EE_CORE_CAF_ADMIN')) {
+			define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
+			define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
+			define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
+			define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
+			define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+		}
+	}
+
+
+	/**
+	 * This just gets the list of installed EE_Admin_pages.
+	 *
+	 * @access private
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	private function findAndLoadAdminPages()
+	{
+		$admin_pages = $this->findAdminPages();
+		// this just checks the caffeinated folder and takes care of setting up any caffeinated stuff.
+		$admin_pages = $this->findCaffeinatedAdminPages($admin_pages);
+		// then extensions and hooks, although they don't get added to the admin pages array
+		$this->findAdminPageExtensions();
+		$this->findAdminPageHooks();
+		// allow plugins to add in their own pages (note at this point they will need to have an autoloader defined for their class) OR hook into EEH_Autoloader::load_admin_page() to add their path.;
+		// loop through admin pages and setup the $_installed_pages array.
+		$hooks_ref = [];
+		$menu_pages = [];
+		foreach ($admin_pages as $page => $path) {
+			// don't load the page init class IF IT's ALREADY LOADED !!!
+			if (
+				isset($this->_installed_pages[ $page ])
+				&& $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+			) {
+				continue;
+			}
+			// build list of installed pages
+			$admin_page_init = $this->loadAdminPageInit($page);
+			$this->_installed_pages[ $page ] = $admin_page_init;
+			$admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
+			$admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
+			// skip if in full maintenance mode and maintenance_mode_parent is NOT set
+			if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
+				unset($admin_pages[ $page ]);
+				continue;
+			}
+			$menu_slug = $admin_menu->menuSlug();
+			$this->_menu_slugs[ $menu_slug ] = $page;
+			$menu_pages[ $menu_slug ] = $admin_page_init;
+			// now that we've got the admin_init objects...
+			// lets see if there are any caffeinated pages extending the originals.
+			// If there are then let's hook into the init admin filter and load our extend instead.
+			// Set flag for register hooks on extended pages b/c extended pages use the default INIT.
+			$extended_hooks = $admin_page_init->register_hooks(
+				$this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
+			);
+			$hooks_ref      += $extended_hooks;
+		}
+		// the hooks_ref is all the pages where we have $extended _Hooks files
+		// that will extend a class in a different folder.
+		// So we want to make sure we load the file for the parent.
+		// first make sure we've got unique values
+		$hooks_ref = array_unique($hooks_ref);
+		// now let's loop and require!
+		foreach ($hooks_ref as $path) {
+			require_once($path);
+		}
+		// make sure we have menu slugs global setup. Used in EE_Admin_Page->page_setup() to ensure we don't do a full class load for an admin page that isn't requested.
+		global $ee_menu_slugs;
+		$ee_menu_slugs = $this->_menu_slugs;
+		// we need to loop again to run any early code
+		foreach ($this->_installed_pages as $page) {
+			$page->do_initial_loads();
+		}
+		$this->menu_manager->setInstalledPages($menu_pages);
+		do_action('AHEE__EE_Admin_Page_Loader___get_installed_pages_loaded', $this->_installed_pages);
+	}
+
+
+	/**
+	 * @return array
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPages(): array
+	{
+
+		// grab everything in the  admin core directory
+		$admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+		$admin_page_folders = apply_filters(
+			'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
+			$admin_page_folders
+		);
+		if (! empty($admin_page_folders)) {
+			return $admin_page_folders;
+		}
+		$error_msg = esc_html__(
+			'There are no EE_Admin pages detected, it looks like EE did not install properly',
+			'event_espresso'
+		);
+		$error_msg .= '||';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Check that the %s folder exists and is writable. Maybe try deactivating, then reactivating Event Espresso again.',
+				'event_espresso'
+			),
+			EE_ADMIN_PAGES
+		);
+		throw new RuntimeException($error_msg);
+	}
+
+
+	/**
+	 * get_admin_page_object
+	 *
+	 * @param string $page_slug
+	 * @return EE_Admin_Page
+	 */
+	public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
+	{
+		return isset($this->_installed_pages[ $page_slug ])
+			   && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
+			? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+			: null;
+	}
+
+
+	/**
+	 * generates an "Admin Page Init" class based on the directory  name
+	 *
+	 * @param string $dir_name
+	 * @return string
+	 */
+	private function getClassnameForAdminPageInit(string $dir_name = ''): string
+	{
+		$class_name = str_replace('_', ' ', strtolower($dir_name));
+		return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+	}
+
+
+	/**
+	 * _load_admin_page
+	 * Loads and instantiates page_init object for a single EE_admin page.
+	 *
+	 * @param string $page page_reference
+	 * @return EE_Admin_Page_Init
+	 * @throws EE_Error
+	 */
+	private function loadAdminPageInit(string $page = ''): EE_Admin_Page_Init
+	{
+		$class_name = $this->getClassnameForAdminPageInit($page);
+		if (class_exists($class_name)) {
+			$admin_page_init = $this->loader->getShared($class_name);
+			// verify returned object
+			if ($admin_page_init instanceof EE_Admin_Page_Init) {
+				return $admin_page_init;
+			}
+		}
+		$error_msg = sprintf(
+			esc_html__('Something went wrong with loading the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '||'; // separates public from developer messages
+		$error_msg .= "\r\n";
+		$error_msg .= sprintf(
+			esc_html__('There is no Init class in place for the %s admin page.', 'event_espresso'),
+			$page
+		);
+		$error_msg .= '<br />';
+		$error_msg .= sprintf(
+			esc_html__(
+				'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
+				'event_espresso'
+			),
+			'<strong>' . $class_name . '</strong>'
+		);
+		throw new EE_Error($error_msg);
+	}
+
+
+	/**
+	 * This method is the "workhorse" for detecting and setting up caffeinated functionality.
+	 * In this method there are three checks being done:
+	 * 1. Do we have any NEW admin page sets.  If we do, lets add them into the menu setup (via the $admin_pages
+	 * array) etc.  (new page sets are found in caffeinated/new/{page})
+	 * 2. Do we have any EXTENDED page sets.  Basically an extended EE_Admin Page extends the core {child}_Admin_Page
+	 * class.  eg. would be caffeinated/extend/events/Extend_Events_Admin_Page.core.php and in there would be a class:
+	 * Extend_Events_Admin_Page extends Events_Admin_Page.
+	 * 3. Do we have any files just for setting up hooks into other core pages.  The files can be any name in
+	 * "caffeinated/hooks" EXCEPT they need a ".class.php" extension and the file name must correspond with the
+	 * classname inside.  These classes are instantiated really early so that any hooks in them are run before the
+	 * corresponding apply_filters/do_actions that are found in any future loaded EE_Admin pages (INCLUDING caffeinated
+	 * admin_pages)
+	 *
+	 * @param array $admin_pages the original installed_refs array that may contain our NEW EE_Admin_Pages to be
+	 *                              loaded.
+	 * @return array
+	 * @throws EE_Error
+	 */
+	private function findCaffeinatedAdminPages(array $admin_pages): array
+	{
+		// first let's check if there IS a caffeinated folder. If there is not then lets get out.
+		if ((defined('EE_DECAF') && EE_DECAF) || ! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin')) {
+			return $admin_pages;
+		}
+		$this->defineCaffeinatedConstants();
+		// okay let's setup an "New" pages first (we'll return installed refs later)
+		$admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', ['tickets']);
+
+		return apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
+			$admin_pages
+		);
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPageExtensions()
+	{
+		// let's see if there are any EXTENDS to setup in the $_caffeinated_extends array
+		// (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
+		$extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+		if ($extensions) {
+			foreach ($extensions as $folder => $extension) {
+				// convert lowercase_snake_case to Uppercase_Snake_Case
+				$filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
+				$filename = "Extend_{$filename}_Admin_Page";
+				$filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+				// save filename and filepath for later
+				$this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
+				$this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+			}
+		}
+		$this->_caffeinated_extends = apply_filters(
+			'FHEE__EE_Admin_Page_Loader___get_installed_pages__caffeinated_extends',
+			$this->_caffeinated_extends
+		);
+	}
+
+
+	private function loadCaffeinatedExtensions(
+		EE_Admin_Page_Init $admin_page_init,
+		string $page,
+		string $menu_slug
+	): bool {
+		if (! isset($this->_caffeinated_extends[ $page ])) {
+			return false;
+		}
+		$admin_page_name = $admin_page_init->get_admin_page_name();
+		$caf_path        = $this->_caffeinated_extends[ $page ]['path'];
+		$caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
+			static function ($path_to_file) use ($caf_path) {
+				return $caf_path;
+			}
+		);
+		add_filter(
+			"FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
+			static function ($admin_page) use ($caf_admin_page) {
+				return $caf_admin_page;
+			}
+		);
+		return true;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function findAdminPageHooks()
+	{
+		// let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
+		$ee_admin_hooks   = [];
+		$admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+		if ($admin_page_hooks) {
+			foreach ($admin_page_hooks as $hook) {
+				if (is_readable($hook)) {
+					require_once $hook;
+					$classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+					if (class_exists($classname)) {
+						$ee_admin_hooks[] = $this->loader->getShared($classname);
+					}
+				}
+			}
+		}
+		apply_filters('FHEE__EE_Admin_Page_Loader__set_caffeinated__ee_admin_hooks', $ee_admin_hooks);
+	}
+
+
+	/**
+	 * _default_header_link
+	 * This is just a dummy method to use with header submenu items
+	 *
+	 * @return bool false
+	 */
+	public function _default_header_link(): bool
+	{
+		return false;
+	}
+
+
+	/**
+	 * @param string $path
+	 * @param int    $flags
+	 * @param array  $exclude
+	 * @param bool   $register_autoloaders
+	 * @return array
+	 * @throws EE_Error
+	 * @since 5.0.0.p
+	 */
+	private function findAdminPageFolders(
+		string $path,
+		array $exclude = [],
+		int $flags = GLOB_ONLYDIR,
+		bool $register_autoloaders = true
+	): array {
+		$folders = [];
+		$subfolders = glob($path, $flags);
+		if ($subfolders) {
+			foreach ($subfolders as $admin_screen) {
+				$admin_screen_name = basename($admin_screen);
+				// files and anything in the exclude array need not apply
+				if (! in_array($admin_screen_name, $exclude, true)) {
+					// these folders represent the different EE admin pages
+					$folders[ $admin_screen_name ] = $admin_screen;
+					if ($register_autoloaders) {
+						// set autoloaders for our admin page classes based on included path information
+						EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);
+					}
+				}
+			}
+		}
+		return $folders;
+	}
 }

Spacing +36 added lines, -36 removed lines

@@ -105,13 +105,13 @@ 
      */
     private function defineCaffeinatedConstants()
     {
-        if (! defined('EE_CORE_CAF_ADMIN')) {
-            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL . 'caffeinated/admin/');
-            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN . 'new/');
-            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN . 'extend/');
-            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL . 'extend/');
-            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN . 'hooks/');
+        if ( ! defined('EE_CORE_CAF_ADMIN')) {
+            define('EE_CORE_CAF_ADMIN', EE_PLUGIN_DIR_PATH.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_URL', EE_PLUGIN_DIR_URL.'caffeinated/admin/');
+            define('EE_CORE_CAF_ADMIN_NEW', EE_CORE_CAF_ADMIN.'new/');
+            define('EE_CORE_CAF_ADMIN_EXTEND', EE_CORE_CAF_ADMIN.'extend/');
+            define('EE_CORE_CAF_ADMIN_EXTEND_URL', EE_CORE_CAF_ADMIN_URL.'extend/');
+            define('EE_CORE_CAF_ADMIN_HOOKS', EE_CORE_CAF_ADMIN.'hooks/');
         }
     }
 
@@ -142,24 +142,24 @@ 
         foreach ($admin_pages as $page => $path) {
             // don't load the page init class IF IT's ALREADY LOADED !!!
             if (
-                isset($this->_installed_pages[ $page ])
-                && $this->_installed_pages[ $page ] instanceof EE_Admin_Page_Init
+                isset($this->_installed_pages[$page])
+                && $this->_installed_pages[$page] instanceof EE_Admin_Page_Init
             ) {
                 continue;
             }
             // build list of installed pages
             $admin_page_init = $this->loadAdminPageInit($page);
-            $this->_installed_pages[ $page ] = $admin_page_init;
+            $this->_installed_pages[$page] = $admin_page_init;
             $admin_menu = $this->menu_manager->getAdminMenu($admin_page_init);
             $admin_page_init->setCapability($admin_menu->capability(), $admin_menu->menuSlug());
             // skip if in full maintenance mode and maintenance_mode_parent is NOT set
             if ($this->full_site_maintenance && ! $admin_menu->maintenanceModeParent()) {
-                unset($admin_pages[ $page ]);
+                unset($admin_pages[$page]);
                 continue;
             }
             $menu_slug = $admin_menu->menuSlug();
-            $this->_menu_slugs[ $menu_slug ] = $page;
-            $menu_pages[ $menu_slug ] = $admin_page_init;
+            $this->_menu_slugs[$menu_slug] = $page;
+            $menu_pages[$menu_slug] = $admin_page_init;
             // now that we've got the admin_init objects...
             // lets see if there are any caffeinated pages extending the originals.
             // If there are then let's hook into the init admin filter and load our extend instead.
@@ -167,7 +167,7 @@ 
             $extended_hooks = $admin_page_init->register_hooks(
                 $this->loadCaffeinatedExtensions($admin_page_init, $page, $menu_slug)
             );
-            $hooks_ref      += $extended_hooks;
+            $hooks_ref += $extended_hooks;
         }
         // the hooks_ref is all the pages where we have $extended _Hooks files
         // that will extend a class in a different folder.
@@ -199,12 +199,12 @@ 
     {
 
         // grab everything in the  admin core directory
-        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES . '*');
+        $admin_page_folders = $this->findAdminPageFolders(EE_ADMIN_PAGES.'*');
         $admin_page_folders = apply_filters(
             'FHEE__EE_Admin_Page_Loader__findAdminPages__admin_page_folders',
             $admin_page_folders
         );
-        if (! empty($admin_page_folders)) {
+        if ( ! empty($admin_page_folders)) {
             return $admin_page_folders;
         }
         $error_msg = esc_html__(
@@ -231,9 +231,9 @@ 
      */
     public function get_admin_page_object(string $page_slug = ''): ?EE_Admin_Page
     {
-        return isset($this->_installed_pages[ $page_slug ])
-               && $this->_installed_pages[ $page_slug ] instanceof EE_Admin_Page_Init
-            ? $this->_installed_pages[ $page_slug ]->loaded_page_object()
+        return isset($this->_installed_pages[$page_slug])
+               && $this->_installed_pages[$page_slug] instanceof EE_Admin_Page_Init
+            ? $this->_installed_pages[$page_slug]->loaded_page_object()
             : null;
     }
 
@@ -247,7 +247,7 @@ 
     private function getClassnameForAdminPageInit(string $dir_name = ''): string
     {
         $class_name = str_replace('_', ' ', strtolower($dir_name));
-        return str_replace(' ', '_', ucwords($class_name)) . '_Admin_Page_Init';
+        return str_replace(' ', '_', ucwords($class_name)).'_Admin_Page_Init';
     }
 
 
@@ -285,7 +285,7 @@ 
                 'Make sure you have %1$s defined. If this is a non-EE-core admin page then you also must have an autoloader in place for your class',
                 'event_espresso'
             ),
-            '<strong>' . $class_name . '</strong>'
+            '<strong>'.$class_name.'</strong>'
         );
         throw new EE_Error($error_msg);
     }
@@ -313,12 +313,12 @@ 
     private function findCaffeinatedAdminPages(array $admin_pages): array
     {
         // first let's check if there IS a caffeinated folder. If there is not then lets get out.
-        if ((defined('EE_DECAF') && EE_DECAF) || ! is_dir(EE_PLUGIN_DIR_PATH . 'caffeinated/admin')) {
+        if ((defined('EE_DECAF') && EE_DECAF) || ! is_dir(EE_PLUGIN_DIR_PATH.'caffeinated/admin')) {
             return $admin_pages;
         }
         $this->defineCaffeinatedConstants();
         // okay let's setup an "New" pages first (we'll return installed refs later)
-        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'new/*', ['tickets']);
+        $admin_pages += $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'new/*', ['tickets']);
 
         return apply_filters(
             'FHEE__EE_Admin_Page_Loader___get_installed_pages__installed_refs',
@@ -335,16 +335,16 @@ 
     {
         // let's see if there are any EXTENDS to setup in the $_caffeinated_extends array
         // (that will be used later for hooking into the _initialize_admin_age in the related core_init admin page)
-        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'extend/*');
+        $extensions = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'extend/*');
         if ($extensions) {
             foreach ($extensions as $folder => $extension) {
                 // convert lowercase_snake_case to Uppercase_Snake_Case
                 $filename = str_replace(' ', '_', ucwords(str_replace('_', ' ', $folder)));
                 $filename = "Extend_{$filename}_Admin_Page";
-                $filepath = EE_CORE_CAF_ADMIN . "extend/$folder/$filename.core.php";
+                $filepath = EE_CORE_CAF_ADMIN."extend/$folder/$filename.core.php";
                 // save filename and filepath for later
-                $this->_caffeinated_extends[ $folder ]['path']       = str_replace(['\\', '/'], '/', $filepath);
-                $this->_caffeinated_extends[ $folder ]['admin_page'] = $filename;
+                $this->_caffeinated_extends[$folder]['path']       = str_replace(['\\', '/'], '/', $filepath);
+                $this->_caffeinated_extends[$folder]['admin_page'] = $filename;
             }
         }
         $this->_caffeinated_extends = apply_filters(
@@ -359,21 +359,21 @@ 
         string $page,
         string $menu_slug
     ): bool {
-        if (! isset($this->_caffeinated_extends[ $page ])) {
+        if ( ! isset($this->_caffeinated_extends[$page])) {
             return false;
         }
         $admin_page_name = $admin_page_init->get_admin_page_name();
-        $caf_path        = $this->_caffeinated_extends[ $page ]['path'];
-        $caf_admin_page  = $this->_caffeinated_extends[ $page ]['admin_page'];
+        $caf_path        = $this->_caffeinated_extends[$page]['path'];
+        $caf_admin_page  = $this->_caffeinated_extends[$page]['admin_page'];
         add_filter(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__path_to_file__{$menu_slug}_$admin_page_name",
-            static function ($path_to_file) use ($caf_path) {
+            static function($path_to_file) use ($caf_path) {
                 return $caf_path;
             }
         );
         add_filter(
             "FHEE__EE_Admin_Page_Init___initialize_admin_page__admin_page__{$menu_slug}_$admin_page_name",
-            static function ($admin_page) use ($caf_admin_page) {
+            static function($admin_page) use ($caf_admin_page) {
                 return $caf_admin_page;
             }
         );
@@ -389,12 +389,12 @@ 
     {
         // let's see if there are any HOOK files and instantiate them if there are (so that hooks are loaded early!).
         $ee_admin_hooks   = [];
-        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN . 'hooks/*.class.php', [], 0, false);
+        $admin_page_hooks = $this->findAdminPageFolders(EE_CORE_CAF_ADMIN.'hooks/*.class.php', [], 0, false);
         if ($admin_page_hooks) {
             foreach ($admin_page_hooks as $hook) {
                 if (is_readable($hook)) {
                     require_once $hook;
-                    $classname = str_replace([EE_CORE_CAF_ADMIN . 'hooks/', '.class.php'], '', $hook);
+                    $classname = str_replace([EE_CORE_CAF_ADMIN.'hooks/', '.class.php'], '', $hook);
                     if (class_exists($classname)) {
                         $ee_admin_hooks[] = $this->loader->getShared($classname);
                     }
@@ -438,9 +438,9 @@ 
             foreach ($subfolders as $admin_screen) {
                 $admin_screen_name = basename($admin_screen);
                 // files and anything in the exclude array need not apply
-                if (! in_array($admin_screen_name, $exclude, true)) {
+                if ( ! in_array($admin_screen_name, $exclude, true)) {
                     // these folders represent the different EE admin pages
-                    $folders[ $admin_screen_name ] = $admin_screen;
+                    $folders[$admin_screen_name] = $admin_screen;
                     if ($register_autoloaders) {
                         // set autoloaders for our admin page classes based on included path information
                         EEH_Autoloader::register_autoloaders_for_each_file_in_folder($admin_screen);

core/EE_Addon.core.php

Indentation +859 added lines, -859 removed lines

@@ -20,870 +20,870 @@
  */
 abstract class EE_Addon extends EE_Configurable implements RequiresDependencyMapInterface, RequiresDomainInterface
 {
-    /**
-     * prefix to be added onto an addon's plugin slug to make a wp option name
-     * which will be used to store the plugin's activation history
-     */
-    const ee_addon_version_history_option_prefix = 'ee_version_history_';
-
-    /**
-     * @var $_version
-     * @type string
-     */
-    protected $_version = '';
-
-    /**
-     * @var $_min_core_version
-     * @type string
-     */
-    protected $_min_core_version = '';
-
-    /**
-     * derived from plugin 'main_file_path using plugin_basename()
-     *
-     * @type string $_plugin_basename
-     */
-    protected $_plugin_basename = '';
-
-    /**
-     * A non-internationalized name to identify this addon for use in URLs, etc
-     *
-     * @type string $_plugin_slug
-     */
-    protected $_plugin_slug = '';
-
-    /**
-     * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
-     *
-     * @type string _addon_name
-     */
-    protected $_addon_name = '';
-
-    /**
-     * one of the EE_System::req_type_* constants
-     *
-     * @type int $_req_type
-     */
-    protected $_req_type;
-
-    /**
-     * page slug to be used when generating the "Settings" link on the WP plugin page
-     *
-     * @type string $_plugin_action_slug
-     */
-    protected $_plugin_action_slug = '';
-
-    /**
-     * 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
-     *
-     * @type array $_plugins_page_row
-     */
-    protected $_plugins_page_row = [];
-
-
-    /**
-     *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
-     *
-     * @type string
-     */
-    protected $_main_plugin_file;
-
-    /**
-     *    This is the slug used to identify this add-on within the plugin update engine.
-     *
-     * @type string
-     */
-    protected $pue_slug = '';
-
-
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    private $dependency_map;
-
-
-    /**
-     * @var DomainInterface $domain
-     */
-    private $domain;
-
-
-    /**
-     * @param EE_Dependency_Map|null $dependency_map [optional]
-     * @param DomainInterface|null   $domain         [optional]
-     */
-    public function __construct(EE_Dependency_Map $dependency_map = null, DomainInterface $domain = null)
-    {
-        if ($dependency_map instanceof EE_Dependency_Map) {
-            $this->setDependencyMap($dependency_map);
-        }
-        if ($domain instanceof DomainInterface) {
-            $this->setDomain($domain);
-        }
-        add_action('AHEE__EE_System__load_controllers__load_admin_controllers', [$this, 'admin_init']);
-    }
-
-
-    /**
-     * @param EE_Dependency_Map $dependency_map
-     */
-    public function setDependencyMap($dependency_map)
-    {
-        $this->dependency_map = $dependency_map;
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function dependencyMap(): ?EE_Dependency_Map
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @param DomainInterface $domain
-     */
-    public function setDomain(DomainInterface $domain)
-    {
-        $this->domain = $domain;
-    }
-
-
-    /**
-     * @return DomainInterface
-     */
-    public function domain(): ?DomainInterface
-    {
-        return $this->domain;
-    }
-
-
-    /**
-     * @param string $version
-     */
-    public function set_version(string $version = '')
-    {
-        $this->_version = $version;
-    }
-
-
-    /**
-     * get__version
-     *
-     * @return string
-     */
-    public function version(): string
-    {
-        return $this->_version;
-    }
-
-
-    /**
-     * @param mixed $min_core_version
-     */
-    public function set_min_core_version($min_core_version = null)
-    {
-        $this->_min_core_version = $min_core_version;
-    }
-
-
-    /**
-     * get__min_core_version
-     *
-     * @return string
-     */
-    public function min_core_version(): string
-    {
-        return $this->_min_core_version;
-    }
-
-
-    /**
-     * Sets addon_name
-     *
-     * @param string $addon_name
-     */
-    public function set_name(string $addon_name)
-    {
-        $this->_addon_name = $addon_name;
-    }
-
-
-    /**
-     * Gets addon_name
-     *
-     * @return string
-     */
-    public function name()
-    {
-        return $this->_addon_name;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_basename(): string
-    {
-
-        return $this->_plugin_basename;
-    }
-
-
-    /**
-     * @param string $plugin_basename
-     */
-    public function set_plugin_basename(string $plugin_basename)
-    {
-
-        $this->_plugin_basename = $plugin_basename;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_slug(): string
-    {
-
-        return $this->_plugin_slug;
-    }
-
-
-    /**
-     * @param string $plugin_slug
-     */
-    public function set_plugin_slug(string $plugin_slug)
-    {
-
-        $this->_plugin_slug = $plugin_slug;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function plugin_action_slug(): string
-    {
-
-        return $this->_plugin_action_slug;
-    }
-
-
-    /**
-     * @param string $plugin_action_slug
-     */
-    public function set_plugin_action_slug(string $plugin_action_slug)
-    {
-
-        $this->_plugin_action_slug = $plugin_action_slug;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_plugins_page_row(): array
-    {
-
-        return $this->_plugins_page_row;
-    }
-
-
-    /**
-     * @param array|string $plugins_page_row
-     */
-    public function set_plugins_page_row(array $plugins_page_row = [])
-    {
-        // sigh.... check for example content that I stupidly merged to master and remove it if found
-        if (
-            ! is_array($plugins_page_row)
-            && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
-        ) {
-            $plugins_page_row = [];
-        }
-        $this->_plugins_page_row = (array) $plugins_page_row;
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been activated for the first time.
-     * If the site isn't in maintenance mode, should setup the addon's database
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function new_install()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__new_install");
-        do_action('AHEE__EE_Addon__new_install', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * Called when EE core detects this addon has been reactivated. When this happens,
-     * it's good to just check that your data is still intact
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function reactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__reactivation");
-        do_action('AHEE__EE_Addon__reactivation', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * Called when the registered deactivation hook for this addon fires.
-     *
-     * @throws EE_Error
-     */
-    public function deactivation()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__deactivation");
-        do_action('AHEE__EE_Addon__deactivation', $this);
-        // check if the site no longer needs to be in maintenance mode
-        EE_Register_Addon::deregister($this->name());
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-    }
-
-
-    /**
-     * Takes care of double-checking that we're not in maintenance mode, and then
-     * initializing this addon's necessary initial data. This is called by default on new activations
-     * and reactivations.
-     *
-     * @param bool $verify_schema whether to verify the database's schema for this addon, or just its data.
-     *                               This is a resource-intensive job so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function initialize_db_if_no_migrations_required($verify_schema = true)
-    {
-        if ($verify_schema === '') {
-            // wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
-            // (ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
-            // calls them with an argument of an empty string (ie ""), which evaluates to false
-            // so we need to treat the empty string as if nothing had been passed, and should instead use the default
-            $verify_schema = true;
-        }
-        if (DbStatus::isOnline()) {
-            if ($verify_schema) {
-                $this->initialize_db();
-            }
-            $this->initialize_default_data();
-            // @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
-            EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-                [
-                    'slug'    => $this->name(),
-                    'version' => $this->version(),
-                ]
-            );
-            /* make sure core's data is a-ok
+	/**
+	 * prefix to be added onto an addon's plugin slug to make a wp option name
+	 * which will be used to store the plugin's activation history
+	 */
+	const ee_addon_version_history_option_prefix = 'ee_version_history_';
+
+	/**
+	 * @var $_version
+	 * @type string
+	 */
+	protected $_version = '';
+
+	/**
+	 * @var $_min_core_version
+	 * @type string
+	 */
+	protected $_min_core_version = '';
+
+	/**
+	 * derived from plugin 'main_file_path using plugin_basename()
+	 *
+	 * @type string $_plugin_basename
+	 */
+	protected $_plugin_basename = '';
+
+	/**
+	 * A non-internationalized name to identify this addon for use in URLs, etc
+	 *
+	 * @type string $_plugin_slug
+	 */
+	protected $_plugin_slug = '';
+
+	/**
+	 * A non-internationalized name to identify this addon. Eg 'Calendar','MailChimp',etc/
+	 *
+	 * @type string _addon_name
+	 */
+	protected $_addon_name = '';
+
+	/**
+	 * one of the EE_System::req_type_* constants
+	 *
+	 * @type int $_req_type
+	 */
+	protected $_req_type;
+
+	/**
+	 * page slug to be used when generating the "Settings" link on the WP plugin page
+	 *
+	 * @type string $_plugin_action_slug
+	 */
+	protected $_plugin_action_slug = '';
+
+	/**
+	 * 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
+	 *
+	 * @type array $_plugins_page_row
+	 */
+	protected $_plugins_page_row = [];
+
+
+	/**
+	 *    filepath to the main file, which can be used for register_activation_hook, register_deactivation_hook, etc.
+	 *
+	 * @type string
+	 */
+	protected $_main_plugin_file;
+
+	/**
+	 *    This is the slug used to identify this add-on within the plugin update engine.
+	 *
+	 * @type string
+	 */
+	protected $pue_slug = '';
+
+
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	private $dependency_map;
+
+
+	/**
+	 * @var DomainInterface $domain
+	 */
+	private $domain;
+
+
+	/**
+	 * @param EE_Dependency_Map|null $dependency_map [optional]
+	 * @param DomainInterface|null   $domain         [optional]
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map = null, DomainInterface $domain = null)
+	{
+		if ($dependency_map instanceof EE_Dependency_Map) {
+			$this->setDependencyMap($dependency_map);
+		}
+		if ($domain instanceof DomainInterface) {
+			$this->setDomain($domain);
+		}
+		add_action('AHEE__EE_System__load_controllers__load_admin_controllers', [$this, 'admin_init']);
+	}
+
+
+	/**
+	 * @param EE_Dependency_Map $dependency_map
+	 */
+	public function setDependencyMap($dependency_map)
+	{
+		$this->dependency_map = $dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function dependencyMap(): ?EE_Dependency_Map
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @param DomainInterface $domain
+	 */
+	public function setDomain(DomainInterface $domain)
+	{
+		$this->domain = $domain;
+	}
+
+
+	/**
+	 * @return DomainInterface
+	 */
+	public function domain(): ?DomainInterface
+	{
+		return $this->domain;
+	}
+
+
+	/**
+	 * @param string $version
+	 */
+	public function set_version(string $version = '')
+	{
+		$this->_version = $version;
+	}
+
+
+	/**
+	 * get__version
+	 *
+	 * @return string
+	 */
+	public function version(): string
+	{
+		return $this->_version;
+	}
+
+
+	/**
+	 * @param mixed $min_core_version
+	 */
+	public function set_min_core_version($min_core_version = null)
+	{
+		$this->_min_core_version = $min_core_version;
+	}
+
+
+	/**
+	 * get__min_core_version
+	 *
+	 * @return string
+	 */
+	public function min_core_version(): string
+	{
+		return $this->_min_core_version;
+	}
+
+
+	/**
+	 * Sets addon_name
+	 *
+	 * @param string $addon_name
+	 */
+	public function set_name(string $addon_name)
+	{
+		$this->_addon_name = $addon_name;
+	}
+
+
+	/**
+	 * Gets addon_name
+	 *
+	 * @return string
+	 */
+	public function name()
+	{
+		return $this->_addon_name;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_basename(): string
+	{
+
+		return $this->_plugin_basename;
+	}
+
+
+	/**
+	 * @param string $plugin_basename
+	 */
+	public function set_plugin_basename(string $plugin_basename)
+	{
+
+		$this->_plugin_basename = $plugin_basename;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_slug(): string
+	{
+
+		return $this->_plugin_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_slug
+	 */
+	public function set_plugin_slug(string $plugin_slug)
+	{
+
+		$this->_plugin_slug = $plugin_slug;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function plugin_action_slug(): string
+	{
+
+		return $this->_plugin_action_slug;
+	}
+
+
+	/**
+	 * @param string $plugin_action_slug
+	 */
+	public function set_plugin_action_slug(string $plugin_action_slug)
+	{
+
+		$this->_plugin_action_slug = $plugin_action_slug;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_plugins_page_row(): array
+	{
+
+		return $this->_plugins_page_row;
+	}
+
+
+	/**
+	 * @param array|string $plugins_page_row
+	 */
+	public function set_plugins_page_row(array $plugins_page_row = [])
+	{
+		// sigh.... check for example content that I stupidly merged to master and remove it if found
+		if (
+			! is_array($plugins_page_row)
+			&& strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
+		) {
+			$plugins_page_row = [];
+		}
+		$this->_plugins_page_row = (array) $plugins_page_row;
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been activated for the first time.
+	 * If the site isn't in maintenance mode, should setup the addon's database
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function new_install()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__new_install");
+		do_action('AHEE__EE_Addon__new_install', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * Called when EE core detects this addon has been reactivated. When this happens,
+	 * it's good to just check that your data is still intact
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function reactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__reactivation");
+		do_action('AHEE__EE_Addon__reactivation', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * Called when the registered deactivation hook for this addon fires.
+	 *
+	 * @throws EE_Error
+	 */
+	public function deactivation()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__deactivation");
+		do_action('AHEE__EE_Addon__deactivation', $this);
+		// check if the site no longer needs to be in maintenance mode
+		EE_Register_Addon::deregister($this->name());
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+	}
+
+
+	/**
+	 * Takes care of double-checking that we're not in maintenance mode, and then
+	 * initializing this addon's necessary initial data. This is called by default on new activations
+	 * and reactivations.
+	 *
+	 * @param bool $verify_schema whether to verify the database's schema for this addon, or just its data.
+	 *                               This is a resource-intensive job so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function initialize_db_if_no_migrations_required($verify_schema = true)
+	{
+		if ($verify_schema === '') {
+			// wp core bug imo: if no args are passed to `do_action('some_hook_name')` besides the hook's name
+			// (ie, no 2nd or 3rd arguments), instead of calling the registered callbacks with no arguments, it
+			// calls them with an argument of an empty string (ie ""), which evaluates to false
+			// so we need to treat the empty string as if nothing had been passed, and should instead use the default
+			$verify_schema = true;
+		}
+		if (DbStatus::isOnline()) {
+			if ($verify_schema) {
+				$this->initialize_db();
+			}
+			$this->initialize_default_data();
+			// @todo: this will probably need to be adjusted in 4.4 as the array changed formats I believe
+			EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+				[
+					'slug'    => $this->name(),
+					'version' => $this->version(),
+				]
+			);
+			/* make sure core's data is a-ok
              * (at the time of writing, we especially want to verify all the caps are present
              * because payment method type capabilities are added dynamically, and it's
              * possible this addon added a payment method. But it's also possible
              * other data needs to be verified)
              */
-            EEH_Activation::initialize_db_content();
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = LoaderFactory::getLoader()->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flushRewriteRules();
-            // in case there are lots of addons being activated at once, let's force garbage collection
-            // to help avoid memory limit errors
-            // EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
-            gc_collect_cycles();
-        } else {
-            // ask the data migration manager to init this addon's data
-            // when migrations are finished because we can't do it now
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
-        }
-    }
-
-
-    /**
-     * Used to setup this addon's database tables, but not necessarily any default
-     * data in them. The default is to actually use the most up-to-date data migration script
-     * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
-     * methods to setup the db.
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function initialize_db()
-    {
-        // find the migration script that sets the database to be compatible with the code
-        $current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
-        if ($current_dms_name) {
-            $current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
-            $current_data_migration_script->set_migrating(false);
-            $current_data_migration_script->schema_changes_before_migration();
-            $current_data_migration_script->schema_changes_after_migration();
-            if ($current_data_migration_script->get_errors()) {
-                foreach ($current_data_migration_script->get_errors() as $error) {
-                    EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
-                }
-            }
-        }
-        // if not DMS was found that should be ok. This addon just doesn't require any database changes
-        EE_Data_Migration_Manager::instance()->update_current_database_state_to(
-            [
-                'slug'    => $this->name(),
-                'version' => $this->version(),
-            ]
-        );
-    }
-
-
-    /**
-     * If you want to setup default data for the addon, override this method, and call
-     * parent::initialize_default_data() from within it. This is normally called
-     * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
-     * and should verify default data is present (but this is also called
-     * on reactivations and just after migrations, so please verify you actually want
-     * to ADD default data, because it may already be present).
-     * However, please call this parent (currently it just fires a hook which other
-     * addons may be depending on)
-     */
-    public function initialize_default_data()
-    {
-        /**
-         * Called when an addon is ensuring its default data is set (possibly called
-         * on a reactivation, so first check for the absence of other data before setting
-         * default data)
-         *
-         * @param EE_Addon $addon the addon that called this
-         */
-        do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
-        // override to insert default data. It is safe to use the models here
-        // because the site should not be in maintenance mode
-    }
-
-
-    /**
-     * EE Core detected that this addon has been upgraded. We should check if there
-     * are any new migration scripts, and if so put the site into maintenance mode until
-     * they're ran
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function upgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__upgrade");
-        do_action('AHEE__EE_Addon__upgrade', $this);
-        EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
-        // also it's possible there is new default data that needs to be added
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
-     */
-    public function downgrade()
-    {
-        $classname = get_class($this);
-        do_action("AHEE__{$classname}__downgrade");
-        do_action('AHEE__EE_Addon__downgrade', $this);
-        // it's possible there's old default data that needs to be double-checked
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * set_db_update_option_name
-     * Until we do something better, we'll just check for migration scripts upon
-     * plugin activation only. In the future, we'll want to do it on plugin updates too
-     *
-     * @return bool
-     */
-    public function set_db_update_option_name(): bool
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return $this->set_activation_indicator_option();
-    }
-
-
-    /**
-     * Returns the name of the activation indicator option
-     * (an option which is set temporarily to indicate that this addon was just activated)
-     *
-     * @return string
-     * @deprecated since version 4.3.0.alpha.016
-     */
-    public function get_db_update_option_name(): string
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
-                'event_espresso'
-            ),
-            '4.3.0.alpha.016'
-        );
-        return $this->get_activation_indicator_option_name();
-    }
-
-
-    /**
-     * When the addon is activated, this should be called to set a wordpress option that
-     * indicates it was activated. This is especially useful for detecting reactivations.
-     *
-     * @return bool
-     */
-    public function set_activation_indicator_option(): bool
-    {
-        // let's just handle this on the next request, ok? right now we're just not really ready
-        return update_option($this->get_activation_indicator_option_name(), true);
-    }
-
-
-    /**
-     * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
-     *
-     * @return string
-     */
-    public function get_activation_indicator_option_name(): string
-    {
-        return 'ee_activation_' . $this->name();
-    }
-
-
-    /**
-     * Used by EE_System to set the request type of this addon. Should not be used by addon developers
-     *
-     * @param int $req_type
-     */
-    public function set_req_type(int $req_type)
-    {
-        $this->_req_type = $req_type;
-    }
-
-
-    /**
-     * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
-     * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
-     * EE_System when it is checking for new install or upgrades of addons
-     */
-    public function detect_req_type($redetect = false): int
-    {
-        if ($this->_req_type === null || $redetect) {
-            $this->detect_activation_or_upgrade();
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
-     * Should only be called once per request
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function detect_activation_or_upgrade()
-    {
-        $activation_history_for_addon = $this->get_activation_history();
-        $request_type                 = EE_System::detect_req_type_given_activation_history(
-            $activation_history_for_addon,
-            $this->get_activation_indicator_option_name(),
-            $this->version()
-        );
-        $this->set_req_type($request_type);
-        $classname = get_class($this);
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
-                $this->new_install();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
-                $this->reactivation();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
-                $this->upgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
-                do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
-                $this->downgrade();
-                $this->update_list_of_installed_versions($activation_history_for_addon);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-
-        do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
-    }
-
-
-    /**
-     * Updates the version history for this addon
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add
-     * @return bool success
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
-    {
-        if (! $version_history) {
-            $version_history = $this->get_activation_history();
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = $this->version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        return update_option($this->get_activation_history_option_name(), $version_history);
-    }
-
-
-    /**
-     * Gets the name of the wp option that stores the activation history
-     * of this addon
-     *
-     * @return string
-     */
-    public function get_activation_history_option_name(): string
-    {
-        return self::ee_addon_version_history_option_prefix . $this->name();
-    }
-
-
-    /**
-     * Gets the wp option which stores the activation history for this addon
-     *
-     * @return array
-     */
-    public function get_activation_history(): array
-    {
-        return get_option($this->get_activation_history_option_name(), []);
-    }
-
-
-    /**
-     * @param string $config_section
-     */
-    public function set_config_section($config_section = '')
-    {
-        $this->_config_section = ! empty($config_section) ? $config_section : 'addons';
-    }
-
-
-    /**
-     * Sets the filepath to the main plugin file
-     *
-     * @param string $filepath
-     */
-    public function set_main_plugin_file(string $filepath)
-    {
-        $this->_main_plugin_file = $filepath;
-    }
-
-
-    /**
-     * gets the filepath to teh main file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file(): string
-    {
-        return $this->_main_plugin_file;
-    }
-
-
-    /**
-     * Gets the filename (no path) of the main file (the main file loaded
-     * by WP)
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_basename(): string
-    {
-        return plugin_basename($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * Gets the folder name which contains the main plugin file
-     *
-     * @return string
-     */
-    public function get_main_plugin_file_dirname(): string
-    {
-        return dirname($this->get_main_plugin_file());
-    }
-
-
-    /**
-     * sets hooks used in the admin
-     *
-     * @return void
-     */
-    public function admin_init()
-    {
-        // is admin and not in M-Mode ?
-        if (is_admin() && MaintenanceStatus::isDisabled()) {
-            add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
-        }
-    }
-
-
-    /**
-     * plugin_actions
-     * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
-     *
-     * @param array  $links
-     * @param string $file
-     * @return array
-     */
-    public function plugin_action_links(array $links, string $file): array
-    {
-        if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
-            // before other links
-            array_unshift(
-                $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
-                . esc_html__('Settings', 'event_espresso')
-                . '</a>'
-            );
-        }
-        return $links;
-    }
-
-
-    /**
-     * after_plugin_row
-     * Add additional content to the plugins page plugin row
-     * Inserts another row
-     *
-     * @param string $plugin_file
-     * @param array  $plugin_data
-     * @param string $status
-     * @return void
-     */
-    public function after_plugin_row(string $plugin_file, array $plugin_data, string $status)
-    {
-        $after_plugin_row = '';
-        $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
-            $class       = $status ? 'active' : 'inactive';
-            $link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
-            $link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
-            $description = isset($plugins_page_row['description'])
-                ? $plugins_page_row['description']
-                : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
-                $after_plugin_row .= '<th class="check-column" scope="row"></th>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
-                $after_plugin_row .= '<p class="ee-addon-upsell-info-dv">
+			EEH_Activation::initialize_db_content();
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = LoaderFactory::getLoader()->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flushRewriteRules();
+			// in case there are lots of addons being activated at once, let's force garbage collection
+			// to help avoid memory limit errors
+			// EEH_Debug_Tools::instance()->measure_memory( 'db content initialized for ' . get_class( $this), true );
+			gc_collect_cycles();
+		} else {
+			// ask the data migration manager to init this addon's data
+			// when migrations are finished because we can't do it now
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for($this->name());
+		}
+	}
+
+
+	/**
+	 * Used to setup this addon's database tables, but not necessarily any default
+	 * data in them. The default is to actually use the most up-to-date data migration script
+	 * for this addon, and just use its schema_changes_before_migration() and schema_changes_after_migration()
+	 * methods to setup the db.
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function initialize_db()
+	{
+		// find the migration script that sets the database to be compatible with the code
+		$current_dms_name = EE_Data_Migration_Manager::instance()->get_most_up_to_date_dms($this->name());
+		if ($current_dms_name) {
+			$current_data_migration_script = EE_Registry::instance()->load_dms($current_dms_name);
+			$current_data_migration_script->set_migrating(false);
+			$current_data_migration_script->schema_changes_before_migration();
+			$current_data_migration_script->schema_changes_after_migration();
+			if ($current_data_migration_script->get_errors()) {
+				foreach ($current_data_migration_script->get_errors() as $error) {
+					EE_Error::add_error($error, __FILE__, __FUNCTION__, __LINE__);
+				}
+			}
+		}
+		// if not DMS was found that should be ok. This addon just doesn't require any database changes
+		EE_Data_Migration_Manager::instance()->update_current_database_state_to(
+			[
+				'slug'    => $this->name(),
+				'version' => $this->version(),
+			]
+		);
+	}
+
+
+	/**
+	 * If you want to setup default data for the addon, override this method, and call
+	 * parent::initialize_default_data() from within it. This is normally called
+	 * from EE_Addon::initialize_db_if_no_migrations_required(), just after EE_Addon::initialize_db()
+	 * and should verify default data is present (but this is also called
+	 * on reactivations and just after migrations, so please verify you actually want
+	 * to ADD default data, because it may already be present).
+	 * However, please call this parent (currently it just fires a hook which other
+	 * addons may be depending on)
+	 */
+	public function initialize_default_data()
+	{
+		/**
+		 * Called when an addon is ensuring its default data is set (possibly called
+		 * on a reactivation, so first check for the absence of other data before setting
+		 * default data)
+		 *
+		 * @param EE_Addon $addon the addon that called this
+		 */
+		do_action('AHEE__EE_Addon__initialize_default_data__begin', $this);
+		// override to insert default data. It is safe to use the models here
+		// because the site should not be in maintenance mode
+	}
+
+
+	/**
+	 * EE Core detected that this addon has been upgraded. We should check if there
+	 * are any new migration scripts, and if so put the site into maintenance mode until
+	 * they're ran
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function upgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__upgrade");
+		do_action('AHEE__EE_Addon__upgrade', $this);
+		EE_Maintenance_Mode::instance()->set_maintenance_mode_if_db_old();
+		// also it's possible there is new default data that needs to be added
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * If Core detects this addon has been downgraded, you may want to invoke some special logic here.
+	 */
+	public function downgrade()
+	{
+		$classname = get_class($this);
+		do_action("AHEE__{$classname}__downgrade");
+		do_action('AHEE__EE_Addon__downgrade', $this);
+		// it's possible there's old default data that needs to be double-checked
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * set_db_update_option_name
+	 * Until we do something better, we'll just check for migration scripts upon
+	 * plugin activation only. In the future, we'll want to do it on plugin updates too
+	 *
+	 * @return bool
+	 */
+	public function set_db_update_option_name(): bool
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::set_db_update_option_name was renamed to EE_Addon::set_activation_indicator_option',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return $this->set_activation_indicator_option();
+	}
+
+
+	/**
+	 * Returns the name of the activation indicator option
+	 * (an option which is set temporarily to indicate that this addon was just activated)
+	 *
+	 * @return string
+	 * @deprecated since version 4.3.0.alpha.016
+	 */
+	public function get_db_update_option_name(): string
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'EE_Addon::get_db_update_option was renamed to EE_Addon::get_activation_indicator_option_name',
+				'event_espresso'
+			),
+			'4.3.0.alpha.016'
+		);
+		return $this->get_activation_indicator_option_name();
+	}
+
+
+	/**
+	 * When the addon is activated, this should be called to set a wordpress option that
+	 * indicates it was activated. This is especially useful for detecting reactivations.
+	 *
+	 * @return bool
+	 */
+	public function set_activation_indicator_option(): bool
+	{
+		// let's just handle this on the next request, ok? right now we're just not really ready
+		return update_option($this->get_activation_indicator_option_name(), true);
+	}
+
+
+	/**
+	 * Gets the name of the wp option which is used to temporarily indicate that this addon was activated
+	 *
+	 * @return string
+	 */
+	public function get_activation_indicator_option_name(): string
+	{
+		return 'ee_activation_' . $this->name();
+	}
+
+
+	/**
+	 * Used by EE_System to set the request type of this addon. Should not be used by addon developers
+	 *
+	 * @param int $req_type
+	 */
+	public function set_req_type(int $req_type)
+	{
+		$this->_req_type = $req_type;
+	}
+
+
+	/**
+	 * Returns the request type of this addon (ie, EE_System::req_type_normal, EE_System::req_type_new_activation,
+	 * EE_System::req_type_reactivation, EE_System::req_type_upgrade, or EE_System::req_type_downgrade). This is set by
+	 * EE_System when it is checking for new install or upgrades of addons
+	 */
+	public function detect_req_type($redetect = false): int
+	{
+		if ($this->_req_type === null || $redetect) {
+			$this->detect_activation_or_upgrade();
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Detects the request type for this addon (whether it was just activated, upgrades, a normal request, etc.)
+	 * Should only be called once per request
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function detect_activation_or_upgrade()
+	{
+		$activation_history_for_addon = $this->get_activation_history();
+		$request_type                 = EE_System::detect_req_type_given_activation_history(
+			$activation_history_for_addon,
+			$this->get_activation_indicator_option_name(),
+			$this->version()
+		);
+		$this->set_req_type($request_type);
+		$classname = get_class($this);
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__new_activation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__new_activation', $this);
+				$this->new_install();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__reactivation");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__reactivation', $this);
+				$this->reactivation();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__upgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__upgrade', $this);
+				$this->upgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action("AHEE__{$classname}__detect_activations_or_upgrades__downgrade");
+				do_action('AHEE__EE_Addon__detect_activations_or_upgrades__downgrade', $this);
+				$this->downgrade();
+				$this->update_list_of_installed_versions($activation_history_for_addon);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+
+		do_action("AHEE__{$classname}__detect_if_activation_or_upgrade__complete");
+	}
+
+
+	/**
+	 * Updates the version history for this addon
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add
+	 * @return bool success
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
+	{
+		if (! $version_history) {
+			$version_history = $this->get_activation_history();
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = $this->version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		return update_option($this->get_activation_history_option_name(), $version_history);
+	}
+
+
+	/**
+	 * Gets the name of the wp option that stores the activation history
+	 * of this addon
+	 *
+	 * @return string
+	 */
+	public function get_activation_history_option_name(): string
+	{
+		return self::ee_addon_version_history_option_prefix . $this->name();
+	}
+
+
+	/**
+	 * Gets the wp option which stores the activation history for this addon
+	 *
+	 * @return array
+	 */
+	public function get_activation_history(): array
+	{
+		return get_option($this->get_activation_history_option_name(), []);
+	}
+
+
+	/**
+	 * @param string $config_section
+	 */
+	public function set_config_section($config_section = '')
+	{
+		$this->_config_section = ! empty($config_section) ? $config_section : 'addons';
+	}
+
+
+	/**
+	 * Sets the filepath to the main plugin file
+	 *
+	 * @param string $filepath
+	 */
+	public function set_main_plugin_file(string $filepath)
+	{
+		$this->_main_plugin_file = $filepath;
+	}
+
+
+	/**
+	 * gets the filepath to teh main file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file(): string
+	{
+		return $this->_main_plugin_file;
+	}
+
+
+	/**
+	 * Gets the filename (no path) of the main file (the main file loaded
+	 * by WP)
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_basename(): string
+	{
+		return plugin_basename($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * Gets the folder name which contains the main plugin file
+	 *
+	 * @return string
+	 */
+	public function get_main_plugin_file_dirname(): string
+	{
+		return dirname($this->get_main_plugin_file());
+	}
+
+
+	/**
+	 * sets hooks used in the admin
+	 *
+	 * @return void
+	 */
+	public function admin_init()
+	{
+		// is admin and not in M-Mode ?
+		if (is_admin() && MaintenanceStatus::isDisabled()) {
+			add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
+			add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
+		}
+	}
+
+
+	/**
+	 * plugin_actions
+	 * Add a settings link to the Plugins page, so people can go straight from the plugin page to the settings page.
+	 *
+	 * @param array  $links
+	 * @param string $file
+	 * @return array
+	 */
+	public function plugin_action_links(array $links, string $file): array
+	{
+		if ($file === $this->plugin_basename() && $this->plugin_action_slug() !== '') {
+			// before other links
+			array_unshift(
+				$links,
+				'<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+				. esc_html__('Settings', 'event_espresso')
+				. '</a>'
+			);
+		}
+		return $links;
+	}
+
+
+	/**
+	 * after_plugin_row
+	 * Add additional content to the plugins page plugin row
+	 * Inserts another row
+	 *
+	 * @param string $plugin_file
+	 * @param array  $plugin_data
+	 * @param string $status
+	 * @return void
+	 */
+	public function after_plugin_row(string $plugin_file, array $plugin_data, string $status)
+	{
+		$after_plugin_row = '';
+		$plugins_page_row = $this->get_plugins_page_row();
+		if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+			$class       = $status ? 'active' : 'inactive';
+			$link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
+			$link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
+			$description = isset($plugins_page_row['description'])
+				? $plugins_page_row['description']
+				: '';
+			if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+				$after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+				$after_plugin_row .= '<th class="check-column" scope="row"></th>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
+				$after_plugin_row .= '<p class="ee-addon-upsell-info-dv">
 	                <a class="button button--primary" href="' . esc_url_raw($link_url) . '">'
-                    . $link_text
-                    . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
-                    . '</a>
+					. $link_text
+					. ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
+					. '</a>
                 </p>';
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
-                $after_plugin_row .= $description;
-                $after_plugin_row .= '</td>';
-                $after_plugin_row .= '</tr>';
-            } else {
-                $after_plugin_row .= $description;
-            }
-        }
-
-        echo wp_kses($after_plugin_row, AllowedTags::getAllowedTags());
-    }
-
-
-    /**
-     * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
-     * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
-     * for back compat reasons.
-     *
-     * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
-     *
-     * It is recommended, if client code is `de-registering` an add-on, then do it on the
-     * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
-     * callback does not get run/set in that request.
-     *
-     * Also, keep in mind that if a registered add-on happens to be deactivated via
-     * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
-     * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
-     * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
-     * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
-     * to call `parent::deactivation`.
-     *
-     * @since 4.9.26
-     */
-    public function after_registration()
-    {
-        // cricket chirp... cricket chirp...
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getPueSlug(): string
-    {
-        return $this->pue_slug;
-    }
-
-
-    /**
-     * @param string $pue_slug
-     */
-    public function setPueSlug(string $pue_slug)
-    {
-        $this->pue_slug = $pue_slug;
-    }
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '<td class="ee-addon-upsell-info-desc-td column-description desc">';
+				$after_plugin_row .= $description;
+				$after_plugin_row .= '</td>';
+				$after_plugin_row .= '</tr>';
+			} else {
+				$after_plugin_row .= $description;
+			}
+		}
+
+		echo wp_kses($after_plugin_row, AllowedTags::getAllowedTags());
+	}
+
+
+	/**
+	 * A safe space for addons to add additional logic like setting hooks that need to be set early in the request.
+	 * Child classes that have logic like that to run can override this method declaration.  This was not made abstract
+	 * for back compat reasons.
+	 *
+	 * This will fire on the `AHEE__EE_System__load_espresso_addons__complete` hook at priority 999.
+	 *
+	 * It is recommended, if client code is `de-registering` an add-on, then do it on the
+	 * `AHEE__EE_System__load_espresso_addons__complete` hook before priority 999 so as to ensure any code logic in this
+	 * callback does not get run/set in that request.
+	 *
+	 * Also, keep in mind that if a registered add-on happens to be deactivated via
+	 * EE_System::_deactivate_incompatible_addons() because its incompatible, any code executed in this method
+	 * (including setting hooks etc) will have executed before the plugin was deactivated.  If you use
+	 * `after_registration` to set any filter and/or action hooks and want to ensure they are removed on this add-on's
+	 * deactivation, you can override `EE_Addon::deactivation` and unset your hooks and filters there.  Just remember
+	 * to call `parent::deactivation`.
+	 *
+	 * @since 4.9.26
+	 */
+	public function after_registration()
+	{
+		// cricket chirp... cricket chirp...
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getPueSlug(): string
+	{
+		return $this->pue_slug;
+	}
+
+
+	/**
+	 * @param string $pue_slug
+	 */
+	public function setPueSlug(string $pue_slug)
+	{
+		$this->pue_slug = $pue_slug;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -584,7 +584,7 @@ 
      */
     public function get_activation_indicator_option_name(): string
     {
-        return 'ee_activation_' . $this->name();
+        return 'ee_activation_'.$this->name();
     }
 
 
@@ -673,13 +673,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->get_activation_history();
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = $this->version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         return update_option($this->get_activation_history_option_name(), $version_history);
     }
 
@@ -692,7 +692,7 @@ 
      */
     public function get_activation_history_option_name(): string
     {
-        return self::ee_addon_version_history_option_prefix . $this->name();
+        return self::ee_addon_version_history_option_prefix.$this->name();
     }
 
 
@@ -771,7 +771,7 @@ 
         // is admin and not in M-Mode ?
         if (is_admin() && MaintenanceStatus::isDisabled()) {
             add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
+            add_filter('after_plugin_row_'.$this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
         }
     }
 
@@ -790,7 +790,7 @@ 
             // before other links
             array_unshift(
                 $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+                '<a href="admin.php?page='.$this->plugin_action_slug().'">'
                 . esc_html__('Settings', 'event_espresso')
                 . '</a>'
             );
@@ -813,19 +813,19 @@ 
     {
         $after_plugin_row = '';
         $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+        if ( ! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
             $class       = $status ? 'active' : 'inactive';
             $link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
             $link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
             $description = isset($plugins_page_row['description'])
                 ? $plugins_page_row['description']
                 : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+            if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+                $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
                 $after_plugin_row .= '<th class="check-column" scope="row"></th>';
                 $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
                 $after_plugin_row .= '<p class="ee-addon-upsell-info-dv">
-	                <a class="button button--primary" href="' . esc_url_raw($link_url) . '">'
+	                <a class="button button--primary" href="' . esc_url_raw($link_url).'">'
                     . $link_text
                     . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
                     . '</a>

core/EE_Maintenance_Mode.core.php

Indentation +502 added lines, -502 removed lines

@@ -19,514 +19,514 @@
  */
 class EE_Maintenance_Mode implements ResettableInterface
 {
-    /**
-     * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
-     * STATUS_OFF means the site is NOT in maintenance mode (so everything's normal)
-     */
-    public const STATUS_OFF = 0;
-
-
-    /**
-     * STATUS_PUBLIC_ONLY means that the site's frontend EE code should be completely disabled
-     * but the admin backend should be running as normal. Maybe an admin can view the frontend though
-     */
-    public const STATUS_PUBLIC_ONLY = 1;
-
-    /**
-     * STATUS_FULL_SITE means the frontend AND EE backend code are disabled. The only system running
-     * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
-     * migration scripts before taking the site out of maintenance mode
-     */
-    public const STATUS_FULL_SITE = 2;
-
-    /**
-     * the name of the option which stores the current level of maintenance mode
-     */
-    private const OPTION_NAME = 'ee_maintenance_mode';
-
-
-    protected LoaderInterface $loader;
-
-    private RequestInterface $request;
-
-    private static ?EE_Maintenance_Mode $_instance = null;
-
-    /**
-     * @var int
-     * @since 5.0.12.p
-     */
-    private int $status;
-
-    /**
-     * @var int
-     * @since 5.0.12.p
-     */
-    private int $admin_status;
-
-    /**
-     * true if current_user_can('administrator')
-     *
-     * @var bool
-     * @since 5.0.12.p
-     */
-    private bool $current_user_is_admin;
-
-    /**
-     * used to control updates to the WP options setting in the database
-     *
-     * @var bool
-     * @since 5.0.12.p
-     */
-    private bool $update_db;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null  $loader
-     * @param RequestInterface|null $request
-     * @return EE_Maintenance_Mode|null
-     */
-    public static function instance(
-        ?LoaderInterface $loader = null,
-        ?RequestInterface $request = null
-    ): ?EE_Maintenance_Mode {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
-            self::$_instance = new EE_Maintenance_Mode($loader, $request);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
-     *
-     * @return EE_Maintenance_Mode|null
-     * @throws EE_Error
-     */
-    public static function reset(): ?EE_Maintenance_Mode
-    {
-        self::instance()->set_maintenance_mode_if_db_old();
-        return self::instance();
-    }
-
-
-    /**
-     *private constructor to prevent direct creation
-     */
-    private function __construct(LoaderInterface $loader, RequestInterface $request)
-    {
-        $this->loader                = $loader;
-        $this->request               = $request;
-        $this->current_user_is_admin = current_user_can('administrator');
-        $this->status                = $this->loadStatusFromDatabase();
-        $this->admin_status          = $this->setAdminStatus($this->status);
-        // now make sure the status is set correctly everywhere
-        $this->update_db = false;
-        $this->set_maintenance_level($this->status);
-        $this->update_db = true;
-
-        // if M-Mode level 2 is engaged, we still need basic assets loaded
-        add_action('wp_enqueue_scripts', [$this, 'load_assets_required_for_m_mode']);
-        // shut 'er down for maintenance ?
-        add_filter('the_content', [$this, 'the_content'], 2);
-        // redirect ee menus to maintenance page
-        add_action('admin_page_access_denied', [$this, 'redirect_to_maintenance']);
-        // add powered by EE msg
-        add_action('shutdown', [$this, 'display_maintenance_mode_notice']);
-    }
-
-
-    private function loadStatusFromDatabase(): int
-    {
-        return (int) get_option(EE_Maintenance_Mode::OPTION_NAME, EE_Maintenance_Mode::STATUS_OFF);
-    }
-
-
-    /**
-     * changes the maintenance mode level to reflect whether the current user is an admin or not.
-     * Determines whether we're in maintenance mode and what level. However, while the site
-     * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
-     * to them as if the site isn't in maintenance mode.
-     *      EE_Maintenance_Mode::STATUS_OFF => not in maintenance mode (in normal mode)
-     *      EE_Maintenance_Mode::STATUS_PUBLIC_ONLY=> frontend-only maintenance mode
-     *      EE_Maintenance_Mode::STATUS_FULL_SITE => frontend and backend maintenance mode
-     *
-     * @param int $status
-     * @return int
-     * @since 5.0.12.p
-     */
-    private function setAdminStatus(int $status): int
-    {
-        if (
-            $status === EE_Maintenance_Mode::STATUS_PUBLIC_ONLY
-            && $this->current_user_is_admin
-            && ($this->request->isAjax() || ! $this->request->isAdmin())
-        ) {
-            return EE_Maintenance_Mode::STATUS_OFF;
-        }
-        return $status;
-    }
-
-
-    public function real_level(): int
-    {
-        return $this->status;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function level(): int
-    {
-        return $this->admin_status;
-    }
-
-
-    /**
-     * Determines if we need to put EE in maintenance mode because the database needs updating
-     *
-     * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
-     * @throws EE_Error
-     */
-    public function set_maintenance_mode_if_db_old(): bool
-    {
-        $this->loader->getShared('Data_Migration_Manager');
-        if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
-            $this->activateFullSiteMaintenanceMode();
-            return true;
-        }
-        if ($this->status === EE_Maintenance_Mode::STATUS_FULL_SITE) {
-            // we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
-            // then we shouldn't be in mm2. (Maybe an addon got deactivated?)
-            $this->deactivateMaintenanceMode();
-        }
-        return false;
-    }
-
-
-    /**
-     * Updates the maintenance level on the site
-     *
-     * @param int $level
-     * @return void
-     */
-    public function set_maintenance_level(int $level): void
-    {
-        switch ($level) {
-            case EE_Maintenance_Mode::STATUS_OFF:
-                $this->deactivateMaintenanceMode();
-                return;
-            case EE_Maintenance_Mode::STATUS_PUBLIC_ONLY:
-                $this->activatePublicOnlyMaintenanceMode();
-                return;
-            case EE_Maintenance_Mode::STATUS_FULL_SITE:
-                $this->activateFullSiteMaintenanceMode();
-                return;
-        }
-        throw new DomainException(
-            sprintf(
-                esc_html__(
-                    '"%1$s" is not valid a EE maintenance mode level. Please choose from one of the following: %2$s',
-                    'event_espresso'
-                ),
-                $level,
-                'EE_Maintenance_Mode::STATUS_OFF, EE_Maintenance_Mode::STATUS_PUBLIC_ONLY, EE_Maintenance_Mode::STATUS_FULL_SITE',
-            )
-        );
-    }
-
-
-    /**
-     * sets database status to online
-     * sets maintenance mode status to public only, unless current user is an admin, then maintenance mode is disabled
-     *
-     * @return void
-     * @since 5.0.12.p
-     */
-    public function activatePublicOnlyMaintenanceMode()
-    {
-        DbStatus::setOnline();
-        // disable maintenance mode for admins, otherwise enable public only maintenance mode
-        if ($this->admin_status === EE_Maintenance_Mode::STATUS_OFF) {
-            MaintenanceStatus::disableMaintenanceMode();
-        } else {
-            MaintenanceStatus::setPublicOnlyMaintenanceMode();
-        }
-        $this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_PUBLIC_ONLY);
-    }
-
-
-    /**
-     * sets database status to offline
-     * sets maintenance mode status to full site
-     *
-     * @return void
-     * @since 5.0.12.p
-     */
-    public function activateFullSiteMaintenanceMode()
-    {
-        DbStatus::setOffline();
-        MaintenanceStatus::setFullSiteMaintenanceMode();
-        $this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_FULL_SITE);
-    }
-
-
-    /**
-     * sets database status to online
-     * turns maintenance mode off
-     *
-     * @return void
-     * @since 5.0.12.p
-     */
-    public function deactivateMaintenanceMode()
-    {
-        DbStatus::setOnline();
-        MaintenanceStatus::disableMaintenanceMode();
-        $this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_OFF);
-    }
-
-
-    private function updateMaintenaceModeStatus(int $status)
-    {
-        if (! $this->update_db) {
-            return;
-        }
-        do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $status);
-        update_option(EE_Maintenance_Mode::OPTION_NAME, $status);
-    }
-
-
-    /**
-     * returns TRUE if M-Mode is engaged and the current request is not for the admin
-     *
-     * @return bool
-     */
-    public static function disable_frontend_for_maintenance(): bool
-    {
-        return ! is_admin() && MaintenanceStatus::isNotDisabled();
-    }
-
-
-    /**
-     * @return void
-     */
-    public function load_assets_required_for_m_mode(): void
-    {
-        if (
-            $this->status === EE_Maintenance_Mode::STATUS_FULL_SITE
-            && ! wp_script_is('espresso_core')
-        ) {
-            wp_register_style(
-                'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
-                ['dashicons'],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('espresso_default');
-            wp_register_script(
-                'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-                ['jquery'],
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('espresso_core');
-        }
-    }
-
-
-    /**
-     * replacement EE CPT template that displays message notifying site visitors
-     * that EE has been temporarily placed into maintenance mode
-     * does NOT get called on non-EE-CPT requests
-     *
-     * @return    string
-     */
-    public static function template_include(): string
-    {
-        // shut 'er down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
-    }
-
-
-    /**
-     * displays message notifying site visitors that EE has been temporarily
-     * placed into maintenance mode when post_type != EE CPT
-     *
-     * @param string $the_content
-     * @return string
-     */
-    public function the_content(string $the_content): string
-    {
-        // check if M-mode is engaged and for EE shortcode
-        if ($this->admin_status && strpos($the_content, '[ESPRESSO_') !== false) {
-            // this can eventually be moved to a template, or edited via admin. But for now...
-            $the_content = sprintf(
-                esc_html__(
-                    '%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
-                    'event_espresso'
-                ),
-                '<h3>',
-                '</h3><p>',
-                '</p>'
-            );
-        }
-        return $the_content;
-    }
-
-
-    /**
-     * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
-     */
-    public function display_maintenance_mode_notice()
-    {
-        if (
-            ! $this->current_user_is_admin
-            || $this->status === EE_Maintenance_Mode::STATUS_OFF
-            || $this->request->isAdmin()
-            || $this->request->isAjax()
-            || ! did_action('AHEE__EE_System__load_core_configuration__complete')
-        ) {
-            return;
-        }
-        /** @var CurrentPage $current_page */
-        $current_page = $this->loader->getShared(CurrentPage::class);
-        if ($current_page->isEspressoPage()) {
-            printf(
-                esc_html__(
-                    '%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
-                    'event_espresso'
-                ),
-                '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
-                '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
-                    ['page' => 'espresso_maintenance_settings'],
-                    admin_url('admin.php')
-                ) . '">',
-                '</a></p></div>'
-            );
-        }
-    }
-    // espresso-notices important-notice ee-attention
-
-
-    /**
-     * Redirects EE admin menu requests to the maintenance page
-     */
-    public function redirect_to_maintenance()
-    {
-        global $pagenow;
-        $page = $this->request->getRequestParam('page', '', DataType::STRING);
-        if (
-            $pagenow == 'admin.php'
-            && $page !== 'espresso_maintenance_settings'
-            && strpos($page, 'espresso_') !== false
-            && $this->status == EE_Maintenance_Mode::STATUS_FULL_SITE
-        ) {
-            EEH_URL::safeRedirectAndExit('admin.php?page=espresso_maintenance_settings');
-        }
-    }
-
-
-    /**
-     * override magic methods
-     */
-    final public function __destruct()
-    {
-    }
-
-
-    final public function __call($a, $b)
-    {
-    }
-
-
-    final public function __get($a)
-    {
-    }
-
-
-    final public function __set($a, $b)
-    {
-    }
-
-
-    final public function __isset($a)
-    {
-    }
-
-
-    final public function __unset($a)
-    {
-    }
-
-
-    final public function __sleep()
-    {
-        return [];
-    }
-
-
-    final public function __wakeup()
-    {
-    }
-
-
-    final public function __invoke()
-    {
-    }
-
-
-    final public static function __set_state($a = null)
-    {
-        return EE_Maintenance_Mode::instance();
-    }
-
-
-    final public function __clone()
-    {
-    }
-
-
-    final public static function __callStatic($a, $b)
-    {
-    }
+	/**
+	 * constants available to client code for interpreting the values of EE_Maintenance_Mode::level().
+	 * STATUS_OFF means the site is NOT in maintenance mode (so everything's normal)
+	 */
+	public const STATUS_OFF = 0;
+
+
+	/**
+	 * STATUS_PUBLIC_ONLY means that the site's frontend EE code should be completely disabled
+	 * but the admin backend should be running as normal. Maybe an admin can view the frontend though
+	 */
+	public const STATUS_PUBLIC_ONLY = 1;
+
+	/**
+	 * STATUS_FULL_SITE means the frontend AND EE backend code are disabled. The only system running
+	 * is the maintenance mode stuff, which will require users to update all addons, and then finish running all
+	 * migration scripts before taking the site out of maintenance mode
+	 */
+	public const STATUS_FULL_SITE = 2;
+
+	/**
+	 * the name of the option which stores the current level of maintenance mode
+	 */
+	private const OPTION_NAME = 'ee_maintenance_mode';
+
+
+	protected LoaderInterface $loader;
+
+	private RequestInterface $request;
+
+	private static ?EE_Maintenance_Mode $_instance = null;
+
+	/**
+	 * @var int
+	 * @since 5.0.12.p
+	 */
+	private int $status;
+
+	/**
+	 * @var int
+	 * @since 5.0.12.p
+	 */
+	private int $admin_status;
+
+	/**
+	 * true if current_user_can('administrator')
+	 *
+	 * @var bool
+	 * @since 5.0.12.p
+	 */
+	private bool $current_user_is_admin;
+
+	/**
+	 * used to control updates to the WP options setting in the database
+	 *
+	 * @var bool
+	 * @since 5.0.12.p
+	 */
+	private bool $update_db;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null  $loader
+	 * @param RequestInterface|null $request
+	 * @return EE_Maintenance_Mode|null
+	 */
+	public static function instance(
+		?LoaderInterface $loader = null,
+		?RequestInterface $request = null
+	): ?EE_Maintenance_Mode {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_Maintenance_Mode) {
+			self::$_instance = new EE_Maintenance_Mode($loader, $request);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * Resets maintenance mode (mostly just re-checks whether we should be in maintenance mode)
+	 *
+	 * @return EE_Maintenance_Mode|null
+	 * @throws EE_Error
+	 */
+	public static function reset(): ?EE_Maintenance_Mode
+	{
+		self::instance()->set_maintenance_mode_if_db_old();
+		return self::instance();
+	}
+
+
+	/**
+	 *private constructor to prevent direct creation
+	 */
+	private function __construct(LoaderInterface $loader, RequestInterface $request)
+	{
+		$this->loader                = $loader;
+		$this->request               = $request;
+		$this->current_user_is_admin = current_user_can('administrator');
+		$this->status                = $this->loadStatusFromDatabase();
+		$this->admin_status          = $this->setAdminStatus($this->status);
+		// now make sure the status is set correctly everywhere
+		$this->update_db = false;
+		$this->set_maintenance_level($this->status);
+		$this->update_db = true;
+
+		// if M-Mode level 2 is engaged, we still need basic assets loaded
+		add_action('wp_enqueue_scripts', [$this, 'load_assets_required_for_m_mode']);
+		// shut 'er down for maintenance ?
+		add_filter('the_content', [$this, 'the_content'], 2);
+		// redirect ee menus to maintenance page
+		add_action('admin_page_access_denied', [$this, 'redirect_to_maintenance']);
+		// add powered by EE msg
+		add_action('shutdown', [$this, 'display_maintenance_mode_notice']);
+	}
+
+
+	private function loadStatusFromDatabase(): int
+	{
+		return (int) get_option(EE_Maintenance_Mode::OPTION_NAME, EE_Maintenance_Mode::STATUS_OFF);
+	}
+
+
+	/**
+	 * changes the maintenance mode level to reflect whether the current user is an admin or not.
+	 * Determines whether we're in maintenance mode and what level. However, while the site
+	 * is in level 1 maintenance, and an admin visits the frontend, this function makes it appear
+	 * to them as if the site isn't in maintenance mode.
+	 *      EE_Maintenance_Mode::STATUS_OFF => not in maintenance mode (in normal mode)
+	 *      EE_Maintenance_Mode::STATUS_PUBLIC_ONLY=> frontend-only maintenance mode
+	 *      EE_Maintenance_Mode::STATUS_FULL_SITE => frontend and backend maintenance mode
+	 *
+	 * @param int $status
+	 * @return int
+	 * @since 5.0.12.p
+	 */
+	private function setAdminStatus(int $status): int
+	{
+		if (
+			$status === EE_Maintenance_Mode::STATUS_PUBLIC_ONLY
+			&& $this->current_user_is_admin
+			&& ($this->request->isAjax() || ! $this->request->isAdmin())
+		) {
+			return EE_Maintenance_Mode::STATUS_OFF;
+		}
+		return $status;
+	}
+
+
+	public function real_level(): int
+	{
+		return $this->status;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function level(): int
+	{
+		return $this->admin_status;
+	}
+
+
+	/**
+	 * Determines if we need to put EE in maintenance mode because the database needs updating
+	 *
+	 * @return boolean true if DB is old and maintenance mode was triggered; false otherwise
+	 * @throws EE_Error
+	 */
+	public function set_maintenance_mode_if_db_old(): bool
+	{
+		$this->loader->getShared('Data_Migration_Manager');
+		if (EE_Data_Migration_Manager::instance()->check_for_applicable_data_migration_scripts()) {
+			$this->activateFullSiteMaintenanceMode();
+			return true;
+		}
+		if ($this->status === EE_Maintenance_Mode::STATUS_FULL_SITE) {
+			// we also want to handle the opposite: if the site is mm2, but there aren't any migrations to run
+			// then we shouldn't be in mm2. (Maybe an addon got deactivated?)
+			$this->deactivateMaintenanceMode();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Updates the maintenance level on the site
+	 *
+	 * @param int $level
+	 * @return void
+	 */
+	public function set_maintenance_level(int $level): void
+	{
+		switch ($level) {
+			case EE_Maintenance_Mode::STATUS_OFF:
+				$this->deactivateMaintenanceMode();
+				return;
+			case EE_Maintenance_Mode::STATUS_PUBLIC_ONLY:
+				$this->activatePublicOnlyMaintenanceMode();
+				return;
+			case EE_Maintenance_Mode::STATUS_FULL_SITE:
+				$this->activateFullSiteMaintenanceMode();
+				return;
+		}
+		throw new DomainException(
+			sprintf(
+				esc_html__(
+					'"%1$s" is not valid a EE maintenance mode level. Please choose from one of the following: %2$s',
+					'event_espresso'
+				),
+				$level,
+				'EE_Maintenance_Mode::STATUS_OFF, EE_Maintenance_Mode::STATUS_PUBLIC_ONLY, EE_Maintenance_Mode::STATUS_FULL_SITE',
+			)
+		);
+	}
+
+
+	/**
+	 * sets database status to online
+	 * sets maintenance mode status to public only, unless current user is an admin, then maintenance mode is disabled
+	 *
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	public function activatePublicOnlyMaintenanceMode()
+	{
+		DbStatus::setOnline();
+		// disable maintenance mode for admins, otherwise enable public only maintenance mode
+		if ($this->admin_status === EE_Maintenance_Mode::STATUS_OFF) {
+			MaintenanceStatus::disableMaintenanceMode();
+		} else {
+			MaintenanceStatus::setPublicOnlyMaintenanceMode();
+		}
+		$this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_PUBLIC_ONLY);
+	}
+
+
+	/**
+	 * sets database status to offline
+	 * sets maintenance mode status to full site
+	 *
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	public function activateFullSiteMaintenanceMode()
+	{
+		DbStatus::setOffline();
+		MaintenanceStatus::setFullSiteMaintenanceMode();
+		$this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_FULL_SITE);
+	}
+
+
+	/**
+	 * sets database status to online
+	 * turns maintenance mode off
+	 *
+	 * @return void
+	 * @since 5.0.12.p
+	 */
+	public function deactivateMaintenanceMode()
+	{
+		DbStatus::setOnline();
+		MaintenanceStatus::disableMaintenanceMode();
+		$this->updateMaintenaceModeStatus(EE_Maintenance_Mode::STATUS_OFF);
+	}
+
+
+	private function updateMaintenaceModeStatus(int $status)
+	{
+		if (! $this->update_db) {
+			return;
+		}
+		do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $status);
+		update_option(EE_Maintenance_Mode::OPTION_NAME, $status);
+	}
+
+
+	/**
+	 * returns TRUE if M-Mode is engaged and the current request is not for the admin
+	 *
+	 * @return bool
+	 */
+	public static function disable_frontend_for_maintenance(): bool
+	{
+		return ! is_admin() && MaintenanceStatus::isNotDisabled();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function load_assets_required_for_m_mode(): void
+	{
+		if (
+			$this->status === EE_Maintenance_Mode::STATUS_FULL_SITE
+			&& ! wp_script_is('espresso_core')
+		) {
+			wp_register_style(
+				'espresso_default',
+				EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+				['dashicons'],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('espresso_default');
+			wp_register_script(
+				'espresso_core',
+				EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+				['jquery'],
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('espresso_core');
+		}
+	}
+
+
+	/**
+	 * replacement EE CPT template that displays message notifying site visitors
+	 * that EE has been temporarily placed into maintenance mode
+	 * does NOT get called on non-EE-CPT requests
+	 *
+	 * @return    string
+	 */
+	public static function template_include(): string
+	{
+		// shut 'er down for maintenance ? then don't use any of our templates for our endpoints
+		return get_template_directory() . '/index.php';
+	}
+
+
+	/**
+	 * displays message notifying site visitors that EE has been temporarily
+	 * placed into maintenance mode when post_type != EE CPT
+	 *
+	 * @param string $the_content
+	 * @return string
+	 */
+	public function the_content(string $the_content): string
+	{
+		// check if M-mode is engaged and for EE shortcode
+		if ($this->admin_status && strpos($the_content, '[ESPRESSO_') !== false) {
+			// this can eventually be moved to a template, or edited via admin. But for now...
+			$the_content = sprintf(
+				esc_html__(
+					'%sMaintenance Mode%sEvent Registration has been temporarily closed while system maintenance is being performed. We\'re sorry for any inconveniences this may have caused. Please try back again later.%s',
+					'event_espresso'
+				),
+				'<h3>',
+				'</h3><p>',
+				'</p>'
+			);
+		}
+		return $the_content;
+	}
+
+
+	/**
+	 * displays message on frontend of site notifying admin that EE has been temporarily placed into maintenance mode
+	 */
+	public function display_maintenance_mode_notice()
+	{
+		if (
+			! $this->current_user_is_admin
+			|| $this->status === EE_Maintenance_Mode::STATUS_OFF
+			|| $this->request->isAdmin()
+			|| $this->request->isAjax()
+			|| ! did_action('AHEE__EE_System__load_core_configuration__complete')
+		) {
+			return;
+		}
+		/** @var CurrentPage $current_page */
+		$current_page = $this->loader->getShared(CurrentPage::class);
+		if ($current_page->isEspressoPage()) {
+			printf(
+				esc_html__(
+					'%sclose%sEvent Registration is currently disabled because Event Espresso has been placed into Maintenance Mode. To change Maintenance Mode settings, click here %sEE Maintenance Mode Admin Page%s',
+					'event_espresso'
+				),
+				'<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
+				'"><span class="dashicons dashicons-no"></span></a><p>',
+				' &raquo; <a href="' . add_query_arg(
+					['page' => 'espresso_maintenance_settings'],
+					admin_url('admin.php')
+				) . '">',
+				'</a></p></div>'
+			);
+		}
+	}
+	// espresso-notices important-notice ee-attention
+
+
+	/**
+	 * Redirects EE admin menu requests to the maintenance page
+	 */
+	public function redirect_to_maintenance()
+	{
+		global $pagenow;
+		$page = $this->request->getRequestParam('page', '', DataType::STRING);
+		if (
+			$pagenow == 'admin.php'
+			&& $page !== 'espresso_maintenance_settings'
+			&& strpos($page, 'espresso_') !== false
+			&& $this->status == EE_Maintenance_Mode::STATUS_FULL_SITE
+		) {
+			EEH_URL::safeRedirectAndExit('admin.php?page=espresso_maintenance_settings');
+		}
+	}
+
+
+	/**
+	 * override magic methods
+	 */
+	final public function __destruct()
+	{
+	}
+
+
+	final public function __call($a, $b)
+	{
+	}
+
+
+	final public function __get($a)
+	{
+	}
+
+
+	final public function __set($a, $b)
+	{
+	}
+
+
+	final public function __isset($a)
+	{
+	}
+
+
+	final public function __unset($a)
+	{
+	}
+
+
+	final public function __sleep()
+	{
+		return [];
+	}
+
+
+	final public function __wakeup()
+	{
+	}
+
+
+	final public function __invoke()
+	{
+	}
+
+
+	final public static function __set_state($a = null)
+	{
+		return EE_Maintenance_Mode::instance();
+	}
+
+
+	final public function __clone()
+	{
+	}
+
+
+	final public static function __callStatic($a, $b)
+	{
+	}
 
 
-    /************************ @DEPRECATED ********************** */
+	/************************ @DEPRECATED ********************** */
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const level_0_not_in_maintenance = 0;
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const level_0_not_in_maintenance = 0;
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const level_1_frontend_only_maintenance = 1;
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const level_1_frontend_only_maintenance = 1;
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const level_2_complete_maintenance = 2;
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const level_2_complete_maintenance = 2;
 
-    /**
-     * @depecated 5.0.12.p
-     */
-    const option_name_maintenance_mode = 'ee_maintenance_mode';
+	/**
+	 * @depecated 5.0.12.p
+	 */
+	const option_name_maintenance_mode = 'ee_maintenance_mode';
 
 
-    /**
-     * Returns whether the models reportedly are able to run queries or not
-     * (ie, if the system thinks their tables are present and up-to-date).
-     *
-     * @return boolean
-     * @depecated 5.0.12.p
-     */
-    public function models_can_query(): bool
-    {
-        return DbStatus::isOnline();
-    }
+	/**
+	 * Returns whether the models reportedly are able to run queries or not
+	 * (ie, if the system thinks their tables are present and up-to-date).
+	 *
+	 * @return boolean
+	 * @depecated 5.0.12.p
+	 */
+	public function models_can_query(): bool
+	{
+		return DbStatus::isOnline();
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -91,7 +91,7 @@ 
         ?RequestInterface $request = null
     ): ?EE_Maintenance_Mode {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_Maintenance_Mode) {
+        if ( ! self::$_instance instanceof EE_Maintenance_Mode) {
             self::$_instance = new EE_Maintenance_Mode($loader, $request);
         }
         return self::$_instance;
@@ -290,7 +290,7 @@ 
 
     private function updateMaintenaceModeStatus(int $status)
     {
-        if (! $this->update_db) {
+        if ( ! $this->update_db) {
             return;
         }
         do_action('AHEE__EE_Maintenance_Mode__set_maintenance_level', $status);
@@ -320,14 +320,14 @@ 
         ) {
             wp_register_style(
                 'espresso_default',
-                EE_GLOBAL_ASSETS_URL . 'css/espresso_default.css',
+                EE_GLOBAL_ASSETS_URL.'css/espresso_default.css',
                 ['dashicons'],
                 EVENT_ESPRESSO_VERSION
             );
             wp_enqueue_style('espresso_default');
             wp_register_script(
                 'espresso_core',
-                EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+                EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
                 ['jquery'],
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -347,7 +347,7 @@ 
     public static function template_include(): string
     {
         // shut 'er down for maintenance ? then don't use any of our templates for our endpoints
-        return get_template_directory() . '/index.php';
+        return get_template_directory().'/index.php';
     }
 
 
@@ -401,10 +401,10 @@ 
                 ),
                 '<div id="ee-m-mode-admin-notice-dv" class="ee-really-important-notice-dv"><a class="close-espresso-notice" title="',
                 '"><span class="dashicons dashicons-no"></span></a><p>',
-                ' &raquo; <a href="' . add_query_arg(
+                ' &raquo; <a href="'.add_query_arg(
                     ['page' => 'espresso_maintenance_settings'],
                     admin_url('admin.php')
-                ) . '">',
+                ).'">',
                 '</a></p></div>'
             );
         }

core/EES_Shortcode.shortcode.php

Indentation +168 added lines, -168 removed lines

@@ -15,172 +15,172 @@
  */
 abstract class EES_Shortcode extends EE_Base
 {
-    /**
-     * @protected   public
-     * @var     array $_attributes
-     */
-    protected $_attributes = [];
-
-
-    /**
-     * class constructor - should ONLY be instantiated by EE_Front_Controller
-     */
-    final public function __construct()
-    {
-        $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
-        // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
-        add_shortcode($shortcode, [$this, 'process_shortcode']);
-        // make sure system knows this is an EE page
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-    }
-
-
-    /**
-     * run - initial shortcode module setup called during "parse_request" hook by
-     * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
-     * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
-     * by a theme or plugin in a non-standard way.
-     * Basically this method is primarily used for loading resources and assets like CSS or JS
-     * that will be required by the shortcode when it is actually processed.
-     * Please note that assets may not load if the fallback_shortcode_processor() is being used.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    abstract public function run(WP $WP);
-
-
-    /**
-     *  process_shortcode
-     *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the
-     *  shortcode within the_content
-     *
-     * @param array|string $attributes
-     * @return mixed
-     */
-    abstract public function process_shortcode($attributes = []);
-
-
-    /**
-     *    instance - returns instance of child class object
-     *
-     * @param string|null $shortcode_class
-     * @return EES_Shortcode
-     */
-    final public static function instance(string $shortcode_class = ''): ?EES_Shortcode
-    {
-        $shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
-        if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
-            return null;
-        }
-        $shortcode     = LegacyShortcodesManager::generateShortcodeTagFromClassName($shortcode_class);
-        $shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
-            ? EE_Registry::instance()->shortcodes->{$shortcode}
-            : null;
-        return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
-            ? $shortcode_obj
-            : new $shortcode_class();
-    }
-
-
-    /**
-     *    fallback_shortcode_processor - create instance and call process_shortcode
-     *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things
-     *    work at all
-     *
-     * @param array|string $attributes
-     * @return mixed
-     */
-    final public static function fallback_shortcode_processor($attributes = null)
-    {
-        if (! is_admin() && MaintenanceStatus::isNotDisabled()) {
-            return null;
-        }
-        // what shortcode was actually parsed ?
-        $shortcode_class = get_called_class();
-        // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
-        // get instance of actual shortcode
-        $shortcode_obj = self::instance($shortcode_class);
-        // verify class
-        if ($shortcode_obj instanceof EES_Shortcode) {
-            global $wp;
-            $shortcode_obj->run($wp);
-            // set attributes and run the shortcode
-            $shortcode_obj->_attributes = (array) $attributes;
-            return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a
-     *    deactivated addon, and simply returns an empty string
-     *
-     * @param $attributes
-     * @return string
-     */
-    final public static function invalid_shortcode_processor($attributes): string
-    {
-        return '';
-    }
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden by supplying an array for the $custom_sanitization param,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @param array $custom_sanitization
-     * @return array
-     */
-    public static function sanitize_attributes(array $attributes, array $custom_sanitization = []): array
-    {
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
-                    continue;
-                } elseif (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null:
-                case is_int($value):
-                case is_float($value):
-                    // typical booleans
-                case in_array($value, [true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'], true):
-                    $attributes[ $key ] = $value;
-                    break;
-                case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
-                    break;
-                case is_array($value):
-                    $attributes[ $key ] = EES_Shortcode::sanitize_attributes($value);
-                    break;
-                default:
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * @protected   public
+	 * @var     array $_attributes
+	 */
+	protected $_attributes = [];
+
+
+	/**
+	 * class constructor - should ONLY be instantiated by EE_Front_Controller
+	 */
+	final public function __construct()
+	{
+		$shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
+		// assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
+		add_shortcode($shortcode, [$this, 'process_shortcode']);
+		// make sure system knows this is an EE page
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+	}
+
+
+	/**
+	 * run - initial shortcode module setup called during "parse_request" hook by
+	 * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
+	 * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
+	 * by a theme or plugin in a non-standard way.
+	 * Basically this method is primarily used for loading resources and assets like CSS or JS
+	 * that will be required by the shortcode when it is actually processed.
+	 * Please note that assets may not load if the fallback_shortcode_processor() is being used.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	abstract public function run(WP $WP);
+
+
+	/**
+	 *  process_shortcode
+	 *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the
+	 *  shortcode within the_content
+	 *
+	 * @param array|string $attributes
+	 * @return mixed
+	 */
+	abstract public function process_shortcode($attributes = []);
+
+
+	/**
+	 *    instance - returns instance of child class object
+	 *
+	 * @param string|null $shortcode_class
+	 * @return EES_Shortcode
+	 */
+	final public static function instance(string $shortcode_class = ''): ?EES_Shortcode
+	{
+		$shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
+		if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
+			return null;
+		}
+		$shortcode     = LegacyShortcodesManager::generateShortcodeTagFromClassName($shortcode_class);
+		$shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
+			? EE_Registry::instance()->shortcodes->{$shortcode}
+			: null;
+		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
+			? $shortcode_obj
+			: new $shortcode_class();
+	}
+
+
+	/**
+	 *    fallback_shortcode_processor - create instance and call process_shortcode
+	 *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things
+	 *    work at all
+	 *
+	 * @param array|string $attributes
+	 * @return mixed
+	 */
+	final public static function fallback_shortcode_processor($attributes = null)
+	{
+		if (! is_admin() && MaintenanceStatus::isNotDisabled()) {
+			return null;
+		}
+		// what shortcode was actually parsed ?
+		$shortcode_class = get_called_class();
+		// notify rest of system that fallback processor was triggered
+		add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+		// get instance of actual shortcode
+		$shortcode_obj = self::instance($shortcode_class);
+		// verify class
+		if ($shortcode_obj instanceof EES_Shortcode) {
+			global $wp;
+			$shortcode_obj->run($wp);
+			// set attributes and run the shortcode
+			$shortcode_obj->_attributes = (array) $attributes;
+			return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a
+	 *    deactivated addon, and simply returns an empty string
+	 *
+	 * @param $attributes
+	 * @return string
+	 */
+	final public static function invalid_shortcode_processor($attributes): string
+	{
+		return '';
+	}
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden by supplying an array for the $custom_sanitization param,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @param array $custom_sanitization
+	 * @return array
+	 */
+	public static function sanitize_attributes(array $attributes, array $custom_sanitization = []): array
+	{
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[ $key ])) {
+				$callback = $custom_sanitization[ $key ];
+				if ($callback === 'skip_sanitization') {
+					$attributes[ $key ] = $value;
+					continue;
+				} elseif (function_exists($callback)) {
+					$attributes[ $key ] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null:
+				case is_int($value):
+				case is_float($value):
+					// typical booleans
+				case in_array($value, [true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'], true):
+					$attributes[ $key ] = $value;
+					break;
+				case is_string($value):
+					$attributes[ $key ] = sanitize_text_field($value);
+					break;
+				case is_array($value):
+					$attributes[ $key ] = EES_Shortcode::sanitize_attributes($value);
+					break;
+				default:
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[ $key ] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -95,13 +95,13 @@ 
      */
     final public static function fallback_shortcode_processor($attributes = null)
     {
-        if (! is_admin() && MaintenanceStatus::isNotDisabled()) {
+        if ( ! is_admin() && MaintenanceStatus::isNotDisabled()) {
             return null;
         }
         // what shortcode was actually parsed ?
         $shortcode_class = get_called_class();
         // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+        add_filter('FHEE__fallback_shortcode_processor__'.$shortcode_class, '__return_true');
         // get instance of actual shortcode
         $shortcode_obj = self::instance($shortcode_class);
         // verify class
@@ -150,13 +150,13 @@ 
     {
         foreach ($attributes as $key => $value) {
             // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
+            if (isset($custom_sanitization[$key])) {
+                $callback = $custom_sanitization[$key];
                 if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     continue;
                 } elseif (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
+                    $attributes[$key] = $callback($value);
                     continue;
                 }
             }
@@ -166,18 +166,18 @@ 
                 case is_float($value):
                     // typical booleans
                 case in_array($value, [true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'], true):
-                    $attributes[ $key ] = $value;
+                    $attributes[$key] = $value;
                     break;
                 case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
+                    $attributes[$key] = sanitize_text_field($value);
                     break;
                 case is_array($value):
-                    $attributes[ $key ] = EES_Shortcode::sanitize_attributes($value);
+                    $attributes[$key] = EES_Shortcode::sanitize_attributes($value);
                     break;
                 default:
                     // only remaining data types are Object and Resource
                     // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
+                    $attributes[$key] = null;
                     break;
             }
         }

core/services/container/RegistryContainer.php

Indentation +162 added lines, -162 removed lines

@@ -16,166 +16,166 @@
  */
 class RegistryContainer implements ArrayAccess, CountableTraversableAggregate
 {
-    private array $container = [];
-
-
-    /**
-     * RegistryContainer constructor.
-     * Container data can be seeded by passing parameters to constructor.
-     * Each parameter will become its own element in the container
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * @param mixed $offset
-     * @param mixed $value
-     */
-    public function offsetSet($offset, $value): void
-    {
-        $this->container[ $offset ] = $value;
-    }
-
-
-    /**
-     * @param mixed $offset
-     * @return bool
-     */
-    public function offsetExists($offset): bool
-    {
-        return isset($this->container[ $offset ]);
-    }
-
-
-    /**
-     * @param mixed $offset
-     */
-    public function offsetUnset($offset): void
-    {
-        unset($this->container[ $offset ]);
-    }
-
-
-    /**
-     * @param mixed $offset
-     * @return mixed|null
-     */
-    #[\ReturnTypeWillChange]
-    public function offsetGet($offset)
-    {
-        return $this->offsetExists($offset) ? $this->container[ $offset ] : null;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function count(): int
-    {
-        return count($this->container);
-    }
-
-
-    /**
-     * @return ArrayIterator
-     */
-    public function getIterator(): ArrayIterator
-    {
-        return new ArrayIterator($this->container);
-    }
-
-
-    /**
-     * @param $offset
-     * @param $value
-     */
-    public function __set($offset, $value): void
-    {
-        $this->offsetSet($offset, $value);
-    }
-
-
-    /**
-     * @param $offset
-     * @return mixed
-     * @throws OutOfBoundsException
-     */
-    #[\ReturnTypeWillChange]
-    public function __get($offset)
-    {
-        if (! array_key_exists($offset, $this->container)) {
-            $trace = debug_backtrace();
-            throw new OutOfBoundsException(
-                sprintf(
-                    esc_html__('Invalid offset: %1$s %2$sCalled from %3$s on line %4$d', 'event_espresso'),
-                    $offset,
-                    '<br  />',
-                    $trace[0]['file'],
-                    $trace[0]['line']
-                )
-            );
-        }
-        return $this->offsetGet($offset);
-    }
-
-
-    /**
-     * @param $offset
-     * @return bool
-     */
-    public function __isset($offset): bool
-    {
-        return $this->offsetExists($offset);
-    }
-
-
-    /**
-     * @param $offset
-     */
-    public function __unset($offset): void
-    {
-        $this->offsetUnset($offset);
-    }
-
-
-    /**
-     * @param $offset
-     * @param $value
-     */
-    public function add($offset, $value): void
-    {
-        $this->offsetSet($offset, $value);
-    }
-
-
-    /**
-     * @param $offset
-     */
-    public function remove($offset): void
-    {
-        $this->offsetUnset($offset);
-    }
-
-
-    /**
-     * @param $offset
-     * @return bool
-     */
-    public function has($offset): bool
-    {
-        return $this->offsetExists($offset);
-    }
-
-
-    /**
-     * @param $offset
-     * @return mixed|null
-     */
-    #[\ReturnTypeWillChange]
-    public function get($offset)
-    {
-        return $this->offsetGet($offset);
-    }
+	private array $container = [];
+
+
+	/**
+	 * RegistryContainer constructor.
+	 * Container data can be seeded by passing parameters to constructor.
+	 * Each parameter will become its own element in the container
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 * @param mixed $value
+	 */
+	public function offsetSet($offset, $value): void
+	{
+		$this->container[ $offset ] = $value;
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 * @return bool
+	 */
+	public function offsetExists($offset): bool
+	{
+		return isset($this->container[ $offset ]);
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 */
+	public function offsetUnset($offset): void
+	{
+		unset($this->container[ $offset ]);
+	}
+
+
+	/**
+	 * @param mixed $offset
+	 * @return mixed|null
+	 */
+	#[\ReturnTypeWillChange]
+	public function offsetGet($offset)
+	{
+		return $this->offsetExists($offset) ? $this->container[ $offset ] : null;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function count(): int
+	{
+		return count($this->container);
+	}
+
+
+	/**
+	 * @return ArrayIterator
+	 */
+	public function getIterator(): ArrayIterator
+	{
+		return new ArrayIterator($this->container);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @param $value
+	 */
+	public function __set($offset, $value): void
+	{
+		$this->offsetSet($offset, $value);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 */
+	#[\ReturnTypeWillChange]
+	public function __get($offset)
+	{
+		if (! array_key_exists($offset, $this->container)) {
+			$trace = debug_backtrace();
+			throw new OutOfBoundsException(
+				sprintf(
+					esc_html__('Invalid offset: %1$s %2$sCalled from %3$s on line %4$d', 'event_espresso'),
+					$offset,
+					'<br  />',
+					$trace[0]['file'],
+					$trace[0]['line']
+				)
+			);
+		}
+		return $this->offsetGet($offset);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @return bool
+	 */
+	public function __isset($offset): bool
+	{
+		return $this->offsetExists($offset);
+	}
+
+
+	/**
+	 * @param $offset
+	 */
+	public function __unset($offset): void
+	{
+		$this->offsetUnset($offset);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @param $value
+	 */
+	public function add($offset, $value): void
+	{
+		$this->offsetSet($offset, $value);
+	}
+
+
+	/**
+	 * @param $offset
+	 */
+	public function remove($offset): void
+	{
+		$this->offsetUnset($offset);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @return bool
+	 */
+	public function has($offset): bool
+	{
+		return $this->offsetExists($offset);
+	}
+
+
+	/**
+	 * @param $offset
+	 * @return mixed|null
+	 */
+	#[\ReturnTypeWillChange]
+	public function get($offset)
+	{
+		return $this->offsetGet($offset);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -35,7 +35,7 @@ 
      */
     public function offsetSet($offset, $value): void
     {
-        $this->container[ $offset ] = $value;
+        $this->container[$offset] = $value;
     }
 
 
@@ -45,7 +45,7 @@ 
      */
     public function offsetExists($offset): bool
     {
-        return isset($this->container[ $offset ]);
+        return isset($this->container[$offset]);
     }
 
 
@@ -54,7 +54,7 @@ 
      */
     public function offsetUnset($offset): void
     {
-        unset($this->container[ $offset ]);
+        unset($this->container[$offset]);
     }
 
 
@@ -65,7 +65,7 @@ 
     #[\ReturnTypeWillChange]
     public function offsetGet($offset)
     {
-        return $this->offsetExists($offset) ? $this->container[ $offset ] : null;
+        return $this->offsetExists($offset) ? $this->container[$offset] : null;
     }
 
 
@@ -105,7 +105,7 @@ 
     #[\ReturnTypeWillChange]
     public function __get($offset)
     {
-        if (! array_key_exists($offset, $this->container)) {
+        if ( ! array_key_exists($offset, $this->container)) {
             $trace = debug_backtrace();
             throw new OutOfBoundsException(
                 sprintf(

core/services/calculators/LineItemCalculator.php

Indentation +920 added lines, -920 removed lines

@@ -21,924 +21,924 @@
  */
 class LineItemCalculator
 {
-    use DebugDisplay;
-
-    protected DecimalValues $decimal_values;
-
-    protected array $default_query_params = [
-        ['LIN_type' => ['!=', EEM_Line_Item::type_cancellation]],
-    ];
-
-
-    /**
-     * @param DecimalValues $decimal_values
-     */
-    public function __construct(DecimalValues $decimal_values)
-    {
-        $this->decimal_values = $decimal_values;
-        $this->initializeDebugDisplay();
-    }
-
-
-    /**
-     * Gets the final total on this item, taking taxes into account.
-     * Has the side effect of setting the sub-total as it was just calculated.
-     * If this is used on a grand-total line item, also updates the transaction's
-     * TXN_total (provided this line item is allowed to persist, otherwise we don't
-     * want to change a persistable transaction with info from a non-persistent line item)
-     *
-     * @param EE_Line_Item $line_item
-     * @param bool         $update_txn_status
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateTotalIncludingTaxes(EE_Line_Item $line_item, bool $update_txn_status = false): float
-    {
-        $this->debugLog('', 2);
-        $this->debugLog(__METHOD__);
-        $this->debugLog(str_repeat('*', strlen(__METHOD__)), 2);
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        $ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
-        if (empty($ticket_line_items)) {
-            // no tickets? ensure totals are zero
-            $this->updatePreTaxTotal($line_item, 0);
-            $this->updateTotal($line_item, 0);
-            $this->updateTransaction($line_item, 0, $update_txn_status);
-            return 0;
-        }
-        [, $pretax_total] = $this->recalculateLineItemTotals($line_item);
-        // EEH_Line_Item::visualize($line_item);
-        $total_tax = $this->recalculateTaxesAndTaxTotal($line_item);
-        // no negative totals plz
-        $grand_total = max($pretax_total + $total_tax, 0);
-        $this->updatePreTaxTotal($line_item, $pretax_total, true);
-        $grand_total = $this->updateTotal($line_item, $grand_total, true);
-        $this->updateTransaction($line_item, $grand_total, $update_txn_status);
-        return $grand_total;
-    }
-
-
-    /**
-     * Recursively goes through all the children and recalculates sub-totals EXCEPT for
-     * tax-sub-totals (they're an odd beast). Updates the 'total' on each line item according to either its
-     * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
-     * when this is called on the grand total
-     *
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @param bool         $is_taxable
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateLineItemTotals(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0,
-        bool $is_taxable = false
-    ): array {
-        $this->debugLog(__FUNCTION__);
-        $OBJ = $line_item->OBJ_type();
-        $OBJ .= $OBJ ? ': ' : '';
-        $this->debugLog(
-            ' * ' . $OBJ . $line_item->name() . ' - ' . $line_item->type() . ' (' . $line_item->code() . ')',
-            2
-        );
-        $this->debugLog(" * total: $total", 3);
-        $this->debugLog(" * pretax: $pretax_total", 3);
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-            case EEM_Line_Item::type_sub_total:
-                [$total, $pretax_total] = $this->recalculateSubTotal($line_item);
-                break;
-
-            case EEM_Line_Item::type_line_item:
-                [$total, $pretax_total] = $this->recalculateLineItem($line_item, $total, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_sub_line_item:
-                // sub-line-items operate on the total and update both the total AND the pre-tax total
-                [$total, $pretax_total] = $this->recalculateSubLineItem($line_item, $total, $pretax_total, $is_taxable);
-                break;
-
-            case EEM_Line_Item::type_sub_tax:
-                // sub-line-items taxes ONLY operate on the pre-tax total and ONLY update the total
-                [$total, $pretax_total] = $this->recalculateSubTax($line_item, $pretax_total);
-                break;
-
-            case EEM_Line_Item::type_tax_sub_total:
-            case EEM_Line_Item::type_tax:
-            case EEM_Line_Item::type_cancellation:
-                // completely ignore tax totals, tax sub-totals, and cancelled line items
-                // when calculating the pre-tax-total
-                $total = $pretax_total = 0;
-                break;
-        }
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubTotal(EE_Line_Item $line_item): array
-    {
-        $this->debugLog(__FUNCTION__);
-        // reset the total and pretax total to zero since we are recalculating them
-        $total = $pretax_total = 0;
-        if ($line_item->is_total()) {
-            // if this is the grand total line item
-            // then first update ALL the line item quantities (if need be)
-            $this->updateLineItemQuantities($line_item);
-        }
-        // recursively loop through children and recalculate their totals
-        $children = $line_item->children($this->default_query_params);
-        if (empty($children)) {
-            $this->debugLog(' - ' . __FUNCTION__, 3);
-            $this->debugLog(" - - total : $total ", 3);
-            $this->debugLog(" - - pretax: $pretax_total ", 3);
-            return [$total, $pretax_total];
-        }
-        foreach ($children as $child_line_item) {
-            [$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
-                $child_line_item,
-                $total,
-                $pretax_total
-            );
-            $total        += $child_total;
-            $pretax_total += $child_pretax_total;
-        }
-        // update the unit price and pretax total
-        $this->updateUnitPrice($line_item, $pretax_total, false);
-        $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true, false);
-        $this->debugLog(' - ' . __FUNCTION__, 3);
-        $this->debugLog(" - - line_item->name() : " . $line_item->name(), 3);
-        $this->debugLog(" - - line_item->code() : " . $line_item->code(), 3);
-        // for the actual pre-tax sub-total line item, we want to save the pretax value for everything
-        if ($line_item->is_sub_total() && $line_item->code() === 'pre-tax-subtotal') {
-            $this->updateTotal($line_item, $pretax_total, true);
-        } elseif (! $line_item->is_total()) {
-            // we don't update the total for the total line item, because that will need to include taxes
-            $total = $this->updateTotal($line_item, $total, true);
-        }
-        $this->debugLog(' - ' . __FUNCTION__, 3);
-        $this->debugLog(" - - total : $total ", 3);
-        $this->debugLog(" - - pretax: $pretax_total ", 3);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateLineItem(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0
-    ): array {
-        $this->debugLog(__FUNCTION__);
-        $this->reorderSubLineItems($line_item);
-        [$total, $pretax_total] = $line_item->is_percent()
-            ? $this->recalculatePercentageLineItem($line_item, $total, $pretax_total)
-            : $this->recalculateNonPercentageLineItem($line_item);
-
-        $total        = $this->updateTotal($line_item, $total, true);
-        $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
-
-        // need to also adjust unit price too if the pretax total or quantity has been updated
-        $this->updateUnitPrice($line_item, $pretax_total);
-        $this->debugLog(' - ' . __FUNCTION__, 3);
-        $this->debugLog(" - - total : $total", 3);
-        $this->debugLog(" - - pretax: $pretax_total", 3);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param float        $pretax_total
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.12.p
-     */
-    private function recalculatePercentageLineItem(
-        EE_Line_Item $line_item,
-        float $total = 0,
-        float $pretax_total = 0
-    ): array {
-        $this->debugLog(' % ' . __FUNCTION__, 2);
-        $pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
-        // if the line item is taxable, then we need to calculate the total,
-        // otherwise we can just use the pretax total
-        $total = $line_item->is_taxable()
-            ? $this->calculatePercentage($total, $line_item->percent())
-            : $pretax_total;
-        $this->debugLog(' % ' . __FUNCTION__, 3);
-        $this->debugLog(" % % total : $total ", 3);
-        $this->debugLog(" % % pretax: $pretax_total ", 3);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.12.p
-     */
-    private function recalculateNonPercentageLineItem(
-        EE_Line_Item $line_item
-    ): array {
-        $this->debugLog(' $ ' . __FUNCTION__, 2);
-        // recursively loop through children and recalculate their totals
-        $children = $line_item->children($this->default_query_params);
-        if (! empty($children)) {
-            // reset the total and pretax total to zero since we are recalculating them
-            $total = $pretax_total = 0;
-            foreach ($children as $child_line_item) {
-                [$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
-                    $child_line_item,
-                    $total,
-                    $pretax_total,
-                    $line_item->is_taxable()
-                );
-                $this->debugLog(' $ $ ' . __FUNCTION__, 3);
-                $this->debugLog(
-                    ' $ $ $ ' . $child_line_item->name() . ' '
-                    . $child_line_item->type() . ' ' . $child_line_item->code(),
-                    3
-                );
-                $this->debugLog(" $ $ $ $ child total: $child_total", 3);
-                $this->debugLog(" $ $ $ $ child pretax: $child_pretax_total", 3);
-                $total        += $child_total;
-                $pretax_total += $child_pretax_total;
-            }
-        } else {
-            // no child line items, so recalculate the total from the unit price and quantity
-            // and set the pretax total to match since there are obviously no sub-taxes
-            $pretax_total = $total = $this->calculateTotalForQuantity($line_item);
-        }
-        $this->debugLog(' $ ' . __FUNCTION__, 3);
-        $this->debugLog(' $ $ ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
-        $this->debugLog(" $ $ $ total: $total", 3);
-        $this->debugLog(" $ $ $ pretax: $pretax_total", 3);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $sub_line_item
-     * @param float|int    $total
-     * @param float|int    $pretax_total
-     * @param bool         $is_taxable
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubLineItem(
-        EE_Line_Item $sub_line_item,
-        float $total = 0,
-        float $pretax_total = 0,
-        bool $is_taxable = false
-    ): array {
-        $this->debugLog(__FUNCTION__);
-        $total = $is_taxable ? $total : $pretax_total;
-        if ($sub_line_item->is_percent()) {
-            $new_total        = $this->calculatePercentage($total, $sub_line_item->percent());
-            $new_pretax_total = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
-        } else {
-            $new_total = $new_pretax_total = $this->calculateTotalForQuantity($sub_line_item);
-        }
-        $total        = $this->updateTotal($sub_line_item, $new_total, false, false);
-        $pretax_total = $this->updatePreTaxTotal($sub_line_item, $new_pretax_total, false, false);
-        // need to also adjust unit price too if the pretax total or quantity has been updated
-        $this->updateUnitPrice($sub_line_item, $pretax_total);
-        $this->debugLog(" - - total : $total ", 3);
-        $this->debugLog(" - - pretax: $pretax_total ", 3);
-        return [$total, $pretax_total];
-    }
-
-
-    /**
-     * @param EE_Line_Item $sub_line_item
-     * @param float|int    $pretax_total
-     * @return float[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateSubTax(EE_Line_Item $sub_line_item, float $pretax_total = 0): array
-    {
-        $this->debugLog(__FUNCTION__);
-        $total_tax = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
-        $total_tax = $this->updateTotal($sub_line_item, $total_tax);
-        $this->debugLog(" - total_tax : $total_tax ", 3);
-        return [$total_tax, 0];
-    }
-
-
-    /**
-     * recursively loops through the entire line item tree updating line item quantities accordingly.
-     * this needs to be done prior to running any other calculations for reasons that are hopefully obvious :p
-     *
-     * @param EE_Line_Item $line_item
-     * @param int          $quantity
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateLineItemQuantities(EE_Line_Item $line_item, int $quantity = 1): int
-    {
-        switch ($line_item->type()) {
-            case EEM_Line_Item::type_total:
-            case EEM_Line_Item::type_sub_total:
-            case EEM_Line_Item::type_tax_sub_total:
-                // first, loop through children and set their quantities
-                $count    = 0;
-                $children = $line_item->children($this->default_query_params);
-                foreach ($children as $child_line_item) {
-                    $count += $this->updateLineItemQuantities($child_line_item);
-                }
-                // totals and subtotals should have a quantity of 1
-                // unless their children have all been removed, in which case we can set them to 0
-                $quantity = $count > 0 ? 1 : 0;
-                $this->updateQuantity($line_item, $quantity);
-                return $quantity;
-
-            case EEM_Line_Item::type_line_item:
-                // line items should ALREADY have accurate quantities set, if not, then somebody done goofed!
-                // but if this is a percentage based line item, then ensure its quantity is 1
-                if ($line_item->is_percent()) {
-                    $this->updateQuantity($line_item, 1);
-                }
-                // and we also need to loop through all the sub items and ensure those quantities match this parent.
-                $children = $line_item->children($this->default_query_params);
-                $quantity = $line_item->quantity();
-                foreach ($children as $child_line_item) {
-                    $this->updateLineItemQuantities($child_line_item, $quantity);
-                }
-                // percentage line items should not increment their parent's count, so they return 0
-                return ! $line_item->is_percent() ? $quantity : 0;
-
-            case EEM_Line_Item::type_sub_line_item:
-                // percentage based items need their quantity set to 1,
-                // all others use the incoming value from the parent line item
-                $quantity = $line_item->is_percent() ? 1 : $quantity;
-                $this->updateQuantity($line_item, $quantity);
-                // percentage line items should not increment their parent's count, so they return 0
-                return ! $line_item->is_percent() ? $quantity : 0;
-
-            case EEM_Line_Item::type_tax:
-            case EEM_Line_Item::type_sub_tax:
-                // taxes should have a quantity of 1
-                $this->updateQuantity($line_item, 1);
-                return 1;
-
-            case EEM_Line_Item::type_cancellation:
-                // cancellations will be ignored for all calculations
-                // because their parent quantities should have already been adjusted when they were added
-                // so assume that things are already set correctly
-                return 0;
-        }
-        return 0;
-    }
-
-
-    /**
-     * @param float $total
-     * @param float $percent
-     * @param bool  $round
-     * @return float
-     */
-    private function calculatePercentage(float $total, float $percent, bool $round = false): float
-    {
-        $amount = $total * $percent / 100;
-        $amount = $this->decimal_values->roundDecimalValue($amount, $round);
-        $this->debugLog(' % ' . __FUNCTION__, 2);
-        $this->debugLog(" % % total: $total", 3);
-        $this->debugLog(" % % percent: $percent", 3);
-        $this->debugLog(" % % amount: $amount", 3);
-        return $amount;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function calculateTotalForQuantity(EE_Line_Item $line_item): float
-    {
-        $this->debugLog(' # ' . __FUNCTION__, 2);
-        $this->debugLog(' # # ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
-        $this->debugLog(" # # # unit_price: " . $line_item->unit_price(), 3);
-        $this->debugLog(" # # # quantity: " . $line_item->quantity(), 3);
-        $total = $line_item->unit_price() * $line_item->quantity();
-        return $this->decimal_values->roundDecimalValue($total);
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $percent
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updatePercent(EE_Line_Item $line_item, float $percent)
-    {
-        // update and save new percent only if incoming value does not match existing value
-        if ($line_item->percent() !== $percent) {
-            $line_item->set_percent($percent);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $pretax_total
-     * @param bool         $round
-     * @param bool         $save
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updatePreTaxTotal(
-        EE_Line_Item $line_item,
-        float $pretax_total,
-        bool $round = false,
-        bool $save = true
-    ): float {
-        $pretax_total = $this->decimal_values->roundDecimalValue($pretax_total, $round);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->preTaxTotal() !== $pretax_total) {
-            $line_item->setPreTaxTotal($pretax_total);
-            if ($save) {
-                $line_item->maybe_save();
-            }
-        }
-        return $pretax_total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param int          $quantity
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateQuantity(EE_Line_Item $line_item, int $quantity)
-    {
-        // update and save new quantity only if incoming value does not match existing value
-        if ($line_item->quantity() !== $quantity) {
-            $line_item->set_quantity($quantity);
-            $line_item->maybe_save();
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param bool         $round
-     * @param bool         $save
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTotal(EE_Line_Item $line_item, float $total, bool $round = false, bool $save = true): float
-    {
-        $total = $this->decimal_values->roundDecimalValue($total, $round);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->total() !== $total) {
-            $line_item->set_total($total);
-            if ($save) {
-                $line_item->maybe_save();
-            }
-        }
-        return (float) $total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $total
-     * @param bool         $update_status
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateTransaction(EE_Line_Item $line_item, float $total, bool $update_status)
-    {
-        // only update the related transaction's total
-        // if we intend to save this line item and it's a grand total
-        if ($line_item->allow_persist()) {
-            $transaction = $line_item->transaction();
-            if ($transaction instanceof EE_Transaction) {
-                $transaction->set_total($total);
-                if ($update_status) {
-                    // don't save the TXN because that will be done below
-                    // and the following method only saves if the status changes
-                    $transaction->update_status_based_on_total_paid(false);
-                }
-                if ($transaction->ID()) {
-                    $transaction->save();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @param EE_Line_Item $line_item
-     * @param float        $pretax_total
-     * @param bool         $save
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function updateUnitPrice(EE_Line_Item $line_item, float $pretax_total, bool $save = true)
-    {
-        $quantity = $line_item->quantity();
-        // don't divide by zero else you'll create a singularity and implode the interweb
-        // we also don't set unit prices for percentage based line items
-        if ($quantity === 0 || $line_item->is_percent()) {
-            return;
-        }
-        $new_unit_price = $pretax_total / $quantity;
-        $new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
-        // update and save new total only if incoming value does not match existing value
-        if ($line_item->unit_price() !== $new_unit_price) {
-            $this->debugLog(' @ ' . __FUNCTION__, 3);
-            $this->debugLog(' @ @ ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
-            $this->debugLog(" @ @ @ pretax: $pretax_total", 3);
-            $this->debugLog(" @ @ @ quantity: $quantity", 3);
-            $this->debugLog(" @ @ @ old unit price: " . $line_item->unit_price(), 3);
-            $this->debugLog(" @ @ @ new unit price: $new_unit_price", 3);
-            $line_item->set_unit_price($new_unit_price);
-            if ($save) {
-                $line_item->maybe_save();
-            }
-        }
-    }
-
-
-    /**
-     * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
-     * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
-     * and tax sub-total if already in the DB
-     *
-     * @param EE_Line_Item $total_line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function recalculateTaxesAndTaxTotal(EE_Line_Item $total_line_item): float
-    {
-        $this->debugLog(__FUNCTION__, 3);
-        $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
-        // calculate the total taxable amount for globally applied taxes
-        $taxable_total    = $this->taxableAmountForGlobalTaxes($total_line_item);
-        [$total_tax, $global_taxes ]    = $this->applyGlobalTaxes($total_line_item, $taxable_total);
-        $non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
-        $all_tax_total    = $this->applyNonGlobalTaxes($total_line_item, $total_tax, $global_taxes, $non_global_taxes);
-        $this->recalculateTaxSubTotal($total_line_item);
-        $this->debugLog(" - taxable_total : $taxable_total", 4);
-        $this->debugLog(" - total_tax : $total_tax", 4);
-        $this->debugLog(" - all_tax_total : $all_tax_total", 4);
-        return $all_tax_total;
-    }
-
-
-    /**
-     * @param EE_Line_Item $total_line_item
-     * @param float        $taxable_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyGlobalTaxes(EE_Line_Item $total_line_item, float $taxable_total): array
-    {
-        $this->debugLog(__FUNCTION__, 4);
-        $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
-        $total_tax = 0;
-        if ($taxable_total === 0.0) {
-            return [0, []];
-        }
-        // loop through all global taxes all taxes
-        $global_taxes = $total_line_item->tax_descendants();
-        foreach ($global_taxes as $tax) {
-            $tax_total = $this->calculatePercentage($taxable_total, $tax->percent());
-            if ($tax_total === 0.0) {
-                $tax->delete();
-                continue;
-            }
-            $tax_total = $this->updateTotal($tax, $tax_total, true);
-            $total_tax += $tax_total;
-        }
-        return [$this->decimal_values->roundDecimalValue($total_tax, true), $global_taxes];
-    }
-
-
-    /**
-     * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
-     *
-     * @param EE_Line_Item $line_item
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function recalculateTaxSubTotal(EE_Line_Item $line_item)
-    {
-        $this->debugLog(__FUNCTION__, 4);
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        foreach ($line_item->children() as $maybe_tax_subtotal) {
-            if (
-                $this->validateLineItemAndType($maybe_tax_subtotal)
-                && $maybe_tax_subtotal->is_tax_sub_total()
-            ) {
-                $total         = 0;
-                $total_percent = 0;
-                // simply loop through all its children (which should be taxes) and sum their total
-                foreach ($maybe_tax_subtotal->children() as $child_tax) {
-                    if ($this->validateLineItemAndType($child_tax) && $child_tax->isGlobalTax()) {
-                        $total         += $child_tax->total();
-                        $total_percent += $child_tax->percent();
-                    }
-                }
-                $this->updateTotal($maybe_tax_subtotal, $total, true);
-                $this->updatePercent($maybe_tax_subtotal, $total_percent);
-            }
-        }
-    }
-
-
-    /**
-     * returns an array of tax details like:
-     *  [
-     *      'GST_7' => [
-     *          'name'  => 'GST',
-     *          'rate'  => float(7),
-     *          'total' => float(4.9),
-     *      ]
-     *  ]
-     *
-     * @param EE_Line_Item $total_line_item
-     * @param array        $non_global_taxes
-     * @param float        $line_item_total
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function calculateNonGlobalTaxes(
-        EE_Line_Item $total_line_item,
-        array $non_global_taxes = [],
-        float $line_item_total = 0
-    ): array {
-        $this->debugLog(__FUNCTION__, 4);
-        foreach ($total_line_item->children() as $line_item) {
-            if ($this->validateLineItemAndType($line_item)) {
-                if ($line_item->is_sub_total()) {
-                    $non_global_taxes = $this->calculateNonGlobalTaxes($line_item, $non_global_taxes);
-                } elseif ($line_item->is_line_item()) {
-                    $non_global_taxes = $this->calculateNonGlobalTaxes(
-                        $line_item,
-                        $non_global_taxes,
-                        $line_item->pretaxTotal()
-                    );
-                } elseif ($line_item->isSubTax()) {
-                    $tax_ID = $line_item->name() . '_' . $line_item->percent();
-                    if (! isset($non_global_taxes[ $tax_ID ])) {
-                        $non_global_taxes[ $tax_ID ] = [
-                            'name'  => $line_item->name(),
-                            'rate'  => $line_item->percent(),
-                            'total' => 0,
-                            'obj'   => $line_item->OBJ_type(),
-                            'objID' => $line_item->OBJ_ID(),
-                        ];
-                    }
-                    $tax = $this->calculatePercentage($line_item_total, $line_item->percent());
-
-                    $non_global_taxes[ $tax_ID ]['total'] += $tax;
-                }
-            }
-        }
-        return $non_global_taxes;
-    }
-
-
-    /**
-     * @param EE_Line_Item   $total_line_item
-     * @param float          $tax_total
-     * @param EE_Line_Item[] $global_taxes array of tax line items returned from applyGlobalTaxes()
-     * @param array          $non_global_taxes array of tax details generated by calculateNonGlobalTaxes()
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function applyNonGlobalTaxes(
-        EE_Line_Item $total_line_item,
-        float $tax_total,
-        array $global_taxes,
-        array $non_global_taxes
-    ): float {
-        $this->debugLog(__FUNCTION__, 4);
-        $taxes_subtotal = EEH_Line_Item::get_taxes_subtotal($total_line_item);
-        foreach ($non_global_taxes as $non_global_tax) {
-            $found = false;
-            foreach ($global_taxes as $global_tax) {
-                if (
-                    $this->validateLineItemAndType($global_tax)
-                    && $non_global_tax['obj'] === $global_tax->OBJ_type()
-                    && $non_global_tax['objID'] === $global_tax->OBJ_ID()
-                ) {
-                    $found     = true;
-                    $new_total = $global_tax->total() + $non_global_tax['total'];
-                    // add non-global tax to matching global tax AND the tax total
-                    $global_tax->set_total($new_total);
-                    $global_tax->maybe_save();
-                    $tax_total += $non_global_tax['total'];
-                }
-            }
-            if (! $found) {
-                // add a new line item for this non-global tax
-                $taxes_subtotal->add_child_line_item(
-                    EE_Line_Item::new_instance(
-                        [
-                            'LIN_name'       => $non_global_tax['name'],
-                            'LIN_percent'    => $non_global_tax['rate'],
-                            'LIN_is_taxable' => false,
-                            'LIN_total'      => $non_global_tax['total'],
-                            'LIN_type'       => EEM_Line_Item::type_tax,
-                            'OBJ_type'       => $non_global_tax['obj'],
-                            'OBJ_ID'         => $non_global_tax['objID'],
-                        ]
-                    )
-                );
-                $tax_total += $non_global_tax['total'];
-            }
-        }
-        return $this->decimal_values->roundDecimalValue($tax_total, true);
-    }
-
-
-    /**
-     * Gets the total tax on this line item. Assumes taxes have already been calculated using
-     * recalculate_taxes_and_total
-     *
-     * @param EE_Line_Item $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getTotalTax(EE_Line_Item $line_item): float
-    {
-        $this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
-        $this->recalculateTaxSubTotal($line_item);
-        $total = 0;
-        foreach ($line_item->tax_descendants() as $tax_line_item) {
-            if ($this->validateLineItemAndType($tax_line_item)) {
-                $total += $tax_line_item->total();
-            }
-        }
-        return $this->decimal_values->roundDecimalValue($total, true);
-    }
-
-
-    /**
-     * Returns the amount taxable among this line item's children (or if it has no children,
-     * how much of it is taxable). Does not recalculate totals or subtotals.
-     * If the taxable total is negative, (eg, if none of the tickets were taxable,
-     * but there is a "Taxable" discount), returns 0.
-     *
-     * @param EE_Line_Item|null $line_item
-     * @return float
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
-    {
-        $this->debugLog(__FUNCTION__, 4);
-        $total            = 0;
-        $child_line_items = $line_item->children($this->default_query_params);
-        foreach ($child_line_items as $child_line_item) {
-            $this->validateLineItemAndType($child_line_item);
-            if ($child_line_item->is_sub_total()) {
-                $total += $this->taxableAmountForGlobalTaxes($child_line_item);
-            } elseif ($child_line_item->is_line_item() && $child_line_item->is_taxable()) {
-                // if it's a percent item, only take into account
-                // the percentage that's taxable (the taxable total so far)
-                if ($child_line_item->is_percent()) {
-                    $total += $this->calculatePercentage($total, $child_line_item->percent(), true);
-                } else {
-                    // pretax total will be equal to the total for line items with globally applied taxes
-                    $pretax_total = $this->calculateTotalForQuantity($child_line_item);
-                    $total        += $this->updatePreTaxTotal($child_line_item, $pretax_total);
-                }
-            }
-        }
-        return max($total, 0);
-    }
-
-
-    /**
-     * @param EE_Line_Item|null $line_item
-     * @param string|null       $type
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
-    {
-        if (! $line_item instanceof EE_Line_Item) {
-            throw new DomainException(
-                esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
-            );
-        }
-        if ($type && $line_item->type() !== $type) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'Invalid Line Item type supplied. Received "%1$s" but expected "%2$s".',
-                        'event_espresso'
-                    ),
-                    $line_item->type(),
-                    $type
-                )
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * loops through all sub-line-items for the supplied line item and reorders them as follows:
-     * 1. sub items
-     * 2. other??? (not a sub-item or sub-tax)
-     * 3. sub taxes
-     *
-     * @param EE_Line_Item $line_item
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since 5.0.12.p
-     */
-    public function reorderSubLineItems(EE_Line_Item $line_item)
-    {
-        if ($line_item->type() !== EEM_Line_Item::type_line_item) {
-            return;
-        }
-        $this->debugLog(' + LineItemCalculator::reorderSubLineItems', 3);
-        $this->debugLog(
-            ' + + ' . $line_item->OBJ_type() . ' ' . $line_item->name()
-            . ' - ' . $line_item->type() . ' (' . $line_item->code() . ')',
-            3
-        );
-        $sub_line_items = $line_item->children();
-        $items          = [];
-        $other          = [];
-        $taxes          = [];
-        foreach ($sub_line_items as $sub_line_item) {
-            switch ($sub_line_item->type()) {
-                case EEM_Line_Item::type_sub_line_item:
-                    $items[ $sub_line_item->ID() ] = $sub_line_item;
-                    break;
-                case EEM_Line_Item::type_sub_tax:
-                    $taxes[ $sub_line_item->ID() ] = $sub_line_item;
-                    break;
-                default:
-                    $other[ $sub_line_item->ID() ] = $sub_line_item;
-            }
-        }
-        $order      = 0;
-        $line_items = apply_filters(
-            'FHEE__EventEspresso_core_services_calculators_LineItemCalculator__reorderSubLineItems__line_items',
-            ['items' => $items, 'other' => $other, 'taxes' => $taxes]
-        );
-        foreach ($line_items as $sub_items) {
-            foreach ($sub_items as $sub_item) {
-                $order++;
-                $sub_item->set_order($order);
-                $sub_item->save();
-                $this->debugLog(
-                    ' + + + ' . $order . '. ' . $sub_item->OBJ_type() . ' ' . $sub_item->name()
-                    . ' - ' . $sub_item->type() . ' (' . $sub_item->code() . ')',
-                    3
-                );
-            }
-        }
-    }
+	use DebugDisplay;
+
+	protected DecimalValues $decimal_values;
+
+	protected array $default_query_params = [
+		['LIN_type' => ['!=', EEM_Line_Item::type_cancellation]],
+	];
+
+
+	/**
+	 * @param DecimalValues $decimal_values
+	 */
+	public function __construct(DecimalValues $decimal_values)
+	{
+		$this->decimal_values = $decimal_values;
+		$this->initializeDebugDisplay();
+	}
+
+
+	/**
+	 * Gets the final total on this item, taking taxes into account.
+	 * Has the side effect of setting the sub-total as it was just calculated.
+	 * If this is used on a grand-total line item, also updates the transaction's
+	 * TXN_total (provided this line item is allowed to persist, otherwise we don't
+	 * want to change a persistable transaction with info from a non-persistent line item)
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param bool         $update_txn_status
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateTotalIncludingTaxes(EE_Line_Item $line_item, bool $update_txn_status = false): float
+	{
+		$this->debugLog('', 2);
+		$this->debugLog(__METHOD__);
+		$this->debugLog(str_repeat('*', strlen(__METHOD__)), 2);
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		$ticket_line_items = EEH_Line_Item::get_ticket_line_items($line_item);
+		if (empty($ticket_line_items)) {
+			// no tickets? ensure totals are zero
+			$this->updatePreTaxTotal($line_item, 0);
+			$this->updateTotal($line_item, 0);
+			$this->updateTransaction($line_item, 0, $update_txn_status);
+			return 0;
+		}
+		[, $pretax_total] = $this->recalculateLineItemTotals($line_item);
+		// EEH_Line_Item::visualize($line_item);
+		$total_tax = $this->recalculateTaxesAndTaxTotal($line_item);
+		// no negative totals plz
+		$grand_total = max($pretax_total + $total_tax, 0);
+		$this->updatePreTaxTotal($line_item, $pretax_total, true);
+		$grand_total = $this->updateTotal($line_item, $grand_total, true);
+		$this->updateTransaction($line_item, $grand_total, $update_txn_status);
+		return $grand_total;
+	}
+
+
+	/**
+	 * Recursively goes through all the children and recalculates sub-totals EXCEPT for
+	 * tax-sub-totals (they're an odd beast). Updates the 'total' on each line item according to either its
+	 * unit price * quantity or the total of all its children EXCEPT when we're only calculating the taxable total and
+	 * when this is called on the grand total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @param bool         $is_taxable
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateLineItemTotals(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0,
+		bool $is_taxable = false
+	): array {
+		$this->debugLog(__FUNCTION__);
+		$OBJ = $line_item->OBJ_type();
+		$OBJ .= $OBJ ? ': ' : '';
+		$this->debugLog(
+			' * ' . $OBJ . $line_item->name() . ' - ' . $line_item->type() . ' (' . $line_item->code() . ')',
+			2
+		);
+		$this->debugLog(" * total: $total", 3);
+		$this->debugLog(" * pretax: $pretax_total", 3);
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+			case EEM_Line_Item::type_sub_total:
+				[$total, $pretax_total] = $this->recalculateSubTotal($line_item);
+				break;
+
+			case EEM_Line_Item::type_line_item:
+				[$total, $pretax_total] = $this->recalculateLineItem($line_item, $total, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_sub_line_item:
+				// sub-line-items operate on the total and update both the total AND the pre-tax total
+				[$total, $pretax_total] = $this->recalculateSubLineItem($line_item, $total, $pretax_total, $is_taxable);
+				break;
+
+			case EEM_Line_Item::type_sub_tax:
+				// sub-line-items taxes ONLY operate on the pre-tax total and ONLY update the total
+				[$total, $pretax_total] = $this->recalculateSubTax($line_item, $pretax_total);
+				break;
+
+			case EEM_Line_Item::type_tax_sub_total:
+			case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_cancellation:
+				// completely ignore tax totals, tax sub-totals, and cancelled line items
+				// when calculating the pre-tax-total
+				$total = $pretax_total = 0;
+				break;
+		}
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubTotal(EE_Line_Item $line_item): array
+	{
+		$this->debugLog(__FUNCTION__);
+		// reset the total and pretax total to zero since we are recalculating them
+		$total = $pretax_total = 0;
+		if ($line_item->is_total()) {
+			// if this is the grand total line item
+			// then first update ALL the line item quantities (if need be)
+			$this->updateLineItemQuantities($line_item);
+		}
+		// recursively loop through children and recalculate their totals
+		$children = $line_item->children($this->default_query_params);
+		if (empty($children)) {
+			$this->debugLog(' - ' . __FUNCTION__, 3);
+			$this->debugLog(" - - total : $total ", 3);
+			$this->debugLog(" - - pretax: $pretax_total ", 3);
+			return [$total, $pretax_total];
+		}
+		foreach ($children as $child_line_item) {
+			[$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
+				$child_line_item,
+				$total,
+				$pretax_total
+			);
+			$total        += $child_total;
+			$pretax_total += $child_pretax_total;
+		}
+		// update the unit price and pretax total
+		$this->updateUnitPrice($line_item, $pretax_total, false);
+		$pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true, false);
+		$this->debugLog(' - ' . __FUNCTION__, 3);
+		$this->debugLog(" - - line_item->name() : " . $line_item->name(), 3);
+		$this->debugLog(" - - line_item->code() : " . $line_item->code(), 3);
+		// for the actual pre-tax sub-total line item, we want to save the pretax value for everything
+		if ($line_item->is_sub_total() && $line_item->code() === 'pre-tax-subtotal') {
+			$this->updateTotal($line_item, $pretax_total, true);
+		} elseif (! $line_item->is_total()) {
+			// we don't update the total for the total line item, because that will need to include taxes
+			$total = $this->updateTotal($line_item, $total, true);
+		}
+		$this->debugLog(' - ' . __FUNCTION__, 3);
+		$this->debugLog(" - - total : $total ", 3);
+		$this->debugLog(" - - pretax: $pretax_total ", 3);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateLineItem(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0
+	): array {
+		$this->debugLog(__FUNCTION__);
+		$this->reorderSubLineItems($line_item);
+		[$total, $pretax_total] = $line_item->is_percent()
+			? $this->recalculatePercentageLineItem($line_item, $total, $pretax_total)
+			: $this->recalculateNonPercentageLineItem($line_item);
+
+		$total        = $this->updateTotal($line_item, $total, true);
+		$pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true);
+
+		// need to also adjust unit price too if the pretax total or quantity has been updated
+		$this->updateUnitPrice($line_item, $pretax_total);
+		$this->debugLog(' - ' . __FUNCTION__, 3);
+		$this->debugLog(" - - total : $total", 3);
+		$this->debugLog(" - - pretax: $pretax_total", 3);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param float        $pretax_total
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.12.p
+	 */
+	private function recalculatePercentageLineItem(
+		EE_Line_Item $line_item,
+		float $total = 0,
+		float $pretax_total = 0
+	): array {
+		$this->debugLog(' % ' . __FUNCTION__, 2);
+		$pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
+		// if the line item is taxable, then we need to calculate the total,
+		// otherwise we can just use the pretax total
+		$total = $line_item->is_taxable()
+			? $this->calculatePercentage($total, $line_item->percent())
+			: $pretax_total;
+		$this->debugLog(' % ' . __FUNCTION__, 3);
+		$this->debugLog(" % % total : $total ", 3);
+		$this->debugLog(" % % pretax: $pretax_total ", 3);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.12.p
+	 */
+	private function recalculateNonPercentageLineItem(
+		EE_Line_Item $line_item
+	): array {
+		$this->debugLog(' $ ' . __FUNCTION__, 2);
+		// recursively loop through children and recalculate their totals
+		$children = $line_item->children($this->default_query_params);
+		if (! empty($children)) {
+			// reset the total and pretax total to zero since we are recalculating them
+			$total = $pretax_total = 0;
+			foreach ($children as $child_line_item) {
+				[$child_total, $child_pretax_total] = $this->recalculateLineItemTotals(
+					$child_line_item,
+					$total,
+					$pretax_total,
+					$line_item->is_taxable()
+				);
+				$this->debugLog(' $ $ ' . __FUNCTION__, 3);
+				$this->debugLog(
+					' $ $ $ ' . $child_line_item->name() . ' '
+					. $child_line_item->type() . ' ' . $child_line_item->code(),
+					3
+				);
+				$this->debugLog(" $ $ $ $ child total: $child_total", 3);
+				$this->debugLog(" $ $ $ $ child pretax: $child_pretax_total", 3);
+				$total        += $child_total;
+				$pretax_total += $child_pretax_total;
+			}
+		} else {
+			// no child line items, so recalculate the total from the unit price and quantity
+			// and set the pretax total to match since there are obviously no sub-taxes
+			$pretax_total = $total = $this->calculateTotalForQuantity($line_item);
+		}
+		$this->debugLog(' $ ' . __FUNCTION__, 3);
+		$this->debugLog(' $ $ ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
+		$this->debugLog(" $ $ $ total: $total", 3);
+		$this->debugLog(" $ $ $ pretax: $pretax_total", 3);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $sub_line_item
+	 * @param float|int    $total
+	 * @param float|int    $pretax_total
+	 * @param bool         $is_taxable
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubLineItem(
+		EE_Line_Item $sub_line_item,
+		float $total = 0,
+		float $pretax_total = 0,
+		bool $is_taxable = false
+	): array {
+		$this->debugLog(__FUNCTION__);
+		$total = $is_taxable ? $total : $pretax_total;
+		if ($sub_line_item->is_percent()) {
+			$new_total        = $this->calculatePercentage($total, $sub_line_item->percent());
+			$new_pretax_total = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
+		} else {
+			$new_total = $new_pretax_total = $this->calculateTotalForQuantity($sub_line_item);
+		}
+		$total        = $this->updateTotal($sub_line_item, $new_total, false, false);
+		$pretax_total = $this->updatePreTaxTotal($sub_line_item, $new_pretax_total, false, false);
+		// need to also adjust unit price too if the pretax total or quantity has been updated
+		$this->updateUnitPrice($sub_line_item, $pretax_total);
+		$this->debugLog(" - - total : $total ", 3);
+		$this->debugLog(" - - pretax: $pretax_total ", 3);
+		return [$total, $pretax_total];
+	}
+
+
+	/**
+	 * @param EE_Line_Item $sub_line_item
+	 * @param float|int    $pretax_total
+	 * @return float[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateSubTax(EE_Line_Item $sub_line_item, float $pretax_total = 0): array
+	{
+		$this->debugLog(__FUNCTION__);
+		$total_tax = $this->calculatePercentage($pretax_total, $sub_line_item->percent());
+		$total_tax = $this->updateTotal($sub_line_item, $total_tax);
+		$this->debugLog(" - total_tax : $total_tax ", 3);
+		return [$total_tax, 0];
+	}
+
+
+	/**
+	 * recursively loops through the entire line item tree updating line item quantities accordingly.
+	 * this needs to be done prior to running any other calculations for reasons that are hopefully obvious :p
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @param int          $quantity
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateLineItemQuantities(EE_Line_Item $line_item, int $quantity = 1): int
+	{
+		switch ($line_item->type()) {
+			case EEM_Line_Item::type_total:
+			case EEM_Line_Item::type_sub_total:
+			case EEM_Line_Item::type_tax_sub_total:
+				// first, loop through children and set their quantities
+				$count    = 0;
+				$children = $line_item->children($this->default_query_params);
+				foreach ($children as $child_line_item) {
+					$count += $this->updateLineItemQuantities($child_line_item);
+				}
+				// totals and subtotals should have a quantity of 1
+				// unless their children have all been removed, in which case we can set them to 0
+				$quantity = $count > 0 ? 1 : 0;
+				$this->updateQuantity($line_item, $quantity);
+				return $quantity;
+
+			case EEM_Line_Item::type_line_item:
+				// line items should ALREADY have accurate quantities set, if not, then somebody done goofed!
+				// but if this is a percentage based line item, then ensure its quantity is 1
+				if ($line_item->is_percent()) {
+					$this->updateQuantity($line_item, 1);
+				}
+				// and we also need to loop through all the sub items and ensure those quantities match this parent.
+				$children = $line_item->children($this->default_query_params);
+				$quantity = $line_item->quantity();
+				foreach ($children as $child_line_item) {
+					$this->updateLineItemQuantities($child_line_item, $quantity);
+				}
+				// percentage line items should not increment their parent's count, so they return 0
+				return ! $line_item->is_percent() ? $quantity : 0;
+
+			case EEM_Line_Item::type_sub_line_item:
+				// percentage based items need their quantity set to 1,
+				// all others use the incoming value from the parent line item
+				$quantity = $line_item->is_percent() ? 1 : $quantity;
+				$this->updateQuantity($line_item, $quantity);
+				// percentage line items should not increment their parent's count, so they return 0
+				return ! $line_item->is_percent() ? $quantity : 0;
+
+			case EEM_Line_Item::type_tax:
+			case EEM_Line_Item::type_sub_tax:
+				// taxes should have a quantity of 1
+				$this->updateQuantity($line_item, 1);
+				return 1;
+
+			case EEM_Line_Item::type_cancellation:
+				// cancellations will be ignored for all calculations
+				// because their parent quantities should have already been adjusted when they were added
+				// so assume that things are already set correctly
+				return 0;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * @param float $total
+	 * @param float $percent
+	 * @param bool  $round
+	 * @return float
+	 */
+	private function calculatePercentage(float $total, float $percent, bool $round = false): float
+	{
+		$amount = $total * $percent / 100;
+		$amount = $this->decimal_values->roundDecimalValue($amount, $round);
+		$this->debugLog(' % ' . __FUNCTION__, 2);
+		$this->debugLog(" % % total: $total", 3);
+		$this->debugLog(" % % percent: $percent", 3);
+		$this->debugLog(" % % amount: $amount", 3);
+		return $amount;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function calculateTotalForQuantity(EE_Line_Item $line_item): float
+	{
+		$this->debugLog(' # ' . __FUNCTION__, 2);
+		$this->debugLog(' # # ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
+		$this->debugLog(" # # # unit_price: " . $line_item->unit_price(), 3);
+		$this->debugLog(" # # # quantity: " . $line_item->quantity(), 3);
+		$total = $line_item->unit_price() * $line_item->quantity();
+		return $this->decimal_values->roundDecimalValue($total);
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $percent
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updatePercent(EE_Line_Item $line_item, float $percent)
+	{
+		// update and save new percent only if incoming value does not match existing value
+		if ($line_item->percent() !== $percent) {
+			$line_item->set_percent($percent);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $pretax_total
+	 * @param bool         $round
+	 * @param bool         $save
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updatePreTaxTotal(
+		EE_Line_Item $line_item,
+		float $pretax_total,
+		bool $round = false,
+		bool $save = true
+	): float {
+		$pretax_total = $this->decimal_values->roundDecimalValue($pretax_total, $round);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->preTaxTotal() !== $pretax_total) {
+			$line_item->setPreTaxTotal($pretax_total);
+			if ($save) {
+				$line_item->maybe_save();
+			}
+		}
+		return $pretax_total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param int          $quantity
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateQuantity(EE_Line_Item $line_item, int $quantity)
+	{
+		// update and save new quantity only if incoming value does not match existing value
+		if ($line_item->quantity() !== $quantity) {
+			$line_item->set_quantity($quantity);
+			$line_item->maybe_save();
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param bool         $round
+	 * @param bool         $save
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTotal(EE_Line_Item $line_item, float $total, bool $round = false, bool $save = true): float
+	{
+		$total = $this->decimal_values->roundDecimalValue($total, $round);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->total() !== $total) {
+			$line_item->set_total($total);
+			if ($save) {
+				$line_item->maybe_save();
+			}
+		}
+		return (float) $total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $total
+	 * @param bool         $update_status
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateTransaction(EE_Line_Item $line_item, float $total, bool $update_status)
+	{
+		// only update the related transaction's total
+		// if we intend to save this line item and it's a grand total
+		if ($line_item->allow_persist()) {
+			$transaction = $line_item->transaction();
+			if ($transaction instanceof EE_Transaction) {
+				$transaction->set_total($total);
+				if ($update_status) {
+					// don't save the TXN because that will be done below
+					// and the following method only saves if the status changes
+					$transaction->update_status_based_on_total_paid(false);
+				}
+				if ($transaction->ID()) {
+					$transaction->save();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @param EE_Line_Item $line_item
+	 * @param float        $pretax_total
+	 * @param bool         $save
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function updateUnitPrice(EE_Line_Item $line_item, float $pretax_total, bool $save = true)
+	{
+		$quantity = $line_item->quantity();
+		// don't divide by zero else you'll create a singularity and implode the interweb
+		// we also don't set unit prices for percentage based line items
+		if ($quantity === 0 || $line_item->is_percent()) {
+			return;
+		}
+		$new_unit_price = $pretax_total / $quantity;
+		$new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
+		// update and save new total only if incoming value does not match existing value
+		if ($line_item->unit_price() !== $new_unit_price) {
+			$this->debugLog(' @ ' . __FUNCTION__, 3);
+			$this->debugLog(' @ @ ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
+			$this->debugLog(" @ @ @ pretax: $pretax_total", 3);
+			$this->debugLog(" @ @ @ quantity: $quantity", 3);
+			$this->debugLog(" @ @ @ old unit price: " . $line_item->unit_price(), 3);
+			$this->debugLog(" @ @ @ new unit price: $new_unit_price", 3);
+			$line_item->set_unit_price($new_unit_price);
+			if ($save) {
+				$line_item->maybe_save();
+			}
+		}
+	}
+
+
+	/**
+	 * Recalculates the total on each individual tax (based on a recalculation of the pre-tax total), sets
+	 * the totals on each tax calculated, and returns the final tax total. Re-saves tax line items
+	 * and tax sub-total if already in the DB
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function recalculateTaxesAndTaxTotal(EE_Line_Item $total_line_item): float
+	{
+		$this->debugLog(__FUNCTION__, 3);
+		$this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
+		// calculate the total taxable amount for globally applied taxes
+		$taxable_total    = $this->taxableAmountForGlobalTaxes($total_line_item);
+		[$total_tax, $global_taxes ]    = $this->applyGlobalTaxes($total_line_item, $taxable_total);
+		$non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
+		$all_tax_total    = $this->applyNonGlobalTaxes($total_line_item, $total_tax, $global_taxes, $non_global_taxes);
+		$this->recalculateTaxSubTotal($total_line_item);
+		$this->debugLog(" - taxable_total : $taxable_total", 4);
+		$this->debugLog(" - total_tax : $total_tax", 4);
+		$this->debugLog(" - all_tax_total : $all_tax_total", 4);
+		return $all_tax_total;
+	}
+
+
+	/**
+	 * @param EE_Line_Item $total_line_item
+	 * @param float        $taxable_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyGlobalTaxes(EE_Line_Item $total_line_item, float $taxable_total): array
+	{
+		$this->debugLog(__FUNCTION__, 4);
+		$this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
+		$total_tax = 0;
+		if ($taxable_total === 0.0) {
+			return [0, []];
+		}
+		// loop through all global taxes all taxes
+		$global_taxes = $total_line_item->tax_descendants();
+		foreach ($global_taxes as $tax) {
+			$tax_total = $this->calculatePercentage($taxable_total, $tax->percent());
+			if ($tax_total === 0.0) {
+				$tax->delete();
+				continue;
+			}
+			$tax_total = $this->updateTotal($tax, $tax_total, true);
+			$total_tax += $tax_total;
+		}
+		return [$this->decimal_values->roundDecimalValue($total_tax, true), $global_taxes];
+	}
+
+
+	/**
+	 * Simply forces all the tax-sub-totals to recalculate. Assumes the taxes have been calculated
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function recalculateTaxSubTotal(EE_Line_Item $line_item)
+	{
+		$this->debugLog(__FUNCTION__, 4);
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		foreach ($line_item->children() as $maybe_tax_subtotal) {
+			if (
+				$this->validateLineItemAndType($maybe_tax_subtotal)
+				&& $maybe_tax_subtotal->is_tax_sub_total()
+			) {
+				$total         = 0;
+				$total_percent = 0;
+				// simply loop through all its children (which should be taxes) and sum their total
+				foreach ($maybe_tax_subtotal->children() as $child_tax) {
+					if ($this->validateLineItemAndType($child_tax) && $child_tax->isGlobalTax()) {
+						$total         += $child_tax->total();
+						$total_percent += $child_tax->percent();
+					}
+				}
+				$this->updateTotal($maybe_tax_subtotal, $total, true);
+				$this->updatePercent($maybe_tax_subtotal, $total_percent);
+			}
+		}
+	}
+
+
+	/**
+	 * returns an array of tax details like:
+	 *  [
+	 *      'GST_7' => [
+	 *          'name'  => 'GST',
+	 *          'rate'  => float(7),
+	 *          'total' => float(4.9),
+	 *      ]
+	 *  ]
+	 *
+	 * @param EE_Line_Item $total_line_item
+	 * @param array        $non_global_taxes
+	 * @param float        $line_item_total
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function calculateNonGlobalTaxes(
+		EE_Line_Item $total_line_item,
+		array $non_global_taxes = [],
+		float $line_item_total = 0
+	): array {
+		$this->debugLog(__FUNCTION__, 4);
+		foreach ($total_line_item->children() as $line_item) {
+			if ($this->validateLineItemAndType($line_item)) {
+				if ($line_item->is_sub_total()) {
+					$non_global_taxes = $this->calculateNonGlobalTaxes($line_item, $non_global_taxes);
+				} elseif ($line_item->is_line_item()) {
+					$non_global_taxes = $this->calculateNonGlobalTaxes(
+						$line_item,
+						$non_global_taxes,
+						$line_item->pretaxTotal()
+					);
+				} elseif ($line_item->isSubTax()) {
+					$tax_ID = $line_item->name() . '_' . $line_item->percent();
+					if (! isset($non_global_taxes[ $tax_ID ])) {
+						$non_global_taxes[ $tax_ID ] = [
+							'name'  => $line_item->name(),
+							'rate'  => $line_item->percent(),
+							'total' => 0,
+							'obj'   => $line_item->OBJ_type(),
+							'objID' => $line_item->OBJ_ID(),
+						];
+					}
+					$tax = $this->calculatePercentage($line_item_total, $line_item->percent());
+
+					$non_global_taxes[ $tax_ID ]['total'] += $tax;
+				}
+			}
+		}
+		return $non_global_taxes;
+	}
+
+
+	/**
+	 * @param EE_Line_Item   $total_line_item
+	 * @param float          $tax_total
+	 * @param EE_Line_Item[] $global_taxes array of tax line items returned from applyGlobalTaxes()
+	 * @param array          $non_global_taxes array of tax details generated by calculateNonGlobalTaxes()
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function applyNonGlobalTaxes(
+		EE_Line_Item $total_line_item,
+		float $tax_total,
+		array $global_taxes,
+		array $non_global_taxes
+	): float {
+		$this->debugLog(__FUNCTION__, 4);
+		$taxes_subtotal = EEH_Line_Item::get_taxes_subtotal($total_line_item);
+		foreach ($non_global_taxes as $non_global_tax) {
+			$found = false;
+			foreach ($global_taxes as $global_tax) {
+				if (
+					$this->validateLineItemAndType($global_tax)
+					&& $non_global_tax['obj'] === $global_tax->OBJ_type()
+					&& $non_global_tax['objID'] === $global_tax->OBJ_ID()
+				) {
+					$found     = true;
+					$new_total = $global_tax->total() + $non_global_tax['total'];
+					// add non-global tax to matching global tax AND the tax total
+					$global_tax->set_total($new_total);
+					$global_tax->maybe_save();
+					$tax_total += $non_global_tax['total'];
+				}
+			}
+			if (! $found) {
+				// add a new line item for this non-global tax
+				$taxes_subtotal->add_child_line_item(
+					EE_Line_Item::new_instance(
+						[
+							'LIN_name'       => $non_global_tax['name'],
+							'LIN_percent'    => $non_global_tax['rate'],
+							'LIN_is_taxable' => false,
+							'LIN_total'      => $non_global_tax['total'],
+							'LIN_type'       => EEM_Line_Item::type_tax,
+							'OBJ_type'       => $non_global_tax['obj'],
+							'OBJ_ID'         => $non_global_tax['objID'],
+						]
+					)
+				);
+				$tax_total += $non_global_tax['total'];
+			}
+		}
+		return $this->decimal_values->roundDecimalValue($tax_total, true);
+	}
+
+
+	/**
+	 * Gets the total tax on this line item. Assumes taxes have already been calculated using
+	 * recalculate_taxes_and_total
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getTotalTax(EE_Line_Item $line_item): float
+	{
+		$this->validateLineItemAndType($line_item, EEM_Line_Item::type_total);
+		$this->recalculateTaxSubTotal($line_item);
+		$total = 0;
+		foreach ($line_item->tax_descendants() as $tax_line_item) {
+			if ($this->validateLineItemAndType($tax_line_item)) {
+				$total += $tax_line_item->total();
+			}
+		}
+		return $this->decimal_values->roundDecimalValue($total, true);
+	}
+
+
+	/**
+	 * Returns the amount taxable among this line item's children (or if it has no children,
+	 * how much of it is taxable). Does not recalculate totals or subtotals.
+	 * If the taxable total is negative, (eg, if none of the tickets were taxable,
+	 * but there is a "Taxable" discount), returns 0.
+	 *
+	 * @param EE_Line_Item|null $line_item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function taxableAmountForGlobalTaxes(?EE_Line_Item $line_item): float
+	{
+		$this->debugLog(__FUNCTION__, 4);
+		$total            = 0;
+		$child_line_items = $line_item->children($this->default_query_params);
+		foreach ($child_line_items as $child_line_item) {
+			$this->validateLineItemAndType($child_line_item);
+			if ($child_line_item->is_sub_total()) {
+				$total += $this->taxableAmountForGlobalTaxes($child_line_item);
+			} elseif ($child_line_item->is_line_item() && $child_line_item->is_taxable()) {
+				// if it's a percent item, only take into account
+				// the percentage that's taxable (the taxable total so far)
+				if ($child_line_item->is_percent()) {
+					$total += $this->calculatePercentage($total, $child_line_item->percent(), true);
+				} else {
+					// pretax total will be equal to the total for line items with globally applied taxes
+					$pretax_total = $this->calculateTotalForQuantity($child_line_item);
+					$total        += $this->updatePreTaxTotal($child_line_item, $pretax_total);
+				}
+			}
+		}
+		return max($total, 0);
+	}
+
+
+	/**
+	 * @param EE_Line_Item|null $line_item
+	 * @param string|null       $type
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
+	{
+		if (! $line_item instanceof EE_Line_Item) {
+			throw new DomainException(
+				esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
+			);
+		}
+		if ($type && $line_item->type() !== $type) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'Invalid Line Item type supplied. Received "%1$s" but expected "%2$s".',
+						'event_espresso'
+					),
+					$line_item->type(),
+					$type
+				)
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * loops through all sub-line-items for the supplied line item and reorders them as follows:
+	 * 1. sub items
+	 * 2. other??? (not a sub-item or sub-tax)
+	 * 3. sub taxes
+	 *
+	 * @param EE_Line_Item $line_item
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since 5.0.12.p
+	 */
+	public function reorderSubLineItems(EE_Line_Item $line_item)
+	{
+		if ($line_item->type() !== EEM_Line_Item::type_line_item) {
+			return;
+		}
+		$this->debugLog(' + LineItemCalculator::reorderSubLineItems', 3);
+		$this->debugLog(
+			' + + ' . $line_item->OBJ_type() . ' ' . $line_item->name()
+			. ' - ' . $line_item->type() . ' (' . $line_item->code() . ')',
+			3
+		);
+		$sub_line_items = $line_item->children();
+		$items          = [];
+		$other          = [];
+		$taxes          = [];
+		foreach ($sub_line_items as $sub_line_item) {
+			switch ($sub_line_item->type()) {
+				case EEM_Line_Item::type_sub_line_item:
+					$items[ $sub_line_item->ID() ] = $sub_line_item;
+					break;
+				case EEM_Line_Item::type_sub_tax:
+					$taxes[ $sub_line_item->ID() ] = $sub_line_item;
+					break;
+				default:
+					$other[ $sub_line_item->ID() ] = $sub_line_item;
+			}
+		}
+		$order      = 0;
+		$line_items = apply_filters(
+			'FHEE__EventEspresso_core_services_calculators_LineItemCalculator__reorderSubLineItems__line_items',
+			['items' => $items, 'other' => $other, 'taxes' => $taxes]
+		);
+		foreach ($line_items as $sub_items) {
+			foreach ($sub_items as $sub_item) {
+				$order++;
+				$sub_item->set_order($order);
+				$sub_item->save();
+				$this->debugLog(
+					' + + + ' . $order . '. ' . $sub_item->OBJ_type() . ' ' . $sub_item->name()
+					. ' - ' . $sub_item->type() . ' (' . $sub_item->code() . ')',
+					3
+				);
+			}
+		}
+	}
 }

Spacing +40 added lines, -40 removed lines

@@ -103,7 +103,7 @@ 
         $OBJ = $line_item->OBJ_type();
         $OBJ .= $OBJ ? ': ' : '';
         $this->debugLog(
-            ' * ' . $OBJ . $line_item->name() . ' - ' . $line_item->type() . ' (' . $line_item->code() . ')',
+            ' * '.$OBJ.$line_item->name().' - '.$line_item->type().' ('.$line_item->code().')',
             2
         );
         $this->debugLog(" * total: $total", 3);
@@ -159,7 +159,7 @@ 
         // recursively loop through children and recalculate their totals
         $children = $line_item->children($this->default_query_params);
         if (empty($children)) {
-            $this->debugLog(' - ' . __FUNCTION__, 3);
+            $this->debugLog(' - '.__FUNCTION__, 3);
             $this->debugLog(" - - total : $total ", 3);
             $this->debugLog(" - - pretax: $pretax_total ", 3);
             return [$total, $pretax_total];
@@ -176,17 +176,17 @@ 
         // update the unit price and pretax total
         $this->updateUnitPrice($line_item, $pretax_total, false);
         $pretax_total = $this->updatePreTaxTotal($line_item, $pretax_total, true, false);
-        $this->debugLog(' - ' . __FUNCTION__, 3);
-        $this->debugLog(" - - line_item->name() : " . $line_item->name(), 3);
-        $this->debugLog(" - - line_item->code() : " . $line_item->code(), 3);
+        $this->debugLog(' - '.__FUNCTION__, 3);
+        $this->debugLog(" - - line_item->name() : ".$line_item->name(), 3);
+        $this->debugLog(" - - line_item->code() : ".$line_item->code(), 3);
         // for the actual pre-tax sub-total line item, we want to save the pretax value for everything
         if ($line_item->is_sub_total() && $line_item->code() === 'pre-tax-subtotal') {
             $this->updateTotal($line_item, $pretax_total, true);
-        } elseif (! $line_item->is_total()) {
+        } elseif ( ! $line_item->is_total()) {
             // we don't update the total for the total line item, because that will need to include taxes
             $total = $this->updateTotal($line_item, $total, true);
         }
-        $this->debugLog(' - ' . __FUNCTION__, 3);
+        $this->debugLog(' - '.__FUNCTION__, 3);
         $this->debugLog(" - - total : $total ", 3);
         $this->debugLog(" - - pretax: $pretax_total ", 3);
         return [$total, $pretax_total];
@@ -217,7 +217,7 @@ 
 
         // need to also adjust unit price too if the pretax total or quantity has been updated
         $this->updateUnitPrice($line_item, $pretax_total);
-        $this->debugLog(' - ' . __FUNCTION__, 3);
+        $this->debugLog(' - '.__FUNCTION__, 3);
         $this->debugLog(" - - total : $total", 3);
         $this->debugLog(" - - pretax: $pretax_total", 3);
         return [$total, $pretax_total];
@@ -238,14 +238,14 @@ 
         float $total = 0,
         float $pretax_total = 0
     ): array {
-        $this->debugLog(' % ' . __FUNCTION__, 2);
+        $this->debugLog(' % '.__FUNCTION__, 2);
         $pretax_total = $this->calculatePercentage($pretax_total, $line_item->percent());
         // if the line item is taxable, then we need to calculate the total,
         // otherwise we can just use the pretax total
         $total = $line_item->is_taxable()
             ? $this->calculatePercentage($total, $line_item->percent())
             : $pretax_total;
-        $this->debugLog(' % ' . __FUNCTION__, 3);
+        $this->debugLog(' % '.__FUNCTION__, 3);
         $this->debugLog(" % % total : $total ", 3);
         $this->debugLog(" % % pretax: $pretax_total ", 3);
         return [$total, $pretax_total];
@@ -262,10 +262,10 @@ 
     private function recalculateNonPercentageLineItem(
         EE_Line_Item $line_item
     ): array {
-        $this->debugLog(' $ ' . __FUNCTION__, 2);
+        $this->debugLog(' $ '.__FUNCTION__, 2);
         // recursively loop through children and recalculate their totals
         $children = $line_item->children($this->default_query_params);
-        if (! empty($children)) {
+        if ( ! empty($children)) {
             // reset the total and pretax total to zero since we are recalculating them
             $total = $pretax_total = 0;
             foreach ($children as $child_line_item) {
@@ -275,10 +275,10 @@ 
                     $pretax_total,
                     $line_item->is_taxable()
                 );
-                $this->debugLog(' $ $ ' . __FUNCTION__, 3);
+                $this->debugLog(' $ $ '.__FUNCTION__, 3);
                 $this->debugLog(
-                    ' $ $ $ ' . $child_line_item->name() . ' '
-                    . $child_line_item->type() . ' ' . $child_line_item->code(),
+                    ' $ $ $ '.$child_line_item->name().' '
+                    . $child_line_item->type().' '.$child_line_item->code(),
                     3
                 );
                 $this->debugLog(" $ $ $ $ child total: $child_total", 3);
@@ -291,8 +291,8 @@ 
             // and set the pretax total to match since there are obviously no sub-taxes
             $pretax_total = $total = $this->calculateTotalForQuantity($line_item);
         }
-        $this->debugLog(' $ ' . __FUNCTION__, 3);
-        $this->debugLog(' $ $ ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
+        $this->debugLog(' $ '.__FUNCTION__, 3);
+        $this->debugLog(' $ $ '.$line_item->name().' '.$line_item->type().' '.$line_item->code(), 3);
         $this->debugLog(" $ $ $ total: $total", 3);
         $this->debugLog(" $ $ $ pretax: $pretax_total", 3);
         return [$total, $pretax_total];
@@ -426,7 +426,7 @@ 
     {
         $amount = $total * $percent / 100;
         $amount = $this->decimal_values->roundDecimalValue($amount, $round);
-        $this->debugLog(' % ' . __FUNCTION__, 2);
+        $this->debugLog(' % '.__FUNCTION__, 2);
         $this->debugLog(" % % total: $total", 3);
         $this->debugLog(" % % percent: $percent", 3);
         $this->debugLog(" % % amount: $amount", 3);
@@ -442,10 +442,10 @@ 
      */
     private function calculateTotalForQuantity(EE_Line_Item $line_item): float
     {
-        $this->debugLog(' # ' . __FUNCTION__, 2);
-        $this->debugLog(' # # ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
-        $this->debugLog(" # # # unit_price: " . $line_item->unit_price(), 3);
-        $this->debugLog(" # # # quantity: " . $line_item->quantity(), 3);
+        $this->debugLog(' # '.__FUNCTION__, 2);
+        $this->debugLog(' # # '.$line_item->name().' '.$line_item->type().' '.$line_item->code(), 3);
+        $this->debugLog(" # # # unit_price: ".$line_item->unit_price(), 3);
+        $this->debugLog(" # # # quantity: ".$line_item->quantity(), 3);
         $total = $line_item->unit_price() * $line_item->quantity();
         return $this->decimal_values->roundDecimalValue($total);
     }
@@ -582,11 +582,11 @@ 
         $new_unit_price = $this->decimal_values->roundDecimalValue($new_unit_price);
         // update and save new total only if incoming value does not match existing value
         if ($line_item->unit_price() !== $new_unit_price) {
-            $this->debugLog(' @ ' . __FUNCTION__, 3);
-            $this->debugLog(' @ @ ' . $line_item->name() . ' ' . $line_item->type() . ' ' . $line_item->code(), 3);
+            $this->debugLog(' @ '.__FUNCTION__, 3);
+            $this->debugLog(' @ @ '.$line_item->name().' '.$line_item->type().' '.$line_item->code(), 3);
             $this->debugLog(" @ @ @ pretax: $pretax_total", 3);
             $this->debugLog(" @ @ @ quantity: $quantity", 3);
-            $this->debugLog(" @ @ @ old unit price: " . $line_item->unit_price(), 3);
+            $this->debugLog(" @ @ @ old unit price: ".$line_item->unit_price(), 3);
             $this->debugLog(" @ @ @ new unit price: $new_unit_price", 3);
             $line_item->set_unit_price($new_unit_price);
             if ($save) {
@@ -612,7 +612,7 @@ 
         $this->validateLineItemAndType($total_line_item, EEM_Line_Item::type_total);
         // calculate the total taxable amount for globally applied taxes
         $taxable_total    = $this->taxableAmountForGlobalTaxes($total_line_item);
-        [$total_tax, $global_taxes ]    = $this->applyGlobalTaxes($total_line_item, $taxable_total);
+        [$total_tax, $global_taxes] = $this->applyGlobalTaxes($total_line_item, $taxable_total);
         $non_global_taxes = $this->calculateNonGlobalTaxes($total_line_item);
         $all_tax_total    = $this->applyNonGlobalTaxes($total_line_item, $total_tax, $global_taxes, $non_global_taxes);
         $this->recalculateTaxSubTotal($total_line_item);
@@ -720,9 +720,9 @@ 
                         $line_item->pretaxTotal()
                     );
                 } elseif ($line_item->isSubTax()) {
-                    $tax_ID = $line_item->name() . '_' . $line_item->percent();
-                    if (! isset($non_global_taxes[ $tax_ID ])) {
-                        $non_global_taxes[ $tax_ID ] = [
+                    $tax_ID = $line_item->name().'_'.$line_item->percent();
+                    if ( ! isset($non_global_taxes[$tax_ID])) {
+                        $non_global_taxes[$tax_ID] = [
                             'name'  => $line_item->name(),
                             'rate'  => $line_item->percent(),
                             'total' => 0,
@@ -732,7 +732,7 @@ 
                     }
                     $tax = $this->calculatePercentage($line_item_total, $line_item->percent());
 
-                    $non_global_taxes[ $tax_ID ]['total'] += $tax;
+                    $non_global_taxes[$tax_ID]['total'] += $tax;
                 }
             }
         }
@@ -773,7 +773,7 @@ 
                     $tax_total += $non_global_tax['total'];
                 }
             }
-            if (! $found) {
+            if ( ! $found) {
                 // add a new line item for this non-global tax
                 $taxes_subtotal->add_child_line_item(
                     EE_Line_Item::new_instance(
@@ -846,7 +846,7 @@ 
                 } else {
                     // pretax total will be equal to the total for line items with globally applied taxes
                     $pretax_total = $this->calculateTotalForQuantity($child_line_item);
-                    $total        += $this->updatePreTaxTotal($child_line_item, $pretax_total);
+                    $total += $this->updatePreTaxTotal($child_line_item, $pretax_total);
                 }
             }
         }
@@ -863,7 +863,7 @@ 
      */
     private function validateLineItemAndType(?EE_Line_Item $line_item, ?string $type = null): bool
     {
-        if (! $line_item instanceof EE_Line_Item) {
+        if ( ! $line_item instanceof EE_Line_Item) {
             throw new DomainException(
                 esc_html__('Invalid or missing Line Item supplied .', 'event_espresso')
             );
@@ -903,8 +903,8 @@ 
         }
         $this->debugLog(' + LineItemCalculator::reorderSubLineItems', 3);
         $this->debugLog(
-            ' + + ' . $line_item->OBJ_type() . ' ' . $line_item->name()
-            . ' - ' . $line_item->type() . ' (' . $line_item->code() . ')',
+            ' + + '.$line_item->OBJ_type().' '.$line_item->name()
+            . ' - '.$line_item->type().' ('.$line_item->code().')',
             3
         );
         $sub_line_items = $line_item->children();
@@ -914,13 +914,13 @@ 
         foreach ($sub_line_items as $sub_line_item) {
             switch ($sub_line_item->type()) {
                 case EEM_Line_Item::type_sub_line_item:
-                    $items[ $sub_line_item->ID() ] = $sub_line_item;
+                    $items[$sub_line_item->ID()] = $sub_line_item;
                     break;
                 case EEM_Line_Item::type_sub_tax:
-                    $taxes[ $sub_line_item->ID() ] = $sub_line_item;
+                    $taxes[$sub_line_item->ID()] = $sub_line_item;
                     break;
                 default:
-                    $other[ $sub_line_item->ID() ] = $sub_line_item;
+                    $other[$sub_line_item->ID()] = $sub_line_item;
             }
         }
         $order      = 0;
@@ -934,8 +934,8 @@ 
                 $sub_item->set_order($order);
                 $sub_item->save();
                 $this->debugLog(
-                    ' + + + ' . $order . '. ' . $sub_item->OBJ_type() . ' ' . $sub_item->name()
-                    . ' - ' . $sub_item->type() . ' (' . $sub_item->code() . ')',
+                    ' + + + '.$order.'. '.$sub_item->OBJ_type().' '.$sub_item->name()
+                    . ' - '.$sub_item->type().' ('.$sub_item->code().')',
                     3
                 );
             }