eventespresso / event-espresso-core

caffeinated/core/domain/services/pue/RegisterAddonPUE.php

Indentation +87 added lines, -87 removed lines

@@ -12,98 +12,98 @@
 
 class RegisterAddonPUE
 {
-    /**
-     * @var array
-     */
-    private static $addon_api_settings;
+	/**
+	 * @var array
+	 */
+	private static $addon_api_settings;
 
 
-    public static function registerPUE(
-        array $addon_api_settings,
-        string $addon_name,
-        string $class_name,
-        array $addon_args
-    ): array {
-        if (! empty($addon_args['pue_options'])) {
-            $addon_api_settings[ $addon_name ]['pue_options'] = [
-                'pue_plugin_slug' => isset($addon_args['pue_options']['pue_plugin_slug'])
-                    ? (string) $addon_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($addon_args['pue_options']['plugin_basename'])
-                    ? (string) $addon_args['pue_options']['plugin_basename']
-                    : plugin_basename($addon_args['main_file_path']),
-                'checkPeriod'     => isset($addon_args['pue_options']['checkPeriod'])
-                    ? (string) $addon_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($addon_args['pue_options']['use_wp_update'])
-                    ? (string) $addon_args['pue_options']['use_wp_update']
-                    : false,
-            ];
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                [RegisterAddonPUE::class, 'loadPueUpdate']
-            );
-        }
-        RegisterAddonPUE::$addon_api_settings = $addon_api_settings;
-        return $addon_api_settings;
-    }
+	public static function registerPUE(
+		array $addon_api_settings,
+		string $addon_name,
+		string $class_name,
+		array $addon_args
+	): array {
+		if (! empty($addon_args['pue_options'])) {
+			$addon_api_settings[ $addon_name ]['pue_options'] = [
+				'pue_plugin_slug' => isset($addon_args['pue_options']['pue_plugin_slug'])
+					? (string) $addon_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($addon_args['pue_options']['plugin_basename'])
+					? (string) $addon_args['pue_options']['plugin_basename']
+					: plugin_basename($addon_args['main_file_path']),
+				'checkPeriod'     => isset($addon_args['pue_options']['checkPeriod'])
+					? (string) $addon_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($addon_args['pue_options']['use_wp_update'])
+					? (string) $addon_args['pue_options']['use_wp_update']
+					: false,
+			];
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				[RegisterAddonPUE::class, 'loadPueUpdate']
+			);
+		}
+		RegisterAddonPUE::$addon_api_settings = $addon_api_settings;
+		return $addon_api_settings;
+	}
 
 
-    public static function setAddonPueSlug(EE_Addon $addon, string $addon_name)
-    {
-        // setup the add-on's pue_slug if we have one.
-        if (! empty($addon_api_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug($addon_api_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
-        }
-    }
+	public static function setAddonPueSlug(EE_Addon $addon, string $addon_name)
+	{
+		// setup the add-on's pue_slug if we have one.
+		if (! empty($addon_api_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
+			$addon->setPueSlug($addon_api_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+		}
+	}
 
 
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function loadPueUpdate()
-    {
-        // PUE client existence
-        if (! is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) {
-            return;
-        }
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function loadPueUpdate()
+	{
+		// PUE client existence
+		if (! is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) {
+			return;
+		}
 
-        /** @var EE_Network_Config $network_config */
-        $network_config = LoaderFactory::getLoader()->getShared('EE_Network_Config');
-        // load PUE client
-        require_once EE_THIRD_PARTY . 'pue/pue-client.php';
-        $license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
-        // cycle thru settings
-        foreach (RegisterAddonPUE::$addon_api_settings as $settings) {
-            if (empty($settings['pue_options'])) {
-                continue;
-            }
-            // initiate the class and start the plugin update engine!
-            new PluginUpdateEngineChecker(
-            // host file URL
-                $license_server,
-                // plugin slug(s)
-                [
-                    'premium'    => ['p' => $settings['pue_options']['pue_plugin_slug']],
-                    'prerelease' => ['beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'],
-                ],
-                // options
-                [
-                    'apikey'            => $network_config->core->site_license_key,
-                    'lang_domain'       => 'event_espresso',
-                    'checkPeriod'       => $settings['pue_options']['checkPeriod'],
-                    'option_key'        => 'ee_site_license_key',
-                    'options_page_slug' => 'event_espresso',
-                    'plugin_basename'   => $settings['pue_options']['plugin_basename'],
-                    // if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
-                    'use_wp_update'     => $settings['pue_options']['use_wp_update'],
-                ]
-            );
-        }
-    }
+		/** @var EE_Network_Config $network_config */
+		$network_config = LoaderFactory::getLoader()->getShared('EE_Network_Config');
+		// load PUE client
+		require_once EE_THIRD_PARTY . 'pue/pue-client.php';
+		$license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
+		// cycle thru settings
+		foreach (RegisterAddonPUE::$addon_api_settings as $settings) {
+			if (empty($settings['pue_options'])) {
+				continue;
+			}
+			// initiate the class and start the plugin update engine!
+			new PluginUpdateEngineChecker(
+			// host file URL
+				$license_server,
+				// plugin slug(s)
+				[
+					'premium'    => ['p' => $settings['pue_options']['pue_plugin_slug']],
+					'prerelease' => ['beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'],
+				],
+				// options
+				[
+					'apikey'            => $network_config->core->site_license_key,
+					'lang_domain'       => 'event_espresso',
+					'checkPeriod'       => $settings['pue_options']['checkPeriod'],
+					'option_key'        => 'ee_site_license_key',
+					'options_page_slug' => 'event_espresso',
+					'plugin_basename'   => $settings['pue_options']['plugin_basename'],
+					// if use_wp_update is TRUE it means you want FREE versions of the plugin to be updated from WP
+					'use_wp_update'     => $settings['pue_options']['use_wp_update'],
+				]
+			);
+		}
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -24,11 +24,11 @@ 
         string $class_name,
         array $addon_args
     ): array {
-        if (! empty($addon_args['pue_options'])) {
-            $addon_api_settings[ $addon_name ]['pue_options'] = [
+        if ( ! empty($addon_args['pue_options'])) {
+            $addon_api_settings[$addon_name]['pue_options'] = [
                 'pue_plugin_slug' => isset($addon_args['pue_options']['pue_plugin_slug'])
                     ? (string) $addon_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($addon_args['pue_options']['plugin_basename'])
                     ? (string) $addon_args['pue_options']['plugin_basename']
                     : plugin_basename($addon_args['main_file_path']),
@@ -52,8 +52,8 @@ 
     public static function setAddonPueSlug(EE_Addon $addon, string $addon_name)
     {
         // setup the add-on's pue_slug if we have one.
-        if (! empty($addon_api_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug($addon_api_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+        if ( ! empty($addon_api_settings[$addon_name]['pue_options']['pue_plugin_slug'])) {
+            $addon->setPueSlug($addon_api_settings[$addon_name]['pue_options']['pue_plugin_slug']);
         }
     }
 
@@ -69,14 +69,14 @@ 
     public static function loadPueUpdate()
     {
         // PUE client existence
-        if (! is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) {
+        if ( ! is_readable(EE_THIRD_PARTY.'pue/pue-client.php')) {
             return;
         }
 
         /** @var EE_Network_Config $network_config */
         $network_config = LoaderFactory::getLoader()->getShared('EE_Network_Config');
         // load PUE client
-        require_once EE_THIRD_PARTY . 'pue/pue-client.php';
+        require_once EE_THIRD_PARTY.'pue/pue-client.php';
         $license_server = defined('PUE_UPDATES_ENDPOINT') ? PUE_UPDATES_ENDPOINT : 'https://eventespresso.com';
         // cycle thru settings
         foreach (RegisterAddonPUE::$addon_api_settings as $settings) {
@@ -90,7 +90,7 @@ 
                 // plugin slug(s)
                 [
                     'premium'    => ['p' => $settings['pue_options']['pue_plugin_slug']],
-                    'prerelease' => ['beta' => $settings['pue_options']['pue_plugin_slug'] . '-pr'],
+                    'prerelease' => ['beta' => $settings['pue_options']['pue_plugin_slug'].'-pr'],
                 ],
                 // options
                 [

caffeinated/core/domain/services/pue/StatsGatherer.php

Spacing +4 added lines, -4 removed lines

@@ -167,7 +167,7 @@ 
             ]
         );
         // remove any values that equal null.  This ensures any stats that weren't retrieved successfully are excluded.
-        return array_filter($stats, function ($value) {
+        return array_filter($stats, function($value) {
             return $value !== null;
         });
     }
@@ -273,7 +273,7 @@ 
             );
             if ($active_payment_methods) {
                 foreach ($active_payment_methods as $payment_method) {
-                    $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1;
+                    $payment_method_stats[$payment_method->name().'_active_payment_method'] = 1;
                 }
             }
         } catch (Exception $e) {
@@ -292,9 +292,9 @@ 
     {
         $activeAddons = [];
         $addOns       = EE_Registry::instance()->addons;
-        if (! empty($addOns)) {
+        if ( ! empty($addOns)) {
             foreach ($addOns as $addon) {
-                $activeAddons[] = $addon->name() . '@' . $addon->version();
+                $activeAddons[] = $addon->name().'@'.$addon->version();
             }
         }
         return implode(',', $activeAddons);

Indentation +265 added lines, -265 removed lines

@@ -15,288 +15,288 @@
 
 class StatsGatherer
 {
-    public const COUNT_ALL_EVENTS                 = 'event';
+	public const COUNT_ALL_EVENTS                 = 'event';
 
-    public const COUNT_ACTIVE_EVENTS              = 'active_event';
+	public const COUNT_ACTIVE_EVENTS              = 'active_event';
 
-    public const COUNT_DATETIMES                  = 'datetime';
+	public const COUNT_DATETIMES                  = 'datetime';
 
-    public const COUNT_TICKETS                    = 'ticket';
+	public const COUNT_TICKETS                    = 'ticket';
 
-    public const COUNT_DATETIMES_SOLD             = 'datetime_sold';
+	public const COUNT_DATETIMES_SOLD             = 'datetime_sold';
 
-    public const COUNT_TICKETS_FREE               = 'free_ticket';
+	public const COUNT_TICKETS_FREE               = 'free_ticket';
 
-    public const COUNT_TICKETS_PAID               = 'paid_ticket';
+	public const COUNT_TICKETS_PAID               = 'paid_ticket';
 
-    public const COUNT_TICKETS_SOLD               = 'ticket_sold';
+	public const COUNT_TICKETS_SOLD               = 'ticket_sold';
 
-    public const COUNT_REGISTRATIONS_APPROVED     = 'registrations_approved';
+	public const COUNT_REGISTRATIONS_APPROVED     = 'registrations_approved';
 
-    public const COUNT_REGISTRATIONS_NOT_APPROVED = 'registrations_not_approved';
+	public const COUNT_REGISTRATIONS_NOT_APPROVED = 'registrations_not_approved';
 
-    public const COUNT_REGISTRATIONS_PENDING      = 'registrations_pending';
+	public const COUNT_REGISTRATIONS_PENDING      = 'registrations_pending';
 
-    public const COUNT_REGISTRATIONS_INCOMPLETE   = 'registrations_incomplete';
+	public const COUNT_REGISTRATIONS_INCOMPLETE   = 'registrations_incomplete';
 
-    public const COUNT_REGISTRATIONS_ALL          = 'registrations_all';
+	public const COUNT_REGISTRATIONS_ALL          = 'registrations_all';
 
-    public const COUNT_REGISTRATIONS_CANCELLED    = 'registrations_cancelled';
+	public const COUNT_REGISTRATIONS_CANCELLED    = 'registrations_cancelled';
 
-    public const COUNT_REGISTRATIONS_DECLINED     = 'registrations_declined';
+	public const COUNT_REGISTRATIONS_DECLINED     = 'registrations_declined';
 
-    public const SUM_TRANSACTIONS_COMPLETE_TOTAL  = 'transactions_complete_total_sum';
+	public const SUM_TRANSACTIONS_COMPLETE_TOTAL  = 'transactions_complete_total_sum';
 
-    public const SUM_TRANSACTIONS_ALL_PAID        = 'transactions_all_paid';
+	public const SUM_TRANSACTIONS_ALL_PAID        = 'transactions_all_paid';
 
-    public const INFO_SITE_CURRENCY               = 'site_currency';
+	public const INFO_SITE_CURRENCY               = 'site_currency';
 
 
-    /**
-     * @var EEM_Payment_Method
-     */
-    private $payment_method_model;
-
-
-    /**
-     * @var EEM_Event
-     */
-    private $event_model;
-
-    /**
-     * @var EEM_Datetime
-     */
-    private $datetime_model;
-
-
-    /**
-     * @var EEM_Ticket
-     */
-    private $ticket_model;
-
-
-    /**
-     * @var EEM_Registration
-     */
-    private $registration_model;
-
-
-    /**
-     * @var EEM_Transaction
-     */
-    private $transaction_model;
-
-
-    /**
-     * @var EE_Config
-     */
-    private $config;
-
-
-    /**
-     * StatsGatherer constructor.
-     *
-     * @param EEM_Payment_Method $payment_method_model
-     * @param EEM_Event          $event_model
-     * @param EEM_Datetime       $datetime_model
-     * @param EEM_Ticket         $ticket_model
-     * @param EEM_Registration   $registration_model
-     * @param EEM_Transaction    $transaction_model
-     * @param EE_Config          $config
-     */
-    public function __construct(
-        EEM_Payment_Method $payment_method_model,
-        EEM_Event $event_model,
-        EEM_Datetime $datetime_model,
-        EEM_Ticket $ticket_model,
-        EEM_Registration $registration_model,
-        EEM_Transaction $transaction_model,
-        EE_Config $config
-    ) {
-        $this->payment_method_model = $payment_method_model;
-        $this->event_model          = $event_model;
-        $this->datetime_model       = $datetime_model;
-        $this->ticket_model         = $ticket_model;
-        $this->registration_model   = $registration_model;
-        $this->transaction_model    = $transaction_model;
-        $this->config               = $config;
-    }
-
-
-    /**
-     * Return the stats array for PUE UXIP stats.
-     *
-     * @return array
-     */
-    public function stats(): array
-    {
-        global $wp_version;
-        $stats = $this->paymentMethodStats();
-        // a-ok so let's setup our stats.
-        $stats = array_merge(
-            $stats,
-            [
-                'is_multisite'                    => is_multisite() && is_main_site(),
-                'active_theme'                    => $this->getActiveThemeStat(),
-                'ee4_all_events_count'            => $this->getCountFor(self::COUNT_ALL_EVENTS),
-                'ee4_active_events_count'         => $this->getCountFor(self::COUNT_ACTIVE_EVENTS),
-                'all_dtts_count'                  => $this->getCountFor(self::COUNT_DATETIMES),
-                'dtt_sold'                        => $this->getCountFor(self::COUNT_DATETIMES_SOLD),
-                'all_tkt_count'                   => $this->getCountFor(self::COUNT_TICKETS),
-                'free_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_FREE),
-                'paid_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_PAID),
-                'tkt_sold'                        => $this->getCountFor(self::COUNT_TICKETS_SOLD),
-                'approve_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_APPROVED),
-                'pending_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_PENDING),
-                'not_approved_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_NOT_APPROVED),
-                'incomplete_registration_count'   => $this->getCountFor(self::COUNT_REGISTRATIONS_INCOMPLETE),
-                'cancelled_registration_count'    => $this->getCountFor(self::COUNT_REGISTRATIONS_CANCELLED),
-                'declined_registration_count'     => $this->getCountFor(self::COUNT_REGISTRATIONS_DECLINED),
-                'all_registration_count'          => $this->getCountFor(self::COUNT_REGISTRATIONS_ALL),
-                'completed_transaction_total_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_COMPLETE_TOTAL),
-                'all_transaction_paid_sum'        => $this->getCountFor(self::SUM_TRANSACTIONS_ALL_PAID),
-                self::INFO_SITE_CURRENCY          => $this->config->currency instanceof EE_Currency_Config
-                    ? $this->config->currency->code
-                    : 'unknown',
-                'phpversion'                      => implode(
-                    '.',
-                    [PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION]
-                ),
-                'wpversion'                       => $wp_version,
-                'active_addons'                   => $this->getActiveAddons(),
-            ]
-        );
-        // remove any values that equal null.  This ensures any stats that weren't retrieved successfully are excluded.
-        return array_filter($stats, function ($value) {
-            return $value !== null;
-        });
-    }
-
-
-    /**
-     * @param string $which enum (@see constants prefixed with COUNT)
-     * @return int|null
-     */
-    private function getCountFor(string $which): ?int
-    {
-        try {
-            switch ($which) {
-                case self::COUNT_ALL_EVENTS:
-                    $count = $this->event_model->count();
-                    break;
-                case self::COUNT_TICKETS:
-                    $count = $this->ticket_model->count();
-                    break;
-                case self::COUNT_DATETIMES:
-                    $count = $this->datetime_model->count();
-                    break;
-                case self::COUNT_ACTIVE_EVENTS:
-                    $count = $this->event_model->get_active_events([], true);
-                    break;
-                case self::COUNT_DATETIMES_SOLD:
-                    $count = $this->datetime_model->sum([], 'DTT_sold');
-                    break;
-                case self::COUNT_TICKETS_FREE:
-                    $count = $this->ticket_model->count([['TKT_price' => 0]]);
-                    break;
-                case self::COUNT_TICKETS_PAID:
-                    $count = $this->ticket_model->count([['TKT_price' => ['>', 0]]]);
-                    break;
-                case self::COUNT_TICKETS_SOLD:
-                    $count = $this->ticket_model->sum([], 'TKT_sold');
-                    break;
-                case self::COUNT_REGISTRATIONS_ALL:
-                    $count = $this->registration_model->count();
-                    break;
-                case self::COUNT_REGISTRATIONS_CANCELLED:
-                    $count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_cancelled]]);
-                    break;
-                case self::COUNT_REGISTRATIONS_INCOMPLETE:
-                    $count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_incomplete]]);
-                    break;
-                case self::COUNT_REGISTRATIONS_NOT_APPROVED:
-                    $count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_not_approved]]);
-                    break;
-                case self::COUNT_REGISTRATIONS_DECLINED:
-                    $count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_declined]]);
-                    break;
-                case self::COUNT_REGISTRATIONS_PENDING:
-                    $count = $this->registration_model->count(
-                        [['STS_ID' => EEM_Registration::status_id_pending_payment]]
-                    );
-                    break;
-                case self::COUNT_REGISTRATIONS_APPROVED:
-                    $count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_approved]]);
-                    break;
-                case self::SUM_TRANSACTIONS_COMPLETE_TOTAL:
-                    $count = $this->transaction_model->sum(
-                        [['STS_ID' => EEM_Transaction::complete_status_code]],
-                        'TXN_total'
-                    );
-                    break;
-                case self::SUM_TRANSACTIONS_ALL_PAID:
-                    $count = $this->transaction_model->sum([], 'TXN_paid');
-                    break;
-                default:
-                    $count = null;
-                    break;
-            }
-        } catch (Exception $e) {
-            $count = null;
-        }
-        return $count;
-    }
-
-
-    /**
-     * Return the active theme.
-     *
-     * @return false|string
-     */
-    private function getActiveThemeStat()
-    {
-        $theme = wp_get_theme();
-        return $theme->get('Name');
-    }
-
-
-    /**
-     * @return array
-     */
-    private function paymentMethodStats(): array
-    {
-        $payment_method_stats = [];
-        try {
-            $active_payment_methods = $this->payment_method_model->get_all_active(
-                null,
-                ['group_by' => 'PMD_type']
-            );
-            if ($active_payment_methods) {
-                foreach ($active_payment_methods as $payment_method) {
-                    $payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1;
-                }
-            }
-        } catch (Exception $e) {
-            // do nothing just prevents fatals.
-        }
-        return $payment_method_stats;
-    }
-
-
-    /**
-     * Return a list of active EE add-ons and their versions.
-     *
-     * @return string
-     */
-    private function getActiveAddons(): string
-    {
-        $activeAddons = [];
-        $addOns       = EE_Registry::instance()->addons;
-        if (! empty($addOns)) {
-            foreach ($addOns as $addon) {
-                $activeAddons[] = $addon->name() . '@' . $addon->version();
-            }
-        }
-        return implode(',', $activeAddons);
-    }
+	/**
+	 * @var EEM_Payment_Method
+	 */
+	private $payment_method_model;
+
+
+	/**
+	 * @var EEM_Event
+	 */
+	private $event_model;
+
+	/**
+	 * @var EEM_Datetime
+	 */
+	private $datetime_model;
+
+
+	/**
+	 * @var EEM_Ticket
+	 */
+	private $ticket_model;
+
+
+	/**
+	 * @var EEM_Registration
+	 */
+	private $registration_model;
+
+
+	/**
+	 * @var EEM_Transaction
+	 */
+	private $transaction_model;
+
+
+	/**
+	 * @var EE_Config
+	 */
+	private $config;
+
+
+	/**
+	 * StatsGatherer constructor.
+	 *
+	 * @param EEM_Payment_Method $payment_method_model
+	 * @param EEM_Event          $event_model
+	 * @param EEM_Datetime       $datetime_model
+	 * @param EEM_Ticket         $ticket_model
+	 * @param EEM_Registration   $registration_model
+	 * @param EEM_Transaction    $transaction_model
+	 * @param EE_Config          $config
+	 */
+	public function __construct(
+		EEM_Payment_Method $payment_method_model,
+		EEM_Event $event_model,
+		EEM_Datetime $datetime_model,
+		EEM_Ticket $ticket_model,
+		EEM_Registration $registration_model,
+		EEM_Transaction $transaction_model,
+		EE_Config $config
+	) {
+		$this->payment_method_model = $payment_method_model;
+		$this->event_model          = $event_model;
+		$this->datetime_model       = $datetime_model;
+		$this->ticket_model         = $ticket_model;
+		$this->registration_model   = $registration_model;
+		$this->transaction_model    = $transaction_model;
+		$this->config               = $config;
+	}
+
+
+	/**
+	 * Return the stats array for PUE UXIP stats.
+	 *
+	 * @return array
+	 */
+	public function stats(): array
+	{
+		global $wp_version;
+		$stats = $this->paymentMethodStats();
+		// a-ok so let's setup our stats.
+		$stats = array_merge(
+			$stats,
+			[
+				'is_multisite'                    => is_multisite() && is_main_site(),
+				'active_theme'                    => $this->getActiveThemeStat(),
+				'ee4_all_events_count'            => $this->getCountFor(self::COUNT_ALL_EVENTS),
+				'ee4_active_events_count'         => $this->getCountFor(self::COUNT_ACTIVE_EVENTS),
+				'all_dtts_count'                  => $this->getCountFor(self::COUNT_DATETIMES),
+				'dtt_sold'                        => $this->getCountFor(self::COUNT_DATETIMES_SOLD),
+				'all_tkt_count'                   => $this->getCountFor(self::COUNT_TICKETS),
+				'free_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_FREE),
+				'paid_tkt_count'                  => $this->getCountFor(self::COUNT_TICKETS_PAID),
+				'tkt_sold'                        => $this->getCountFor(self::COUNT_TICKETS_SOLD),
+				'approve_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_APPROVED),
+				'pending_registration_count'      => $this->getCountFor(self::COUNT_REGISTRATIONS_PENDING),
+				'not_approved_registration_count' => $this->getCountFor(self::COUNT_REGISTRATIONS_NOT_APPROVED),
+				'incomplete_registration_count'   => $this->getCountFor(self::COUNT_REGISTRATIONS_INCOMPLETE),
+				'cancelled_registration_count'    => $this->getCountFor(self::COUNT_REGISTRATIONS_CANCELLED),
+				'declined_registration_count'     => $this->getCountFor(self::COUNT_REGISTRATIONS_DECLINED),
+				'all_registration_count'          => $this->getCountFor(self::COUNT_REGISTRATIONS_ALL),
+				'completed_transaction_total_sum' => $this->getCountFor(self::SUM_TRANSACTIONS_COMPLETE_TOTAL),
+				'all_transaction_paid_sum'        => $this->getCountFor(self::SUM_TRANSACTIONS_ALL_PAID),
+				self::INFO_SITE_CURRENCY          => $this->config->currency instanceof EE_Currency_Config
+					? $this->config->currency->code
+					: 'unknown',
+				'phpversion'                      => implode(
+					'.',
+					[PHP_MAJOR_VERSION, PHP_MINOR_VERSION, PHP_RELEASE_VERSION]
+				),
+				'wpversion'                       => $wp_version,
+				'active_addons'                   => $this->getActiveAddons(),
+			]
+		);
+		// remove any values that equal null.  This ensures any stats that weren't retrieved successfully are excluded.
+		return array_filter($stats, function ($value) {
+			return $value !== null;
+		});
+	}
+
+
+	/**
+	 * @param string $which enum (@see constants prefixed with COUNT)
+	 * @return int|null
+	 */
+	private function getCountFor(string $which): ?int
+	{
+		try {
+			switch ($which) {
+				case self::COUNT_ALL_EVENTS:
+					$count = $this->event_model->count();
+					break;
+				case self::COUNT_TICKETS:
+					$count = $this->ticket_model->count();
+					break;
+				case self::COUNT_DATETIMES:
+					$count = $this->datetime_model->count();
+					break;
+				case self::COUNT_ACTIVE_EVENTS:
+					$count = $this->event_model->get_active_events([], true);
+					break;
+				case self::COUNT_DATETIMES_SOLD:
+					$count = $this->datetime_model->sum([], 'DTT_sold');
+					break;
+				case self::COUNT_TICKETS_FREE:
+					$count = $this->ticket_model->count([['TKT_price' => 0]]);
+					break;
+				case self::COUNT_TICKETS_PAID:
+					$count = $this->ticket_model->count([['TKT_price' => ['>', 0]]]);
+					break;
+				case self::COUNT_TICKETS_SOLD:
+					$count = $this->ticket_model->sum([], 'TKT_sold');
+					break;
+				case self::COUNT_REGISTRATIONS_ALL:
+					$count = $this->registration_model->count();
+					break;
+				case self::COUNT_REGISTRATIONS_CANCELLED:
+					$count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_cancelled]]);
+					break;
+				case self::COUNT_REGISTRATIONS_INCOMPLETE:
+					$count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_incomplete]]);
+					break;
+				case self::COUNT_REGISTRATIONS_NOT_APPROVED:
+					$count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_not_approved]]);
+					break;
+				case self::COUNT_REGISTRATIONS_DECLINED:
+					$count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_declined]]);
+					break;
+				case self::COUNT_REGISTRATIONS_PENDING:
+					$count = $this->registration_model->count(
+						[['STS_ID' => EEM_Registration::status_id_pending_payment]]
+					);
+					break;
+				case self::COUNT_REGISTRATIONS_APPROVED:
+					$count = $this->registration_model->count([['STS_ID' => EEM_Registration::status_id_approved]]);
+					break;
+				case self::SUM_TRANSACTIONS_COMPLETE_TOTAL:
+					$count = $this->transaction_model->sum(
+						[['STS_ID' => EEM_Transaction::complete_status_code]],
+						'TXN_total'
+					);
+					break;
+				case self::SUM_TRANSACTIONS_ALL_PAID:
+					$count = $this->transaction_model->sum([], 'TXN_paid');
+					break;
+				default:
+					$count = null;
+					break;
+			}
+		} catch (Exception $e) {
+			$count = null;
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Return the active theme.
+	 *
+	 * @return false|string
+	 */
+	private function getActiveThemeStat()
+	{
+		$theme = wp_get_theme();
+		return $theme->get('Name');
+	}
+
+
+	/**
+	 * @return array
+	 */
+	private function paymentMethodStats(): array
+	{
+		$payment_method_stats = [];
+		try {
+			$active_payment_methods = $this->payment_method_model->get_all_active(
+				null,
+				['group_by' => 'PMD_type']
+			);
+			if ($active_payment_methods) {
+				foreach ($active_payment_methods as $payment_method) {
+					$payment_method_stats[ $payment_method->name() . '_active_payment_method' ] = 1;
+				}
+			}
+		} catch (Exception $e) {
+			// do nothing just prevents fatals.
+		}
+		return $payment_method_stats;
+	}
+
+
+	/**
+	 * Return a list of active EE add-ons and their versions.
+	 *
+	 * @return string
+	 */
+	private function getActiveAddons(): string
+	{
+		$activeAddons = [];
+		$addOns       = EE_Registry::instance()->addons;
+		if (! empty($addOns)) {
+			foreach ($addOns as $addon) {
+				$activeAddons[] = $addon->name() . '@' . $addon->version();
+			}
+		}
+		return implode(',', $activeAddons);
+	}
 }

caffeinated/core/domain/services/pue/PueLicensingManager.php

Indentation +88 added lines, -88 removed lines

@@ -11,104 +11,104 @@
 
 class PueLicensingManager
 {
-    /**
-     * @var EE_Dependency_Map
-     */
-    protected $dependency_map;
+	/**
+	 * @var EE_Dependency_Map
+	 */
+	protected $dependency_map;
 
-    /**
-     * @var LoaderInterface
-     */
-    protected $loader;
+	/**
+	 * @var LoaderInterface
+	 */
+	protected $loader;
 
 
-    /**
-     * @param EE_Dependency_Map $dependency_map
-     * @param LoaderInterface   $loader
-     */
-    public function __construct(EE_Dependency_Map $dependency_map, LoaderInterface $loader)
-    {
-        $this->dependency_map = $dependency_map;
-        $this->loader         = $loader;
-    }
+	/**
+	 * @param EE_Dependency_Map $dependency_map
+	 * @param LoaderInterface   $loader
+	 */
+	public function __construct(EE_Dependency_Map $dependency_map, LoaderInterface $loader)
+	{
+		$this->dependency_map = $dependency_map;
+		$this->loader         = $loader;
+	}
 
 
-    public function registerDependencies()
-    {
-        $pue_dependencies = [
-            'EventEspresso\caffeinated\core\services\licensing\LicenseService'     => [
-                'EventEspresso\caffeinated\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\caffeinated\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\core\domain\services\pue\Stats'             => [
-                'EventEspresso\caffeinated\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
-                'EE_Maintenance_Mode'                                              => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\caffeinated\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\core\domain\services\pue\Config'            => [
-                'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
-                'EE_Config'         => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\core\domain\services\pue\StatsGatherer'     => [
-                'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
-                'EEM_Event'          => EE_Dependency_Map::load_from_cache,
-                'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
-                'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
-                'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
-                'EE_Config'          => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\caffeinated\core\services\licensing\UserExperienceForm' => [
-                'EE_Core_Config'         => EE_Dependency_Map::load_from_cache,
-                'EE_Network_Core_Config' => EE_Dependency_Map::load_from_cache,
-            ],
-        ];
-        foreach ($pue_dependencies as $class => $dependencies) {
-            $this->dependency_map->registerDependencies($class, $dependencies);
-        }
-    }
+	public function registerDependencies()
+	{
+		$pue_dependencies = [
+			'EventEspresso\caffeinated\core\services\licensing\LicenseService'     => [
+				'EventEspresso\caffeinated\core\domain\services\pue\Stats'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\caffeinated\core\domain\services\pue\Config' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\core\domain\services\pue\Stats'             => [
+				'EventEspresso\caffeinated\core\domain\services\pue\Config'        => EE_Dependency_Map::load_from_cache,
+				'EE_Maintenance_Mode'                                              => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\caffeinated\core\domain\services\pue\StatsGatherer' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\core\domain\services\pue\Config'            => [
+				'EE_Network_Config' => EE_Dependency_Map::load_from_cache,
+				'EE_Config'         => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\core\domain\services\pue\StatsGatherer'     => [
+				'EEM_Payment_Method' => EE_Dependency_Map::load_from_cache,
+				'EEM_Event'          => EE_Dependency_Map::load_from_cache,
+				'EEM_Datetime'       => EE_Dependency_Map::load_from_cache,
+				'EEM_Ticket'         => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration'   => EE_Dependency_Map::load_from_cache,
+				'EEM_Transaction'    => EE_Dependency_Map::load_from_cache,
+				'EE_Config'          => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\caffeinated\core\services\licensing\UserExperienceForm' => [
+				'EE_Core_Config'         => EE_Dependency_Map::load_from_cache,
+				'EE_Network_Core_Config' => EE_Dependency_Map::load_from_cache,
+			],
+		];
+		foreach ($pue_dependencies as $class => $dependencies) {
+			$this->dependency_map->registerDependencies($class, $dependencies);
+		}
+	}
 
 
-    public function registerHooks()
-    {
-        add_filter(
-            'FHEE__EE_Register_Addon__register',
-            [RegisterAddonPUE::class, 'registerPUE'],
-            10,
-            4
-        );
-        add_action(
-            'AHEE__EE_Register_Addon___load_and_init_addon_class',
-            [RegisterAddonPUE::class, 'setAddonPueSlug'],
-            10,
-            2
-        );
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            add_action('AHEE__EE_System__brew_espresso__complete', [$this, 'loadLicenseService']);
-        }
-        add_filter(
-            'FHEE__EventEspresso_admin_pages_general_settings_OrganizationSettings__generate__form',
-            [$this, 'loadUserExperienceForm']
-        );
+	public function registerHooks()
+	{
+		add_filter(
+			'FHEE__EE_Register_Addon__register',
+			[RegisterAddonPUE::class, 'registerPUE'],
+			10,
+			4
+		);
+		add_action(
+			'AHEE__EE_Register_Addon___load_and_init_addon_class',
+			[RegisterAddonPUE::class, 'setAddonPueSlug'],
+			10,
+			2
+		);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			add_action('AHEE__EE_System__brew_espresso__complete', [$this, 'loadLicenseService']);
+		}
+		add_filter(
+			'FHEE__EventEspresso_admin_pages_general_settings_OrganizationSettings__generate__form',
+			[$this, 'loadUserExperienceForm']
+		);
 
-    }
+	}
 
 
-    public function loadLicenseService()
-    {
-        /** @var LicenseService $license_service */
-        $license_service = $this->loader->getShared(LicenseService::class );
-        $license_service->loadPueClient();
-    }
+	public function loadLicenseService()
+	{
+		/** @var LicenseService $license_service */
+		$license_service = $this->loader->getShared(LicenseService::class );
+		$license_service->loadPueClient();
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function loadUserExperienceForm(EE_Form_Section_Proper $org_settings_form): EE_Form_Section_Proper
-    {
-        /** @var UserExperienceForm $uxip_form */
-        $uxip_form = $this->loader->getShared(UserExperienceForm::class);
-        return $uxip_form->uxipFormSections($org_settings_form);
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	public function loadUserExperienceForm(EE_Form_Section_Proper $org_settings_form): EE_Form_Section_Proper
+	{
+		/** @var UserExperienceForm $uxip_form */
+		$uxip_form = $this->loader->getShared(UserExperienceForm::class);
+		return $uxip_form->uxipFormSections($org_settings_form);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
     public function loadLicenseService()
     {
         /** @var LicenseService $license_service */
-        $license_service = $this->loader->getShared(LicenseService::class );
+        $license_service = $this->loader->getShared(LicenseService::class);
         $license_service->loadPueClient();
     }
 

core/admin/EE_Admin_List_Table.core.php

Indentation +884 added lines, -884 removed lines

@@ -3,7 +3,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';
 }
 
 
@@ -21,897 +21,897 @@ 
  */
 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 $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 $_data;
-
-
-    /**
-     * This holds the value of all the data available for the given view (for all pages).
-     *
-     * @var int $_all_data_count
-     */
-    protected $_all_data_count;
-
-
-    /**
-     * Will contain the count of trashed items for the view label.
-     *
-     * @var int $_trashed_count
-     */
-    protected $_trashed_count;
-
-
-    /**
-     * This is what will be referenced as the slug for the current screen
-     *
-     * @var string $_screen
-     */
-    protected $_screen;
-
-
-    /**
-     * this is the EE_Admin_Page object
-     *
-     * @var EE_Admin_Page $_admin_page
-     */
-    protected $_admin_page;
-
-
-    /**
-     * The current view
-     *
-     * @var string $_view
-     */
-    protected $_view;
-
-
-    /**
-     * array of possible views for this table
-     *
-     * @var array $_views
-     */
-    protected $_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 $_wp_list_args;
-
-    /**
-     * an array of column names
-     * array(
-     *    'internal-name' => 'Title'
-     * )
-     *
-     * @var array $_columns
-     */
-    protected $_columns;
-
-    /**
-     * An array of sortable columns
-     * array(
-     *    'internal-name' => 'orderby' //or
-     *    'internal-name' => array( 'orderby', true )
-     * )
-     *
-     * @var array $_sortable_columns
-     */
-    protected $_sortable_columns;
-
-    /**
-     * callback method used to perform AJAX row reordering
-     *
-     * @var string $_ajax_sorting_callback
-     */
-    protected $_ajax_sorting_callback;
-
-    /**
-     * An array of hidden columns (if needed)
-     * array('internal-name', 'internal-name')
-     *
-     * @var array $_hidden_columns
-     */
-    protected $_hidden_columns;
-
-    /**
-     * holds the per_page value
-     *
-     * @var int $_per_page
-     */
-    protected $_per_page;
-
-    /**
-     * holds what page number is currently being viewed
-     *
-     * @var int $_current_page
-     */
-    protected $_current_page;
-
-    /**
-     * the reference string for the nonce_action
-     *
-     * @var string $_nonce_action_ref
-     */
-    protected $_nonce_action_ref;
-
-    /**
-     * property to hold incoming request data (as set by the admin_page_core)
-     *
-     * @var array $_req_data
-     */
-    protected $_req_data;
-
-
-    /**
-     * yes / no array for admin form fields
-     *
-     * @var array $_yes_no
-     */
-    protected $_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 $_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 $_primary_column = '';
-
-
-    /**
-     * Used to indicate whether the table has a checkbox column or not.
-     *
-     * @type bool $_has_checkbox_column
-     */
-    protected $_has_checkbox_column = false;
-
-
-    /**
-     * @param EE_Admin_Page $admin_page we use this for obtaining everything we need in the list table
-     */
-    public function __construct(EE_Admin_Page $admin_page)
-    {
-        $this->_admin_page   = $admin_page;
-        $this->_req_data     = $this->_admin_page->get_request_data();
-        $this->_view         = $this->_admin_page->get_view();
-        $this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
-        $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->_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);
-
-        $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()
-    {
-        $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 $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 $_data;
+
+
+	/**
+	 * This holds the value of all the data available for the given view (for all pages).
+	 *
+	 * @var int $_all_data_count
+	 */
+	protected $_all_data_count;
+
+
+	/**
+	 * Will contain the count of trashed items for the view label.
+	 *
+	 * @var int $_trashed_count
+	 */
+	protected $_trashed_count;
+
+
+	/**
+	 * This is what will be referenced as the slug for the current screen
+	 *
+	 * @var string $_screen
+	 */
+	protected $_screen;
+
+
+	/**
+	 * this is the EE_Admin_Page object
+	 *
+	 * @var EE_Admin_Page $_admin_page
+	 */
+	protected $_admin_page;
+
+
+	/**
+	 * The current view
+	 *
+	 * @var string $_view
+	 */
+	protected $_view;
+
+
+	/**
+	 * array of possible views for this table
+	 *
+	 * @var array $_views
+	 */
+	protected $_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 $_wp_list_args;
+
+	/**
+	 * an array of column names
+	 * array(
+	 *    'internal-name' => 'Title'
+	 * )
+	 *
+	 * @var array $_columns
+	 */
+	protected $_columns;
+
+	/**
+	 * An array of sortable columns
+	 * array(
+	 *    'internal-name' => 'orderby' //or
+	 *    'internal-name' => array( 'orderby', true )
+	 * )
+	 *
+	 * @var array $_sortable_columns
+	 */
+	protected $_sortable_columns;
+
+	/**
+	 * callback method used to perform AJAX row reordering
+	 *
+	 * @var string $_ajax_sorting_callback
+	 */
+	protected $_ajax_sorting_callback;
+
+	/**
+	 * An array of hidden columns (if needed)
+	 * array('internal-name', 'internal-name')
+	 *
+	 * @var array $_hidden_columns
+	 */
+	protected $_hidden_columns;
+
+	/**
+	 * holds the per_page value
+	 *
+	 * @var int $_per_page
+	 */
+	protected $_per_page;
+
+	/**
+	 * holds what page number is currently being viewed
+	 *
+	 * @var int $_current_page
+	 */
+	protected $_current_page;
+
+	/**
+	 * the reference string for the nonce_action
+	 *
+	 * @var string $_nonce_action_ref
+	 */
+	protected $_nonce_action_ref;
+
+	/**
+	 * property to hold incoming request data (as set by the admin_page_core)
+	 *
+	 * @var array $_req_data
+	 */
+	protected $_req_data;
+
+
+	/**
+	 * yes / no array for admin form fields
+	 *
+	 * @var array $_yes_no
+	 */
+	protected $_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 $_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 $_primary_column = '';
+
+
+	/**
+	 * Used to indicate whether the table has a checkbox column or not.
+	 *
+	 * @type bool $_has_checkbox_column
+	 */
+	protected $_has_checkbox_column = false;
+
+
+	/**
+	 * @param EE_Admin_Page $admin_page we use this for obtaining everything we need in the list table
+	 */
+	public function __construct(EE_Admin_Page $admin_page)
+	{
+		$this->_admin_page   = $admin_page;
+		$this->_req_data     = $this->_admin_page->get_request_data();
+		$this->_view         = $this->_admin_page->get_view();
+		$this->_views        = empty($this->_views) ? $this->_admin_page->get_list_table_view_RLs() : $this->_views;
+		$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->_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);
+
+		$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()
+	{
+		$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()
-    {
-        $classname = get_class($this);
-        $filters   = apply_filters(
-            "FHEE__{$classname}__filters",
-            (array) $this->_get_table_filters(),
-            $this,
-            $this->_screen
-        );
-
-        if (empty($filters)) {
-            return;
-        }
-        $use_filters = isset($this->_req_data['use_filters'])
-                       && filter_var($this->_req_data['use_filters'], FILTER_VALIDATE_BOOLEAN)
-            ? 'yes'
-            : 'no';
-
-        echo '<div class="ee-list-table-filters actions alignleft">';
-        foreach ($filters as $filter) {
-            echo wp_kses($filter, AllowedTags::getWithFormTags());
-        }
-        // add filter button at end
-        echo '<input type="submit" class="ee-list-table-filter-submit button button--secondary" value="'
-             . esc_html__('Filter', 'event_espresso')
-             . '" id="post-query-submit" />';
-        echo '<input type="hidden" id="ee-list-table-use-filters" name="use_filters" value="' . $use_filters . '"/>';
-
-        // add reset filters button at end
-        echo '<a class="button button--secondary"  href="'
-             . esc_url_raw($this->_admin_page->get_current_page_view_url())
-             . '" style="display:inline-block">'
-             . esc_html__('Reset Filters', 'event_espresso')
-             . '</a>';
-        echo '</div>';
-    }
-
-
-    /**
-     * 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
-        );
-        return ob_get_clean();
-    }
-
-
-    /**
-     * 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);
-    }
-
-
-    /**
-     * 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         = isset($action['route']) ? $action['route'] : '';
-                $extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
-                // already escaped
-                echo wp_kses($this->_admin_page->get_action_link_or_button(
-                    $route,
-                    $type,
-                    $extra_request,
-                    'button button--secondary'
-                ), 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}"));
-    }
+	}
+
+
+	/**
+	 * _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()
+	{
+		$classname = get_class($this);
+		$filters   = apply_filters(
+			"FHEE__{$classname}__filters",
+			(array) $this->_get_table_filters(),
+			$this,
+			$this->_screen
+		);
+
+		if (empty($filters)) {
+			return;
+		}
+		$use_filters = isset($this->_req_data['use_filters'])
+					   && filter_var($this->_req_data['use_filters'], FILTER_VALIDATE_BOOLEAN)
+			? 'yes'
+			: 'no';
+
+		echo '<div class="ee-list-table-filters actions alignleft">';
+		foreach ($filters as $filter) {
+			echo wp_kses($filter, AllowedTags::getWithFormTags());
+		}
+		// add filter button at end
+		echo '<input type="submit" class="ee-list-table-filter-submit button button--secondary" value="'
+			 . esc_html__('Filter', 'event_espresso')
+			 . '" id="post-query-submit" />';
+		echo '<input type="hidden" id="ee-list-table-use-filters" name="use_filters" value="' . $use_filters . '"/>';
+
+		// add reset filters button at end
+		echo '<a class="button button--secondary"  href="'
+			 . esc_url_raw($this->_admin_page->get_current_page_view_url())
+			 . '" style="display:inline-block">'
+			 . esc_html__('Reset Filters', 'event_espresso')
+			 . '</a>';
+		echo '</div>';
+	}
+
+
+	/**
+	 * 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
+		);
+		return ob_get_clean();
+	}
+
+
+	/**
+	 * 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);
+	}
+
+
+	/**
+	 * 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         = isset($action['route']) ? $action['route'] : '';
+				$extra_request = isset($action['extra_request']) ? $action['extra_request'] : '';
+				// already escaped
+				echo wp_kses($this->_admin_page->get_action_link_or_button(
+					$route,
+					$type,
+					$extra_request,
+					'button button--secondary'
+				), 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}"));
+	}
 }

core/EE_Deprecated.core.php

Indentation +1222 added lines, -1222 removed lines

@@ -39,31 +39,31 @@ 
  * @param string $action_or_filter
  */
 function deprecated_espresso_action_or_filter_doing_it_wrong(
-    $deprecated_filter,
-    $replacement,
-    $replacement_location,
-    $version_deprecated,
-    $version_applies,
-    $action_or_filter = 'action'
+	$deprecated_filter,
+	$replacement,
+	$replacement_location,
+	$version_deprecated,
+	$version_applies,
+	$action_or_filter = 'action'
 ) {
-    $action_or_filter = $action_or_filter === 'action'
-        ? esc_html__('action', 'event_espresso')
-        : esc_html__('filter', 'event_espresso');
-    EE_Error::doing_it_wrong(
-        $deprecated_filter,
-        sprintf(
-            esc_html__(
-                'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
-                'event_espresso'
-            ),
-            $action_or_filter,
-            $replacement,
-            $replacement_location,
-            '<br />'
-        ),
-        $version_deprecated,
-        $version_applies
-    );
+	$action_or_filter = $action_or_filter === 'action'
+		? esc_html__('action', 'event_espresso')
+		: esc_html__('filter', 'event_espresso');
+	EE_Error::doing_it_wrong(
+		$deprecated_filter,
+		sprintf(
+			esc_html__(
+				'This %1$s is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new %1$s: %4$s"%2$s" found in "%3$s"',
+				'event_espresso'
+			),
+			$action_or_filter,
+			$replacement,
+			$replacement_location,
+			'<br />'
+		),
+		$version_deprecated,
+		$version_applies
+	);
 }
 
 /**
@@ -75,90 +75,90 @@ 
  */
 function ee_deprecated__registration_checkout__button_text($submit_button_text, EE_Checkout $checkout)
 {
-    // list of old filters
-    $deprecated_filters = array(
-        'update_registration_details' => true,
-        'process_payment'             => true,
-        'finalize_registration'       => true,
-        'and_proceed_to_payment'      => true,
-        'proceed_to'                  => true,
-    );
-    // loop thru and call doing_it_wrong() or remove any that aren't being used
-    foreach ($deprecated_filters as $deprecated_filter => $on) {
-        // was this filter called ?
-        if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
-            // only display doing_it_wrong() notice to Event Admins during non-AJAX requests
-            if (EE_Registry::instance()->CAP->current_user_can(
-                    'ee_read_ee',
-                    'hide_doing_it_wrong_for_deprecated_SPCO_filter'
-                ) && ! defined('DOING_AJAX')) {
-                EE_Error::doing_it_wrong(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                    sprintf(
-                        esc_html__(
-                            'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
-                            'event_espresso'
-                        ),
-                        'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
-                        '<br />',
-                        'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-                        '/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
-                    ),
-                    '4.6.10'
-                );
-            }
-        } else {
-            unset($deprecated_filters[ $deprecated_filter ]);
-        }
-    }
-    if (! empty($deprecated_filters)) {
-
-        if ($checkout->current_step->slug(
-            ) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
-                $submit_button_text
-            );
-        } elseif ($checkout->current_step->slug(
-            ) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
-                $submit_button_text
-            );
-        } elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
-            ) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
-            $submit_button_text = apply_filters(
-                'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
-                $submit_button_text
-            );
-        }
-        if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
-            if ($checkout->payment_required() && $checkout->next_step->slug(
-                ) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
-                $submit_button_text .= apply_filters(
-                    'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
-                    $submit_button_text
-                );
-            }
-            if ($checkout->next_step->slug(
-                ) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
-                $submit_button_text = apply_filters(
-                                          'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
-                                          $submit_button_text
-                                      ) . $checkout->next_step->name();
-            }
-        }
-
-    }
-    return $submit_button_text;
+	// list of old filters
+	$deprecated_filters = array(
+		'update_registration_details' => true,
+		'process_payment'             => true,
+		'finalize_registration'       => true,
+		'and_proceed_to_payment'      => true,
+		'proceed_to'                  => true,
+	);
+	// loop thru and call doing_it_wrong() or remove any that aren't being used
+	foreach ($deprecated_filters as $deprecated_filter => $on) {
+		// was this filter called ?
+		if (has_action('FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter)) {
+			// only display doing_it_wrong() notice to Event Admins during non-AJAX requests
+			if (EE_Registry::instance()->CAP->current_user_can(
+					'ee_read_ee',
+					'hide_doing_it_wrong_for_deprecated_SPCO_filter'
+				) && ! defined('DOING_AJAX')) {
+				EE_Error::doing_it_wrong(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+					sprintf(
+						esc_html__(
+							'The %1$s filter is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new filter: %2$s"%3$s" found in "%4$s"',
+							'event_espresso'
+						),
+						'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__' . $deprecated_filter,
+						'<br />',
+						'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+						'/modules/single_page_checkout/inc/EE_SPCO_Reg_Step.class.php'
+					),
+					'4.6.10'
+				);
+			}
+		} else {
+			unset($deprecated_filters[ $deprecated_filter ]);
+		}
+	}
+	if (! empty($deprecated_filters)) {
+
+		if ($checkout->current_step->slug(
+			) == 'attendee_information' && $checkout->revisit && isset($deprecated_filters['update_registration_details'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__update_registration_details',
+				$submit_button_text
+			);
+		} elseif ($checkout->current_step->slug(
+			) == 'payment_options' && $checkout->revisit && isset($deprecated_filters['process_payment'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__process_payment',
+				$submit_button_text
+			);
+		} elseif ($checkout->next_step instanceof EE_SPCO_Reg_Step && $checkout->next_step->slug(
+			) == 'finalize_registration' && isset($deprecated_filters['finalize_registration'])) {
+			$submit_button_text = apply_filters(
+				'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__finalize_registration',
+				$submit_button_text
+			);
+		}
+		if ($checkout->next_step instanceof EE_SPCO_Reg_Step) {
+			if ($checkout->payment_required() && $checkout->next_step->slug(
+				) == 'payment_options' && isset($deprecated_filters['and_proceed_to_payment'])) {
+				$submit_button_text .= apply_filters(
+					'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__and_proceed_to_payment',
+					$submit_button_text
+				);
+			}
+			if ($checkout->next_step->slug(
+				) != 'finalize_registration' && ! $checkout->revisit && isset($deprecated_filters['proceed_to'])) {
+				$submit_button_text = apply_filters(
+										  'FHEE__EED_Single_Page_Checkout__registration_checkout__button_text__proceed_to',
+										  $submit_button_text
+									  ) . $checkout->next_step->name();
+			}
+		}
+
+	}
+	return $submit_button_text;
 
 }
 
 add_filter(
-    'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
-    'ee_deprecated__registration_checkout__button_text',
-    10,
-    2
+	'FHEE__EE_SPCO_Reg_Step__set_submit_button_text___submit_button_text',
+	'ee_deprecated__registration_checkout__button_text',
+	10,
+	2
 );
 
 
@@ -170,54 +170,54 @@ 
  */
 function ee_deprecated_finalize_transaction(EE_Checkout $checkout, $status_updates)
 {
-    $action_ref = null;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
-        ? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
-    $action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
-        ? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
-    if ($action_ref) {
-
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                esc_html__(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Transaction_Processor.class.php',
-                'AHEE__EE_Transaction_Processor__finalize',
-                'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
-                'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
-            ),
-            '4.6.0'
-        );
-        switch ($action_ref) {
-            case 'AHEE__EE_Transaction__finalize__new_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    $checkout->admin_request
-                );
-                break;
-            case 'AHEE__EE_Transaction__finalize__all_transaction' :
-                do_action(
-                    'AHEE__EE_Transaction__finalize__new_transaction',
-                    $checkout->transaction,
-                    array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
-                    $checkout->admin_request
-                );
-                break;
-        }
-    }
+	$action_ref = null;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__new_transaction')
+		? 'AHEE__EE_Transaction__finalize__new_transaction' : $action_ref;
+	$action_ref = has_action('AHEE__EE_Transaction__finalize__all_transaction')
+		? 'AHEE__EE_Transaction__finalize__all_transaction' : $action_ref;
+	if ($action_ref) {
+
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				esc_html__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use one of the following new actions: %1$s"%3$s" found in "%2$s" %1$s"%4$s" found in "%2$s" %1$s"%5$s" found in "%2$s" %1$s"%6$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Transaction_Processor.class.php',
+				'AHEE__EE_Transaction_Processor__finalize',
+				'AHEE__EE_Transaction_Processor__manually_update_registration_statuses',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_for_default_approved_events',
+				'AHEE__EE_Transaction_Processor__toggle_registration_statuses_if_no_monies_owing'
+			),
+			'4.6.0'
+		);
+		switch ($action_ref) {
+			case 'AHEE__EE_Transaction__finalize__new_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					$checkout->admin_request
+				);
+				break;
+			case 'AHEE__EE_Transaction__finalize__all_transaction' :
+				do_action(
+					'AHEE__EE_Transaction__finalize__new_transaction',
+					$checkout->transaction,
+					array('new_reg' => ! $checkout->revisit, 'to_approved' => $status_updates),
+					$checkout->admin_request
+				);
+				break;
+		}
+	}
 }
 
 add_action(
-    'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
-    'ee_deprecated_finalize_transaction',
-    10,
-    2
+	'AHEE__EE_SPCO_Reg_Step_Finalize_Registration__process_reg_step__completed',
+	'ee_deprecated_finalize_transaction',
+	10,
+	2
 );
 /**
  * ee_deprecated_finalize_registration
@@ -226,35 +226,35 @@ 
  */
 function ee_deprecated_finalize_registration(EE_Registration $registration)
 {
-    $action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
-        ? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
-    if ($action_ref) {
-        EE_Error::doing_it_wrong(
-            $action_ref,
-            sprintf(
-                esc_html__(
-                    'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
-                    'event_espresso'
-                ),
-                '<br />',
-                '/core/business/EE_Registration_Processor.class.php',
-                'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
-            ),
-            '4.6.0'
-        );
-        do_action(
-            'AHEE__EE_Registration__finalize__update_and_new_reg',
-            $registration,
-            (is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
-        );
-    }
+	$action_ref = has_action('AHEE__EE_Registration__finalize__update_and_new_reg')
+		? 'AHEE__EE_Registration__finalize__update_and_new_reg' : null;
+	if ($action_ref) {
+		EE_Error::doing_it_wrong(
+			$action_ref,
+			sprintf(
+				esc_html__(
+					'This action is deprecated.  It *may* work as an attempt to build in backwards compatibility.  However, it is recommended to use the following new action: %1$s"%3$s" found in "%2$s"',
+					'event_espresso'
+				),
+				'<br />',
+				'/core/business/EE_Registration_Processor.class.php',
+				'AHEE__EE_Registration_Processor__trigger_registration_update_notifications'
+			),
+			'4.6.0'
+		);
+		do_action(
+			'AHEE__EE_Registration__finalize__update_and_new_reg',
+			$registration,
+			(is_admin() && ! (defined('DOING_AJAX') && DOING_AJAX))
+		);
+	}
 }
 
 add_action(
-    'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
-    'ee_deprecated_finalize_registration',
-    10,
-    1
+	'AHEE__EE_Registration_Processor__trigger_registration_update_notifications',
+	'ee_deprecated_finalize_registration',
+	10,
+	1
 );
 
 
@@ -264,44 +264,44 @@ 
  */
 function ee_deprecated_hooks()
 {
-    /**
-     * @var          $hooks       array where keys are hook names, and their values are array{
-     * @type string  $version     when deprecated
-     * @type string  $alternative saying what to use instead
-     * @type boolean $still_works whether or not the hook still works
-     *        }
-     */
-    $hooks = array(
-        'AHEE__EE_System___do_setup_validations' => array(
-            'version'     => '4.6.0',
-            'alternative' => esc_html__(
-                'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
-                'event_espresso'
-            ),
-            'still_works' => false,
-        ),
-    );
-    foreach ($hooks as $name => $deprecation_info) {
-        if (has_action($name)) {
-            EE_Error::doing_it_wrong(
-                $name,
-                sprintf(
-                    esc_html__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
-                    $deprecation_info['still_works'] ? esc_html__(
-                        'It *may* work as an attempt to build in backwards compatibility.',
-                        'event_espresso'
-                    ) : esc_html__('It has been completely removed.', 'event_espresso'),
-                    isset($deprecation_info['alternative'])
-                        ? $deprecation_info['alternative']
-                        : esc_html__(
-                        'Please read the current EE4 documentation further or contact Support.',
-                        'event_espresso'
-                    )
-                ),
-                isset($deprecation_info['version']) ? $deprecation_info['version'] : esc_html__('recently', 'event_espresso')
-            );
-        }
-    }
+	/**
+	 * @var          $hooks       array where keys are hook names, and their values are array{
+	 * @type string  $version     when deprecated
+	 * @type string  $alternative saying what to use instead
+	 * @type boolean $still_works whether or not the hook still works
+	 *        }
+	 */
+	$hooks = array(
+		'AHEE__EE_System___do_setup_validations' => array(
+			'version'     => '4.6.0',
+			'alternative' => esc_html__(
+				'Instead use "AHEE__EEH_Activation__validate_messages_system" which is called after validating messages (done on every new install, upgrade, reactivation, and downgrade)',
+				'event_espresso'
+			),
+			'still_works' => false,
+		),
+	);
+	foreach ($hooks as $name => $deprecation_info) {
+		if (has_action($name)) {
+			EE_Error::doing_it_wrong(
+				$name,
+				sprintf(
+					esc_html__('This filter is deprecated. %1$s%2$s', 'event_espresso'),
+					$deprecation_info['still_works'] ? esc_html__(
+						'It *may* work as an attempt to build in backwards compatibility.',
+						'event_espresso'
+					) : esc_html__('It has been completely removed.', 'event_espresso'),
+					isset($deprecation_info['alternative'])
+						? $deprecation_info['alternative']
+						: esc_html__(
+						'Please read the current EE4 documentation further or contact Support.',
+						'event_espresso'
+					)
+				),
+				isset($deprecation_info['version']) ? $deprecation_info['version'] : esc_html__('recently', 'event_espresso')
+			);
+		}
+	}
 }
 
 add_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons', 'ee_deprecated_hooks');
@@ -316,34 +316,34 @@ 
  */
 function ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
 {
-    $in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
-              || has_action(
-                  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
-              );
-    if ($in_use) {
-        $msg = esc_html__(
-            'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
-            . 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
-            . 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
-            . 'to add other actions after a form submission has been received.',
-            'event_espresso'
-        );
-        EE_Error::doing_it_wrong(
-            __CLASS__ . '::' . __FUNCTION__,
-            $msg,
-            '4.8.32.rc.000'
-        );
-        // it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
-        if (is_admin() && ! defined('DOING_AJAX')) {
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-    return $in_use;
+	$in_use = has_filter('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns')
+			  || has_action(
+				  'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save'
+			  );
+	if ($in_use) {
+		$msg = esc_html__(
+			'We detected you are using the filter FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns or AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save.'
+			. 'Both of these have been deprecated and should not be used anymore. You should instead use FHEE__EE_Form_Section_Proper___construct__options_array to customize the contents of the form,'
+			. 'use FHEE__EE_Form_Section_Proper__receive_form_submission__req_data to customize the submission data, or AHEE__EE_Form_Section_Proper__receive_form_submission__end '
+			. 'to add other actions after a form submission has been received.',
+			'event_espresso'
+		);
+		EE_Error::doing_it_wrong(
+			__CLASS__ . '::' . __FUNCTION__,
+			$msg,
+			'4.8.32.rc.000'
+		);
+		// it seems the doing_it_wrong messages get output during some hidden html tags, so add an error to make sure this gets noticed
+		if (is_admin() && ! defined('DOING_AJAX')) {
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+	return $in_use;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
-    'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
+	'AHEE__Registrations_Admin_Page___registration_details_metabox__start',
+	'ee_deprecated_using_old_registration_admin_custom_questions_form_hooks'
 );
 
 /**
@@ -355,82 +355,82 @@ 
  */
 function ee_deprecated_update_attendee_registration_form_old($admin_page)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return;
-    }
-    $req_data = $admin_page->get_request_data();
-    $qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
-    $REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
-    $qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
-    if (! $REG_ID || ! $qstns) {
-        EE_Error::add_error(
-            esc_html__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-    }
-    $success = true;
-
-    // allow others to get in on this awesome fun   :D
-    do_action(
-        'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
-        $REG_ID,
-        $qstns
-    );
-    // loop thru questions... FINALLY!!!
-
-    foreach ($qstns as $QST_ID => $qstn) {
-        // if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
-        if (! is_array($qstn)) {
-            $set_values = [
-                'QST_ID'    => $QST_ID,
-                'REG_ID'    => $REG_ID,
-                'ANS_value' => $qstn,
-            ];
-            $success    = EEM_Answer::instance()->insert($set_values);
-            continue;
-        }
-
-
-        foreach ($qstn as $ANS_ID => $ANS_value) {
-            // get answer
-            $query_params = array(
-                0 => array(
-                    'ANS_ID' => $ANS_ID,
-                    'REG_ID' => $REG_ID,
-                    'QST_ID' => $QST_ID,
-                ),
-            );
-            $answer = EEM_Answer::instance()->get_one($query_params);
-            // this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
-            if (! $answer instanceof EE_Answer) {
-                $set_values = array(
-                    'QST_ID'    => $QST_ID,
-                    'REG_ID'    => $REG_ID,
-                    'ANS_value' => $qstn,
-                );
-                $success = EEM_Answer::instance()->insert($set_values);
-                continue 2;
-            }
-
-            $answer->set('ANS_value', $ANS_value);
-            $success = $answer->save();
-        }
-    }
-    $what = esc_html__('Registration Form', 'event_espresso');
-    $route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
-    $admin_page->redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
-    exit;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return;
+	}
+	$req_data = $admin_page->get_request_data();
+	$qstns = isset($req_data['qstn']) ? $req_data['qstn'] : false;
+	$REG_ID = isset($req_data['_REG_ID']) ? absint($req_data['_REG_ID']) : false;
+	$qstns = apply_filters('FHEE__Registrations_Admin_Page___update_attendee_registration_form__qstns', $qstns);
+	if (! $REG_ID || ! $qstns) {
+		EE_Error::add_error(
+			esc_html__('An error occurred. No registration ID and/or registration questions were received.', 'event_espresso'),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+	}
+	$success = true;
+
+	// allow others to get in on this awesome fun   :D
+	do_action(
+		'AHEE__Registrations_Admin_Page___save_attendee_registration_form__after_reg_and_attendee_save',
+		$REG_ID,
+		$qstns
+	);
+	// loop thru questions... FINALLY!!!
+
+	foreach ($qstns as $QST_ID => $qstn) {
+		// if $qstn isn't an array then it doesn't already have an answer, so let's create the answer
+		if (! is_array($qstn)) {
+			$set_values = [
+				'QST_ID'    => $QST_ID,
+				'REG_ID'    => $REG_ID,
+				'ANS_value' => $qstn,
+			];
+			$success    = EEM_Answer::instance()->insert($set_values);
+			continue;
+		}
+
+
+		foreach ($qstn as $ANS_ID => $ANS_value) {
+			// get answer
+			$query_params = array(
+				0 => array(
+					'ANS_ID' => $ANS_ID,
+					'REG_ID' => $REG_ID,
+					'QST_ID' => $QST_ID,
+				),
+			);
+			$answer = EEM_Answer::instance()->get_one($query_params);
+			// this MAY be an array but NOT have an answer because its multi select.  If so then we need to create the answer
+			if (! $answer instanceof EE_Answer) {
+				$set_values = array(
+					'QST_ID'    => $QST_ID,
+					'REG_ID'    => $REG_ID,
+					'ANS_value' => $qstn,
+				);
+				$success = EEM_Answer::instance()->insert($set_values);
+				continue 2;
+			}
+
+			$answer->set('ANS_value', $ANS_value);
+			$success = $answer->save();
+		}
+	}
+	$what = esc_html__('Registration Form', 'event_espresso');
+	$route = $REG_ID ? array('action' => 'view_registration', '_REG_ID' => $REG_ID) : array('action' => 'default');
+	$admin_page->redirect_after_action($success, $what, esc_html__('updated', 'event_espresso'), $route);
+	exit;
 }
 
 add_action(
-    'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
-    'ee_deprecated_update_attendee_registration_form_old',
-    10,
-    1
+	'AHEE__Registrations_Admin_Page___update_attendee_registration_form__start',
+	'ee_deprecated_update_attendee_registration_form_old',
+	10,
+	1
 );
 /**
  * Render the registration admin page's custom questions area in the old fashion
@@ -446,50 +446,50 @@ 
  */
 function ee_deprecated_reg_questions_meta_box_old($do_default_action, $admin_page, $registration)
 {
-    // check if the old hooks are in use. If not, do the default
-    if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
-        || ! $admin_page instanceof EE_Admin_Page) {
-        return $do_default_action;
-    }
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
-        array($admin_page, 'form_before_question_group'),
-        10,
-        1
-    );
-    add_filter(
-        'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
-        array($admin_page, 'form_after_question_group'),
-        10,
-        1
-    );
-    add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
-    add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
-
-    $question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
-        $registration,
-        $registration->get(
-            'EVT_ID'
-        )
-    );
-
-    EE_Registry::instance()->load_helper('Form_Fields');
-    $template_args = array(
-        'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
-        'reg_questions_form_action' => 'edit_registration',
-        'REG_ID'                    => $registration->ID(),
-    );
-    $template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
-    echo EEH_Template::display_template($template_path, $template_args, true);
-    // indicate that we should not do the default admin page code
-    return false;
+	// check if the old hooks are in use. If not, do the default
+	if (! ee_deprecated_using_old_registration_admin_custom_questions_form_hooks()
+		|| ! $admin_page instanceof EE_Admin_Page) {
+		return $do_default_action;
+	}
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__before_question_group_questions',
+		array($admin_page, 'form_before_question_group'),
+		10,
+		1
+	);
+	add_filter(
+		'FHEE__EEH_Form_Fields__generate_question_groups_html__after_question_group_questions',
+		array($admin_page, 'form_after_question_group'),
+		10,
+		1
+	);
+	add_filter('FHEE__EEH_Form_Fields__label_html', array($admin_page, 'form_form_field_label_wrap'), 10, 1);
+	add_filter('FHEE__EEH_Form_Fields__input_html', array($admin_page, 'form_form_field_input__wrap'), 10, 1);
+
+	$question_groups = EEM_Event::instance()->assemble_array_of_groups_questions_and_options(
+		$registration,
+		$registration->get(
+			'EVT_ID'
+		)
+	);
+
+	EE_Registry::instance()->load_helper('Form_Fields');
+	$template_args = array(
+		'att_questions'             => EEH_Form_Fields::generate_question_groups_html($question_groups),
+		'reg_questions_form_action' => 'edit_registration',
+		'REG_ID'                    => $registration->ID(),
+	);
+	$template_path = REG_TEMPLATE_PATH . 'reg_admin_details_main_meta_box_reg_questions.template.php';
+	echo EEH_Template::display_template($template_path, $template_args, true);
+	// indicate that we should not do the default admin page code
+	return false;
 }
 
 add_action(
-    'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
-    'ee_deprecated_reg_questions_meta_box_old',
-    10,
-    3
+	'FHEE__Registrations_Admin_Page___reg_questions_meta_box__do_default',
+	'ee_deprecated_reg_questions_meta_box_old',
+	10,
+	3
 );
 
 
@@ -506,42 +506,42 @@ 
 class EE_Message_Template_Defaults extends EE_Base
 {
 
-    /**
-     * EE_Message_Template_Defaults constructor.
-     *
-     * @param EE_messages $messages
-     * @param             $messenger_name
-     * @param             $message_type_name
-     * @param int         $GRP_ID
-     * @return EE_Messages_Template_Defaults
-     */
-    public function __construct(
-        EE_messages $messages,
-        $messenger_name,
-        $message_type_name,
-        $GRP_ID = 0
-    ) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
-                'event_espresso'
-            ),
-            '4.9.0'
-        );
-        /** @var EE_Message_Resource_Manager $message_resource_manager */
-        $message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $messenger = $message_resource_manager->get_messenger($messenger_name);
-        $message_type = $message_resource_manager->get_message_type($message_type_name);
-        return EE_Registry::instance()->load_lib(
-            'Messages_Template_Defaults',
-            array(
-                $messenger,
-                $message_type,
-                $GRP_ID,
-            )
-        );
-    }
+	/**
+	 * EE_Message_Template_Defaults constructor.
+	 *
+	 * @param EE_messages $messages
+	 * @param             $messenger_name
+	 * @param             $message_type_name
+	 * @param int         $GRP_ID
+	 * @return EE_Messages_Template_Defaults
+	 */
+	public function __construct(
+		EE_messages $messages,
+		$messenger_name,
+		$message_type_name,
+		$GRP_ID = 0
+	) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'The class EE_Message_Template_Defaults has been deprecated and replaced by EE_Messages_Template_Defaults.',
+				'event_espresso'
+			),
+			'4.9.0'
+		);
+		/** @var EE_Message_Resource_Manager $message_resource_manager */
+		$message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$messenger = $message_resource_manager->get_messenger($messenger_name);
+		$message_type = $message_resource_manager->get_message_type($message_type_name);
+		return EE_Registry::instance()->load_lib(
+			'Messages_Template_Defaults',
+			array(
+				$messenger,
+				$message_type,
+				$GRP_ID,
+			)
+		);
+	}
 }
 
 
@@ -559,525 +559,525 @@ 
 class EE_messages
 {
 
-    /** @type EE_messenger[] */
-    protected $_active_messengers = array();
-
-    /** @type array */
-    protected $_active_message_types = array();
-
-    /** @type EE_message_type[] */
-    protected $_installed_message_types = array();
-
-    /** @type EE_messenger */
-    protected $_messenger;
-
-    /** @type EE_message_type */
-    protected $_message_type;
-
-    /** @type array */
-    protected $_contexts = array();
-
-    /** @type EE_Message_Resource_Manager $_message_resource_manager */
-    protected $_message_resource_manager;
-
-
-    /**
-     * EE_messages constructor.
-     *
-     * @deprecated 4.9.0
-     */
-    public function __construct()
-    {
-    }
-
-
-    /**
-     * @param string $method
-     */
-    public function _class_is_deprecated($method)
-    {
-        EE_Error::doing_it_wrong(
-            'EE_messages::' . $method,
-            esc_html__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
-            '4.9.0',
-            '4.10.0.p'
-        );
-        // Please use EE_Message_Resource_Manager instead
-        $this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
-     */
-    public function ensure_messenger_is_active($messenger_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $message_type message type name
-     * @param        $messenger
-     * @return bool true if it got activated (or was active) and false if not.
-     * @throws \EE_Error
-     */
-    public function ensure_message_type_is_active($message_type, $messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger_name
-     * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
-     *                                             If included we do NOT setup the default message types (assuming they
-     *                                             are already setup.)
-     * @return boolean an array of generated templates or false if nothing generated/activated.
-     */
-    public function activate_messenger($messenger_name, $mts_to_activate = array())
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_messenger    $messenger    messenger used in trigger
-     * @param EE_message_type $message_type message type used in trigger
-     *
-     * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
-     */
-    public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger
-     * @return EE_messenger | null
-     */
-    public function get_messenger_if_active($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param EE_Message $message
-     * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
-     *                  available.
-     *                  Eg. Valid Messenger and Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => new EE_Registration_Approved_message_type()
-     *                  )
-     *                  Valid Messenger and Invalid Message Type:
-     *                  array(
-     *                  'messenger' => new EE_Email_messenger(),
-     *                  'message_type' => null
-     *                  )
-     */
-    public function validate_for_use(EE_Message $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return array(
-            'messenger'    => $message->messenger_object(),
-            'message_type' => $message->message_type_object(),
-        );
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type                 What type of message are we sending (corresponds to message types)
-     * @param  mixed  $vars                 Data being sent for parsing in the message
-     * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
-     *                                      Otherwise we cycle through all active messengers.
-     * @param string  $generating_messenger if included then this messenger is used for generating the message
-     *                                      templates (but not for sending).
-     * @param string  $context              If included then only a message type for a specific context will be
-     *                                      generated.
-     * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
-     *                                      EE_messages objects which might be used by the trigger to setup a batch
-     *                                      message (typically html messenger uses it).
-     * @return bool
-     */
-    public function send_message(
-        $type,
-        $vars,
-        $sending_messenger = '',
-        $generating_messenger = '',
-        $context = '',
-        $send = true
-    ) {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        /** @type EE_Messages_Processor $processor */
-        $processor = EE_Registry::instance()->load_lib('Messages_Processor');
-        $error = false;
-        // try to intelligently determine what method we'll call based on the incoming data.
-        // if generating and sending are different then generate and send immediately.
-        if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
-            // in the legacy system, when generating and sending were different, that means all the
-            // vars are already in the request object.  So let's just use that.
-            try {
-                /** @type EE_Message_To_Generate_From_Request $mtg */
-                $mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
-                $processor->generate_and_send_now($mtg);
-            } catch (EE_Error $e) {
-                $error_msg = esc_html__(
-                    'Please note that a system message failed to send due to a technical issue.',
-                    'event_espresso'
-                );
-                // add specific message for developers if WP_DEBUG in on
-                $error_msg .= '||' . $e->getMessage();
-                EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
-                $error = true;
-            }
-        } else {
-            $processor->generate_for_all_active_messengers($type, $vars, $send);
-            // let's find out if there were any errors and how many successfully were queued.
-            $count_errors = $processor->get_queue()->count_STS_in_queue(
-                array(EEM_Message::status_failed, EEM_Message::status_debug_only)
-            );
-            $count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
-            $count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
-            $count_errors = $count_errors + $count_retry;
-            if ($count_errors > 0) {
-                $error = true;
-                if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            'There were %d errors and %d messages successfully queued for generation and sending',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors > 1 && $count_queued === 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            'There were %d errors and %d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } elseif ($count_errors === 1 && $count_queued > 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            'There was %d error and %d messages successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors,
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        esc_html__(
-                            'There was %d message that failed to be queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_errors
-                    );
-                }
-                EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                if ($count_queued === 1) {
-                    $message = sprintf(
-                        esc_html__(
-                            '%d message successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                } else {
-                    $message = sprintf(
-                        esc_html__(
-                            '%d messages were successfully queued for generation.',
-                            'event_espresso'
-                        ),
-                        $count_queued
-                    );
-                }
-                EE_Error::add_success($message);
-            }
-        }
-        // if no error then return the generated message(s).
-        if (! $error && ! $send) {
-            $generated_queue = $processor->generate_queue(false);
-            // get message and return.
-            $generated_queue->get_message_repository()->rewind();
-            $messages = array();
-            while ($generated_queue->get_message_repository()->valid()) {
-                $message = $generated_queue->get_message_repository()->current();
-                if ($message instanceof EE_Message) {
-                    // set properties that might be expected by add-ons (backward compat)
-                    $message->content = $message->content();
-                    $message->template_pack = $message->get_template_pack();
-                    $message->template_variation = $message->get_template_pack_variation();
-                    $messages[] = $message;
-                }
-                $generated_queue->get_message_repository()->next();
-            }
-            return $messages;
-        }
-        return $error ? false
-            : true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $type      This should correspond with a valid message type
-     * @param  string $context   This should correspond with a valid context for the message type
-     * @param  string $messenger This should correspond with a valid messenger.
-     * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
-     *                           preview
-     * @return string          The body of the message.
-     */
-    public function preview_message($type, $context, $messenger, $send = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return EED_Messages::preview_message($type, $context, $messenger, $send);
-    }
-
-
-    /**
-     * @since      4.5.0
-     * @deprecated 4.9.0   Moved to EED_Messages Module
-     * @param string   $messenger    a string matching a valid active messenger in the system
-     * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
-     *                               required to send along the message type to the messenger because this is used for
-     *                               determining what specific variations might be loaded for the generated message.
-     * @param stdClass $message      a stdClass object in the format expected by the messenger.
-     *
-     * @return bool          success or fail.
-     */
-    public function send_message_with_messenger_only($messenger, $message_type, $message)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        // setup for sending to new method.
-        /** @type EE_Messages_Queue $queue */
-        $queue = EE_Registry::instance()->load_lib('Messages_Queue');
-        // make sure we have a proper message object
-        if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
-            $msg = EE_Message_Factory::create(
-                array(
-                    'MSG_messenger'    => $messenger,
-                    'MSG_message_type' => $message_type,
-                    'MSG_content'      => $message->content,
-                    'MSG_subject'      => $message->subject,
-                )
-            );
-        } else {
-            $msg = $message;
-        }
-        if (! $msg instanceof EE_Message) {
-            return false;
-        }
-        // make sure any content in a content property (if not empty) is set on the MSG_content.
-        if (! empty($msg->content)) {
-            $msg->set('MSG_content', $msg->content);
-        }
-        $queue->add($msg);
-        return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param         $messenger
-     * @param  string $message_type message type that the templates are being created for
-     * @param int     $GRP_ID
-     * @param bool    $is_global
-     * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
-     *                      returned.
-     * @throws \EE_Error
-     */
-    public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param  string $messenger_name    name of EE_messenger
-     * @param  string $message_type_name name of EE_message_type
-     * @return array
-     */
-    public function get_fields($messenger_name, $message_type_name)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        EE_Registry::instance()->load_helper('MSG_Template');
-        return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @access     public
-     * @param string $type                we can indicate just returning installed message types
-     *                                    or messengers (or both) via this parameter.
-     * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
-     * @return array                    multidimensional array of messenger and message_type objects
-     *                                    (messengers index, and message_type index);
-     */
-    public function get_installed($type = 'all', $skip_cache = false)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        if ($skip_cache) {
-            $this->_message_resource_manager->reset_active_messengers_and_message_types();
-        }
-        switch ($type) {
-            case 'messengers' :
-                return array(
-                    'messenger' => $this->_message_resource_manager->installed_messengers(),
-                );
-                break;
-            case 'message_types' :
-                return array(
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-            case 'all' :
-            default :
-                return array(
-                    'messenger'    => $this->_message_resource_manager->installed_messengers(),
-                    'message_type' => $this->_message_resource_manager->installed_message_types(),
-                );
-                break;
-        }
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return \EE_messenger[]
-     */
-    public function get_active_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->active_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array array of message_type references (string)
-     */
-    public function get_active_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->list_of_active_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return EE_message_type[]
-     */
-    public function get_active_message_type_objects()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_objects();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @since      4.5.0
-     * @param string $messenger The messenger being checked
-     * @return EE_message_type[]    (or empty array if none present)
-     */
-    public function get_active_message_types_per_messenger($messenger)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param string $messenger    The string should correspond to the messenger (message types are
-     * @param string $message_type The string should correspond to a message type.
-     * @return EE_message_type|null
-     */
-    public function get_active_message_type($messenger, $message_type)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array|\EE_message_type[]
-     */
-    public function get_installed_message_types()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_message_types();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @return array
-     */
-    public function get_installed_messengers()
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->installed_messengers();
-    }
-
-
-    /**
-     * @deprecated 4.9.0
-     * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
-     *                           message type.
-     * @return array
-     */
-    public function get_all_contexts($slugs_only = true)
-    {
-        // EE_messages has been deprecated
-        $this->_class_is_deprecated(__FUNCTION__);
-        return $this->_message_resource_manager->get_all_contexts($slugs_only);
-    }
+	/** @type EE_messenger[] */
+	protected $_active_messengers = array();
+
+	/** @type array */
+	protected $_active_message_types = array();
+
+	/** @type EE_message_type[] */
+	protected $_installed_message_types = array();
+
+	/** @type EE_messenger */
+	protected $_messenger;
+
+	/** @type EE_message_type */
+	protected $_message_type;
+
+	/** @type array */
+	protected $_contexts = array();
+
+	/** @type EE_Message_Resource_Manager $_message_resource_manager */
+	protected $_message_resource_manager;
+
+
+	/**
+	 * EE_messages constructor.
+	 *
+	 * @deprecated 4.9.0
+	 */
+	public function __construct()
+	{
+	}
+
+
+	/**
+	 * @param string $method
+	 */
+	public function _class_is_deprecated($method)
+	{
+		EE_Error::doing_it_wrong(
+			'EE_messages::' . $method,
+			esc_html__('EE_messages has been deprecated.  Please use EE_Message_Resource_Manager instead.'),
+			'4.9.0',
+			'4.10.0.p'
+		);
+		// Please use EE_Message_Resource_Manager instead
+		$this->_message_resource_manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @return boolean TRUE if it was PREVIOUSLY active, and FALSE if it was previously inactive
+	 */
+	public function ensure_messenger_is_active($messenger_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_messenger_is_active($messenger_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $message_type message type name
+	 * @param        $messenger
+	 * @return bool true if it got activated (or was active) and false if not.
+	 * @throws \EE_Error
+	 */
+	public function ensure_message_type_is_active($message_type, $messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->ensure_message_type_is_active($message_type, $messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger_name
+	 * @param array  $mts_to_activate             (optional) An array of message types to activate with this messenger.
+	 *                                             If included we do NOT setup the default message types (assuming they
+	 *                                             are already setup.)
+	 * @return boolean an array of generated templates or false if nothing generated/activated.
+	 */
+	public function activate_messenger($messenger_name, $mts_to_activate = array())
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->activate_messenger($messenger_name, $mts_to_activate);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_messenger    $messenger    messenger used in trigger
+	 * @param EE_message_type $message_type message type used in trigger
+	 *
+	 * @return bool true is a generating messenger and can be sent OR FALSE meaning cannot send.
+	 */
+	public function is_generating_messenger_and_active(EE_messenger $messenger, EE_message_type $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->is_generating_messenger_and_active($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger
+	 * @return EE_messenger | null
+	 */
+	public function get_messenger_if_active($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param EE_Message $message
+	 * @return array  An array with 'messenger' and 'message_type' as the index and the corresponding valid object if
+	 *                  available.
+	 *                  Eg. Valid Messenger and Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => new EE_Registration_Approved_message_type()
+	 *                  )
+	 *                  Valid Messenger and Invalid Message Type:
+	 *                  array(
+	 *                  'messenger' => new EE_Email_messenger(),
+	 *                  'message_type' => null
+	 *                  )
+	 */
+	public function validate_for_use(EE_Message $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return array(
+			'messenger'    => $message->messenger_object(),
+			'message_type' => $message->message_type_object(),
+		);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type                 What type of message are we sending (corresponds to message types)
+	 * @param  mixed  $vars                 Data being sent for parsing in the message
+	 * @param  string $sending_messenger    if included then we ONLY use the specified messenger for delivery.
+	 *                                      Otherwise we cycle through all active messengers.
+	 * @param string  $generating_messenger if included then this messenger is used for generating the message
+	 *                                      templates (but not for sending).
+	 * @param string  $context              If included then only a message type for a specific context will be
+	 *                                      generated.
+	 * @param bool    $send                 Default TRUE.  If false, then this will just return the generated
+	 *                                      EE_messages objects which might be used by the trigger to setup a batch
+	 *                                      message (typically html messenger uses it).
+	 * @return bool
+	 */
+	public function send_message(
+		$type,
+		$vars,
+		$sending_messenger = '',
+		$generating_messenger = '',
+		$context = '',
+		$send = true
+	) {
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		/** @type EE_Messages_Processor $processor */
+		$processor = EE_Registry::instance()->load_lib('Messages_Processor');
+		$error = false;
+		// try to intelligently determine what method we'll call based on the incoming data.
+		// if generating and sending are different then generate and send immediately.
+		if (! empty($sending_messenger) && $sending_messenger != $generating_messenger && $send) {
+			// in the legacy system, when generating and sending were different, that means all the
+			// vars are already in the request object.  So let's just use that.
+			try {
+				/** @type EE_Message_To_Generate_From_Request $mtg */
+				$mtg = EE_Registry::instance()->load_lib('Message_To_Generate_From_Request');
+				$processor->generate_and_send_now($mtg);
+			} catch (EE_Error $e) {
+				$error_msg = esc_html__(
+					'Please note that a system message failed to send due to a technical issue.',
+					'event_espresso'
+				);
+				// add specific message for developers if WP_DEBUG in on
+				$error_msg .= '||' . $e->getMessage();
+				EE_Error::add_error($error_msg, __FILE__, __FUNCTION__, __LINE__);
+				$error = true;
+			}
+		} else {
+			$processor->generate_for_all_active_messengers($type, $vars, $send);
+			// let's find out if there were any errors and how many successfully were queued.
+			$count_errors = $processor->get_queue()->count_STS_in_queue(
+				array(EEM_Message::status_failed, EEM_Message::status_debug_only)
+			);
+			$count_queued = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_incomplete);
+			$count_retry = $processor->get_queue()->count_STS_in_queue(EEM_Message::status_retry);
+			$count_errors = $count_errors + $count_retry;
+			if ($count_errors > 0) {
+				$error = true;
+				if ($count_errors > 1 && $count_retry > 1 && $count_queued > 1) {
+					$message = sprintf(
+						esc_html__(
+							'There were %d errors and %d messages successfully queued for generation and sending',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors > 1 && $count_queued === 1) {
+					$message = sprintf(
+						esc_html__(
+							'There were %d errors and %d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} elseif ($count_errors === 1 && $count_queued > 1) {
+					$message = sprintf(
+						esc_html__(
+							'There was %d error and %d messages successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_errors,
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						esc_html__(
+							'There was %d message that failed to be queued for generation.',
+							'event_espresso'
+						),
+						$count_errors
+					);
+				}
+				EE_Error::add_error($message, __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				if ($count_queued === 1) {
+					$message = sprintf(
+						esc_html__(
+							'%d message successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				} else {
+					$message = sprintf(
+						esc_html__(
+							'%d messages were successfully queued for generation.',
+							'event_espresso'
+						),
+						$count_queued
+					);
+				}
+				EE_Error::add_success($message);
+			}
+		}
+		// if no error then return the generated message(s).
+		if (! $error && ! $send) {
+			$generated_queue = $processor->generate_queue(false);
+			// get message and return.
+			$generated_queue->get_message_repository()->rewind();
+			$messages = array();
+			while ($generated_queue->get_message_repository()->valid()) {
+				$message = $generated_queue->get_message_repository()->current();
+				if ($message instanceof EE_Message) {
+					// set properties that might be expected by add-ons (backward compat)
+					$message->content = $message->content();
+					$message->template_pack = $message->get_template_pack();
+					$message->template_variation = $message->get_template_pack_variation();
+					$messages[] = $message;
+				}
+				$generated_queue->get_message_repository()->next();
+			}
+			return $messages;
+		}
+		return $error ? false
+			: true; // yeah backwards eh?  Really what we're returning is if there is a total success for all the messages or not.  We'll modify this once we get message recording in place.
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $type      This should correspond with a valid message type
+	 * @param  string $context   This should correspond with a valid context for the message type
+	 * @param  string $messenger This should correspond with a valid messenger.
+	 * @param bool    $send      true we will do a test send using the messenger delivery, false we just do a regular
+	 *                           preview
+	 * @return string          The body of the message.
+	 */
+	public function preview_message($type, $context, $messenger, $send = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return EED_Messages::preview_message($type, $context, $messenger, $send);
+	}
+
+
+	/**
+	 * @since      4.5.0
+	 * @deprecated 4.9.0   Moved to EED_Messages Module
+	 * @param string   $messenger    a string matching a valid active messenger in the system
+	 * @param string   $message_type Although it seems contrary to the name of the method, a message type name is still
+	 *                               required to send along the message type to the messenger because this is used for
+	 *                               determining what specific variations might be loaded for the generated message.
+	 * @param stdClass $message      a stdClass object in the format expected by the messenger.
+	 *
+	 * @return bool          success or fail.
+	 */
+	public function send_message_with_messenger_only($messenger, $message_type, $message)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		// setup for sending to new method.
+		/** @type EE_Messages_Queue $queue */
+		$queue = EE_Registry::instance()->load_lib('Messages_Queue');
+		// make sure we have a proper message object
+		if (! $message instanceof EE_Message && is_object($message) && isset($message->content)) {
+			$msg = EE_Message_Factory::create(
+				array(
+					'MSG_messenger'    => $messenger,
+					'MSG_message_type' => $message_type,
+					'MSG_content'      => $message->content,
+					'MSG_subject'      => $message->subject,
+				)
+			);
+		} else {
+			$msg = $message;
+		}
+		if (! $msg instanceof EE_Message) {
+			return false;
+		}
+		// make sure any content in a content property (if not empty) is set on the MSG_content.
+		if (! empty($msg->content)) {
+			$msg->set('MSG_content', $msg->content);
+		}
+		$queue->add($msg);
+		return EED_Messages::send_message_with_messenger_only($messenger, $message_type, $queue);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param         $messenger
+	 * @param  string $message_type message type that the templates are being created for
+	 * @param int     $GRP_ID
+	 * @param bool    $is_global
+	 * @return array|object if creation is successful then we return an array of info, otherwise an error_object is
+	 *                      returned.
+	 * @throws \EE_Error
+	 */
+	public function create_new_templates($messenger, $message_type, $GRP_ID = 0, $is_global = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::create_new_templates($messenger, $message_type, $GRP_ID, $is_global);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param  string $messenger_name    name of EE_messenger
+	 * @param  string $message_type_name name of EE_message_type
+	 * @return array
+	 */
+	public function get_fields($messenger_name, $message_type_name)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		EE_Registry::instance()->load_helper('MSG_Template');
+		return EEH_MSG_Template::get_fields($messenger_name, $message_type_name);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @access     public
+	 * @param string $type                we can indicate just returning installed message types
+	 *                                    or messengers (or both) via this parameter.
+	 * @param bool   $skip_cache          if true then we skip the cache and retrieve via files.
+	 * @return array                    multidimensional array of messenger and message_type objects
+	 *                                    (messengers index, and message_type index);
+	 */
+	public function get_installed($type = 'all', $skip_cache = false)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		if ($skip_cache) {
+			$this->_message_resource_manager->reset_active_messengers_and_message_types();
+		}
+		switch ($type) {
+			case 'messengers' :
+				return array(
+					'messenger' => $this->_message_resource_manager->installed_messengers(),
+				);
+				break;
+			case 'message_types' :
+				return array(
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+			case 'all' :
+			default :
+				return array(
+					'messenger'    => $this->_message_resource_manager->installed_messengers(),
+					'message_type' => $this->_message_resource_manager->installed_message_types(),
+				);
+				break;
+		}
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return \EE_messenger[]
+	 */
+	public function get_active_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->active_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array array of message_type references (string)
+	 */
+	public function get_active_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->list_of_active_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return EE_message_type[]
+	 */
+	public function get_active_message_type_objects()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_objects();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @since      4.5.0
+	 * @param string $messenger The messenger being checked
+	 * @return EE_message_type[]    (or empty array if none present)
+	 */
+	public function get_active_message_types_per_messenger($messenger)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_types_for_messenger($messenger);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param string $messenger    The string should correspond to the messenger (message types are
+	 * @param string $message_type The string should correspond to a message type.
+	 * @return EE_message_type|null
+	 */
+	public function get_active_message_type($messenger, $message_type)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_active_message_type_for_messenger($messenger, $message_type);
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array|\EE_message_type[]
+	 */
+	public function get_installed_message_types()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_message_types();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @return array
+	 */
+	public function get_installed_messengers()
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->installed_messengers();
+	}
+
+
+	/**
+	 * @deprecated 4.9.0
+	 * @param   bool $slugs_only Whether to return an array of just slugs and labels (true) or all contexts indexed by
+	 *                           message type.
+	 * @return array
+	 */
+	public function get_all_contexts($slugs_only = true)
+	{
+		// EE_messages has been deprecated
+		$this->_class_is_deprecated(__FUNCTION__);
+		return $this->_message_resource_manager->get_all_contexts($slugs_only);
+	}
 
 
 }
@@ -1136,88 +1136,88 @@ 
 
 
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-    function ($event_list_iframe_css) {
-        if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
-            return $event_list_iframe_css;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EventsArchiveIframe__event_list_iframe__css',
-            $event_list_iframe_css
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+	function ($event_list_iframe_css) {
+		if (! has_filter('FHEE__EventsArchiveIframe__event_list_iframe__css')) {
+			return $event_list_iframe_css;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EventsArchiveIframe__event_list_iframe__css',
+			$event_list_iframe_css
+		);
+	}
 );
 add_filter(
-    'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-    function ($event_list_iframe_js) {
-        if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
-            return $event_list_iframe_js;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            '\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
-            '4.9.14',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            $event_list_iframe_js
-        );
-    }
+	'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+	function ($event_list_iframe_js) {
+		if (! has_filter('FHEE__EED_Ticket_Selector__ticket_selector_iframe__js')) {
+			return $event_list_iframe_js;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			'\EventEspresso\modules\events_archive\EventsArchiveIframe::display()',
+			'4.9.14',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			$event_list_iframe_js
+		);
+	}
 );
 add_action(
-    'AHEE__EE_Capabilities__addCaps__complete',
-    function ($capabilities_map) {
-        if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
-            return;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            'AHEE__EE_Capabilities__addCaps__complete',
-            '\EE_Capabilities::addCaps()',
-            '4.9.42',
-            '5.0.0'
-        );
-        do_action(
-            'AHEE__EE_Capabilities__init_role_caps__complete',
-            $capabilities_map
-        );
-    }
+	'AHEE__EE_Capabilities__addCaps__complete',
+	function ($capabilities_map) {
+		if (! has_action('AHEE__EE_Capabilities__init_role_caps__complete')) {
+			return;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			'AHEE__EE_Capabilities__addCaps__complete',
+			'\EE_Capabilities::addCaps()',
+			'4.9.42',
+			'5.0.0'
+		);
+		do_action(
+			'AHEE__EE_Capabilities__init_role_caps__complete',
+			$capabilities_map
+		);
+	}
 );
 
 add_filter(
-    'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-    function($existing_attendee, $registration, $attendee_data) {
-        if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
-            return $existing_attendee;
-        }
-        deprecated_espresso_action_or_filter_doing_it_wrong(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
-            '\EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
-            '4.9.34',
-            '5.0.0',
-            'filter'
-        );
-        return apply_filters(
-            'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
-            $existing_attendee,
-            $registration,
-            $attendee_data
-        );
-    },
-    10,
-    3
+	'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+	function($existing_attendee, $registration, $attendee_data) {
+		if ( ! has_filter( 'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee' )) {
+			return $existing_attendee;
+		}
+		deprecated_espresso_action_or_filter_doing_it_wrong(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			'FHEE_EventEspresso_core_domain_services_commands_attendee_CreateAttendeeCommandHandler__findExistingAttendee__existing_attendee',
+			'\EventEspresso\core\domain\services\commands\attendee\CreateAttendeeCommandHandler::findExistingAttendee()',
+			'4.9.34',
+			'5.0.0',
+			'filter'
+		);
+		return apply_filters(
+			'FHEE_EE_Single_Page_Checkout__save_registration_items__find_existing_attendee',
+			$existing_attendee,
+			$registration,
+			$attendee_data
+		);
+	},
+	10,
+	3
 );
 
 /**
@@ -1228,88 +1228,88 @@ 
 class EE_Event_List_Query extends WP_Query
 {
 
-    private $title;
-
-    private $css_class;
-
-    private $category_slug;
-
-    /**
-     * EE_Event_List_Query constructor.
-     *
-     * @param array $args
-     */
-    public function __construct($args = array())
-    {
-        \EE_Error::doing_it_wrong(
-            __METHOD__,
-            esc_html__(
-                'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
-                'event_espresso'
-            ),
-            '4.9.27',
-            '5.0.0'
-        );
-        $this->title = isset($args['title']) ? $args['title'] : '';
-        $this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
-        $this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
-        $limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
-        // the current "page" we are viewing
-        $paged = max(1, get_query_var('paged'));
-        // Force these args
-        $args = array_merge(
-            $args,
-            array(
-                'post_type'              => 'espresso_events',
-                'posts_per_page'         => $limit,
-                'update_post_term_cache' => false,
-                'update_post_meta_cache' => false,
-                'paged'                  => $paged,
-                'offset'                 => ($paged - 1) * $limit,
-            )
-        );
-        // run the query
-        parent::__construct($args);
-    }
-
-
-    /**
-     * event_list_title
-     *
-     * @param string $event_list_title
-     * @return string
-     */
-    public function event_list_title($event_list_title = '')
-    {
-        if (! empty($this->title)) {
-            return $this->title;
-        }
-        return $event_list_title;
-    }
-
-
-    /**
-     * event_list_css
-     *
-     * @param string $event_list_css
-     * @return string
-     */
-    public function event_list_css($event_list_css = '')
-    {
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->css_class)
-            ? $this->css_class
-            : '';
-        $event_list_css .= ! empty($event_list_css)
-            ? ' '
-            : '';
-        $event_list_css .= ! empty($this->category_slug)
-            ? $this->category_slug
-            : '';
-        return $event_list_css;
-    }
+	private $title;
+
+	private $css_class;
+
+	private $category_slug;
+
+	/**
+	 * EE_Event_List_Query constructor.
+	 *
+	 * @param array $args
+	 */
+	public function __construct($args = array())
+	{
+		\EE_Error::doing_it_wrong(
+			__METHOD__,
+			esc_html__(
+				'Usage is deprecated. Please use \EventEspresso\core\domain\services\wp_queries\EventListQuery instead.',
+				'event_espresso'
+			),
+			'4.9.27',
+			'5.0.0'
+		);
+		$this->title = isset($args['title']) ? $args['title'] : '';
+		$this->css_class = isset($args['css_class']) ? $args['css_class'] : '';
+		$this->category_slug = isset($args['category_slug']) ? $args['category_slug'] : '';
+		$limit = isset($args['limit']) && absint($args['limit']) ? $args['limit'] : 10;
+		// the current "page" we are viewing
+		$paged = max(1, get_query_var('paged'));
+		// Force these args
+		$args = array_merge(
+			$args,
+			array(
+				'post_type'              => 'espresso_events',
+				'posts_per_page'         => $limit,
+				'update_post_term_cache' => false,
+				'update_post_meta_cache' => false,
+				'paged'                  => $paged,
+				'offset'                 => ($paged - 1) * $limit,
+			)
+		);
+		// run the query
+		parent::__construct($args);
+	}
+
+
+	/**
+	 * event_list_title
+	 *
+	 * @param string $event_list_title
+	 * @return string
+	 */
+	public function event_list_title($event_list_title = '')
+	{
+		if (! empty($this->title)) {
+			return $this->title;
+		}
+		return $event_list_title;
+	}
+
+
+	/**
+	 * event_list_css
+	 *
+	 * @param string $event_list_css
+	 * @return string
+	 */
+	public function event_list_css($event_list_css = '')
+	{
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->css_class)
+			? $this->css_class
+			: '';
+		$event_list_css .= ! empty($event_list_css)
+			? ' '
+			: '';
+		$event_list_css .= ! empty($this->category_slug)
+			? $this->category_slug
+			: '';
+		return $event_list_css;
+	}
 
 }
 
@@ -1326,75 +1326,75 @@ 
 {
 
 
-    /**
-     *    class constructor
-     *
-     * @deprecated 4.9.59.p
-     */
-    public function __construct()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __CLASS__,
-                'EventEspresso\core\services\licensing\LicenseServices'
-            ),
-            '4.9.59.p'
-        );
-    }
-
-
-    /**
-     * The purpose of this function is to display information about Event Espresso data collection
-     * and a optin selection for extra data collecting by users.
-     *
-     * @param bool $extra
-     * @return string html.
-     * @deprecated 4.9.59.p
-     */
-    public static function espresso_data_collection_optin_text($extra = true)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\core\domain\services\Stats::optinText'
-            ),
-            '4.9.59.p'
-        );
-        Stats::optinText($extra);
-    }
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     * @deprecated 4.9.59.p
-     */
-    public static function is_update_available($basename = '')
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
-                __METHOD__,
-                'EventEspresso\caffeinated\core\services\licensing\LicenseService::isUpdateAvailable'
-            ),
-            '4.9.59.p'
-        );
-        return LicenseService::isUpdateAvailable($basename);
-    }
+	/**
+	 *    class constructor
+	 *
+	 * @deprecated 4.9.59.p
+	 */
+	public function __construct()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__CLASS__,
+				'EventEspresso\core\services\licensing\LicenseServices'
+			),
+			'4.9.59.p'
+		);
+	}
+
+
+	/**
+	 * The purpose of this function is to display information about Event Espresso data collection
+	 * and a optin selection for extra data collecting by users.
+	 *
+	 * @param bool $extra
+	 * @return string html.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function espresso_data_collection_optin_text($extra = true)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\core\domain\services\Stats::optinText'
+			),
+			'4.9.59.p'
+		);
+		Stats::optinText($extra);
+	}
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 * @deprecated 4.9.59.p
+	 */
+	public static function is_update_available($basename = '')
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__('%1$s has been replaced by %2$s.', 'event_espresso'),
+				__METHOD__,
+				'EventEspresso\caffeinated\core\services\licensing\LicenseService::isUpdateAvailable'
+			),
+			'4.9.59.p'
+		);
+		return LicenseService::isUpdateAvailable($basename);
+	}
 }
 
 add_filter(
-    'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
-    'ee_deprecated_registrations_report_csv_legacy_fields',
-    10,
-    2
+	'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array',
+	'ee_deprecated_registrations_report_csv_legacy_fields',
+	10,
+	2
 );
 /**
  * Filters the CSV row to make it appear like the old labels (which were "$pretty_name[$field_name]").
@@ -1411,96 +1411,96 @@ 
  */
 function ee_deprecated_registrations_report_csv_legacy_fields($csv_row_data, $reg_row)
 {
-    // no need for all this if nobody is using the deprecated filter
-    if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            sprintf(
-                // EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too.
-                _x(
-                    'The filter "%1$s" has been deprecated. Please use "%2$s" instead.',
-                    'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.',
-                    'event_espresso'
-                ),
-                'FHEE__EE_Export__report_registrations__reg_csv_array',
-                'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array'
-            ),
-            '4.9.69.p',
-            '4.9.75.p'
-        );
-        // there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format!
-        // first: what model fields might be used as column headers? (whose format we need to change)
-        $model_fields = array_merge(
-            EEM_Registration::instance()->field_settings(),
-            EEM_Attendee::instance()->field_settings()
-        );
-        // create an array that uses the legacy column headers/labels.
-        $new_csv_row = array();
-        foreach ($csv_row_data as $label => $value) {
-            $new_label = $label;
-            foreach ($model_fields as $field) {
-                if ($label === EEH_Export::get_column_name_for_field($field)) {
-                    // re-add the old field name
-                    $new_label = $label . '[' . $field->get_name() . ']';
-                    break;
-                }
-            }
-            $new_csv_row[$new_label] = $value;
-        }
-        // before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()`
-        // to create the old column names, because that's what's in the row temporarily
-        add_filter(
-            'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-            '__return_true',
-            777
-        );
-        // now, those old filters can be run on this data. Have fun!
-        /**
-         * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead.
-         *
-         * Filter to change the contents of each row of the registrations report CSV file.
-         * This can be used to add or remote columns from the CSV file, or change their values.                 *
-         * Note: it has this name because originally that's where this filter resided,
-         * and we've left its name as-is for backward compatibility.
-         * Note when using: all rows in the CSV should have the same columns.
-         *
-         * @param array $reg_csv_array keys are column-header names, and values are that columns' value
-         *                             in this row
-         * @param array $reg_row is the row from the database's wp_esp_registration table
-         */
-        $updated_row = apply_filters(
-            'FHEE__EE_Export__report_registrations__reg_csv_array',
-            $new_csv_row,
-            $reg_row
-        );
-
-        // ok now we can revert to normal for EEH_Export::get_column_name_for_field().
-        remove_filter(
-            'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
-            '__return_true',
-            777
-        );
-
-        // great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels.
-        $updated_and_restored_row = array();
-        foreach ($updated_row as $label => $value) {
-            $matches = array();
-            if (preg_match(
-                    '~([^\[]*)\[(.*)\]~',
-                    $label,
-                    $matches
-                )
-                && isset(
-                    $matches[0],
-                    $matches[1],
-                    $matches[2]
-                )
-            ) {
-                $label = $matches[1];
-            }
-            $updated_and_restored_row[$label] = $value;
-        }
-        $csv_row_data = $updated_and_restored_row;
-    }
-    return $csv_row_data;
+	// no need for all this if nobody is using the deprecated filter
+	if (has_filter('FHEE__EE_Export__report_registrations__reg_csv_array')) {
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			sprintf(
+				// EE_Error::doing_it_wrong with escape HTML, so don't escape it twice by doing it here too.
+				_x(
+					'The filter "%1$s" has been deprecated. Please use "%2$s" instead.',
+					'The filter "FHEE__EE_Export__report_registrations__reg_csv_array" has been deprecated. Please use "FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array" instead.',
+					'event_espresso'
+				),
+				'FHEE__EE_Export__report_registrations__reg_csv_array',
+				'FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array'
+			),
+			'4.9.69.p',
+			'4.9.75.p'
+		);
+		// there's code that expected the old csv column headers/labels. Let's oblige. Put it back in the old format!
+		// first: what model fields might be used as column headers? (whose format we need to change)
+		$model_fields = array_merge(
+			EEM_Registration::instance()->field_settings(),
+			EEM_Attendee::instance()->field_settings()
+		);
+		// create an array that uses the legacy column headers/labels.
+		$new_csv_row = array();
+		foreach ($csv_row_data as $label => $value) {
+			$new_label = $label;
+			foreach ($model_fields as $field) {
+				if ($label === EEH_Export::get_column_name_for_field($field)) {
+					// re-add the old field name
+					$new_label = $label . '[' . $field->get_name() . ']';
+					break;
+				}
+			}
+			$new_csv_row[$new_label] = $value;
+		}
+		// before we run it through the deprecated filter, set the method `EEH_Export::get_column_name_for_field()`
+		// to create the old column names, because that's what's in the row temporarily
+		add_filter(
+			'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+			'__return_true',
+			777
+		);
+		// now, those old filters can be run on this data. Have fun!
+		/**
+		 * Deprecated. Use FHEE__EventEspressoBatchRequest__JobHandlers__RegistrationsReport__reg_csv_array instead.
+		 *
+		 * Filter to change the contents of each row of the registrations report CSV file.
+		 * This can be used to add or remote columns from the CSV file, or change their values.                 *
+		 * Note: it has this name because originally that's where this filter resided,
+		 * and we've left its name as-is for backward compatibility.
+		 * Note when using: all rows in the CSV should have the same columns.
+		 *
+		 * @param array $reg_csv_array keys are column-header names, and values are that columns' value
+		 *                             in this row
+		 * @param array $reg_row is the row from the database's wp_esp_registration table
+		 */
+		$updated_row = apply_filters(
+			'FHEE__EE_Export__report_registrations__reg_csv_array',
+			$new_csv_row,
+			$reg_row
+		);
+
+		// ok now we can revert to normal for EEH_Export::get_column_name_for_field().
+		remove_filter(
+			'FHEE__EEH_Export__get_column_name_for_field__add_field_name',
+			'__return_true',
+			777
+		);
+
+		// great. Now that the old filters are done, we can remove the ugly square brackets from column headers/labels.
+		$updated_and_restored_row = array();
+		foreach ($updated_row as $label => $value) {
+			$matches = array();
+			if (preg_match(
+					'~([^\[]*)\[(.*)\]~',
+					$label,
+					$matches
+				)
+				&& isset(
+					$matches[0],
+					$matches[1],
+					$matches[2]
+				)
+			) {
+				$label = $matches[1];
+			}
+			$updated_and_restored_row[$label] = $value;
+		}
+		$csv_row_data = $updated_and_restored_row;
+	}
+	return $csv_row_data;
 }

core/services/request/RequestParams.php

Indentation +345 added lines, -345 removed lines

@@ -13,349 +13,349 @@
  */
 class RequestParams
 {
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'bool' will return true or false if match is found or not
-     */
-    const RETURN_BOOL  = 'bool';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'key' will return the first key found that matches the supplied pattern
-     */
-    const RETURN_KEY   = 'key';
-
-    /**
-     * Used for matches() and parameterDrillDown()
-     * 'value' will return the value for the first request parameter
-     */
-    const RETURN_VALUE = 'value';
-
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = $get;
-        $this->post      = $post;
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request = array_merge($this->request, $request_params);
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        $param = $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $is_array,
-            $delimiter
-        );
-        $type = $is_array ? 'array' : $type;
-        return DataType::setDataType($param, $type);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are the RETURN_* constants:
-     *                                      RETURN_BOOL will return true or false if match is found or not
-     *                                      RETURN_KEY will return the first key found that matches the supplied pattern
-     *                                      RETURN_VALUE will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
-    {
-        $return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === self::RETURN_VALUE) {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === self::RETURN_KEY ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === self::RETURN_VALUE ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param mixed  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = self::RETURN_VALUE,
-        $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'bool' will return true or false if match is found or not
+	 */
+	const RETURN_BOOL  = 'bool';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'key' will return the first key found that matches the supplied pattern
+	 */
+	const RETURN_KEY   = 'key';
+
+	/**
+	 * Used for matches() and parameterDrillDown()
+	 * 'value' will return the value for the first request parameter
+	 */
+	const RETURN_VALUE = 'value';
+
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = $get;
+		$this->post      = $post;
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request = array_merge($this->request, $request_params);
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		$param = $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$is_array,
+			$delimiter
+		);
+		$type = $is_array ? 'array' : $type;
+		return DataType::setDataType($param, $type);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return (bool) $this->parameterDrillDown($pattern, false, 'match', self::RETURN_BOOL);
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are the RETURN_* constants:
+	 *                                      RETURN_BOOL will return true or false if match is found or not
+	 *                                      RETURN_KEY will return the first key found that matches the supplied pattern
+	 *                                      RETURN_VALUE will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = self::RETURN_VALUE)
+	{
+		$return = in_array($return, [self::RETURN_BOOL, self::RETURN_KEY, self::RETURN_VALUE], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === self::RETURN_VALUE) {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === self::RETURN_KEY ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === self::RETURN_VALUE ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param mixed  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = self::RETURN_VALUE,
+		$request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, self::RETURN_KEY);
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }

core/services/request/ServerParams.php

Indentation +199 added lines, -199 removed lines

@@ -6,203 +6,203 @@
 
 class ServerParams
 {
-    /**
-     * IP address for request
-     *
-     * @var string
-     */
-    protected $ip_address;
-
-
-    /**
-     * @var ServerSanitizer
-     */
-    protected $sanitizer;
-
-    /**
-     * sanitized $_SERVER parameters
-     *
-     * @var array
-     */
-    protected $server;
-
-    /**
-     * @var string
-     */
-    protected $request_uri;
-
-    /**
-     * @var string
-     */
-    protected $user_agent;
-
-
-    /**
-     * ServerParams constructor.
-     *
-     * @param ServerSanitizer $sanitizer
-     * @param array           $server
-     */
-    public function __construct(ServerSanitizer $sanitizer, array $server = [])
-    {
-        $this->sanitizer  = $sanitizer;
-        $this->server     = $this->cleanServerParams($server);
-        $this->ip_address = $this->setVisitorIp();
-    }
-
-
-    /**
-     * @return array
-     */
-    private function cleanServerParams(array $server)
-    {
-        $cleaned = [];
-        foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
-        }
-        return $cleaned;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getAllServerParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null)
-    {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $clean_value = $this->sanitizer->clean($key, $value);
-        $this->server[ $key ] = $clean_value;
-        // modify global too
-        $_SERVER[ $key ] = $clean_value;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return isset($this->server[ $key ]);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetServerParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->server[ $key ] = null;
-        unset($this->server[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_SERVER[ $key ]);
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function setVisitorIp()
-    {
-        $visitor_ip  = '0.0.0.0';
-        $server_keys = [
-            'HTTP_CLIENT_IP',
-            'HTTP_FORWARDED',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_FORWARDED_FOR',
-            'REMOTE_ADDR',
-        ];
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                $potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
-                foreach ($potential_ip as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     *
-     * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        if ($relativeToWpRoot) {
-            $home_path = untrailingslashit(parse_url(home_url(), PHP_URL_PATH));
-            return str_replace($home_path, '', $this->server['REQUEST_URI']);
-        }
-        return $this->server['REQUEST_URI'];
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        if (empty($this->user_agent)) {
-            $this->setUserAgent();
-        }
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->user_agent = $user_agent === '' || ! is_string($user_agent)
-            ? $this->getServerParam('HTTP_USER_AGENT')
-            : esc_attr($user_agent);
-    }
+	/**
+	 * IP address for request
+	 *
+	 * @var string
+	 */
+	protected $ip_address;
+
+
+	/**
+	 * @var ServerSanitizer
+	 */
+	protected $sanitizer;
+
+	/**
+	 * sanitized $_SERVER parameters
+	 *
+	 * @var array
+	 */
+	protected $server;
+
+	/**
+	 * @var string
+	 */
+	protected $request_uri;
+
+	/**
+	 * @var string
+	 */
+	protected $user_agent;
+
+
+	/**
+	 * ServerParams constructor.
+	 *
+	 * @param ServerSanitizer $sanitizer
+	 * @param array           $server
+	 */
+	public function __construct(ServerSanitizer $sanitizer, array $server = [])
+	{
+		$this->sanitizer  = $sanitizer;
+		$this->server     = $this->cleanServerParams($server);
+		$this->ip_address = $this->setVisitorIp();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	private function cleanServerParams(array $server)
+	{
+		$cleaned = [];
+		foreach ($server as $key => $value) {
+			$cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+		}
+		return $cleaned;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getAllServerParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null)
+	{
+		return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$clean_value = $this->sanitizer->clean($key, $value);
+		$this->server[ $key ] = $clean_value;
+		// modify global too
+		$_SERVER[ $key ] = $clean_value;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return isset($this->server[ $key ]);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetServerParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->server[ $key ] = null;
+		unset($this->server[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_SERVER[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function setVisitorIp()
+	{
+		$visitor_ip  = '0.0.0.0';
+		$server_keys = [
+			'HTTP_CLIENT_IP',
+			'HTTP_FORWARDED',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_FORWARDED_FOR',
+			'REMOTE_ADDR',
+		];
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				$potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
+				foreach ($potential_ip as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 *
+	 * @param boolean $relativeToWpRoot If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                  "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                  "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		if ($relativeToWpRoot) {
+			$home_path = untrailingslashit(parse_url(home_url(), PHP_URL_PATH));
+			return str_replace($home_path, '', $this->server['REQUEST_URI']);
+		}
+		return $this->server['REQUEST_URI'];
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		if (empty($this->user_agent)) {
+			$this->setUserAgent();
+		}
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->user_agent = $user_agent === '' || ! is_string($user_agent)
+			? $this->getServerParam('HTTP_USER_AGENT')
+			: esc_attr($user_agent);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -58,7 +58,7 @@ 
     {
         $cleaned = [];
         foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+            $cleaned[$key] = $this->sanitizer->clean($key, $value);
         }
         return $cleaned;
     }
@@ -80,7 +80,7 @@ 
      */
     public function getServerParam($key, $default = null)
     {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
+        return $this->serverParamIsSet($key) ? $this->server[$key] : $default;
     }
 
 
@@ -92,9 +92,9 @@ 
     public function setServerParam($key, $value)
     {
         $clean_value = $this->sanitizer->clean($key, $value);
-        $this->server[ $key ] = $clean_value;
+        $this->server[$key] = $clean_value;
         // modify global too
-        $_SERVER[ $key ] = $clean_value;
+        $_SERVER[$key] = $clean_value;
     }
 
 
@@ -103,7 +103,7 @@ 
      */
     public function serverParamIsSet($key)
     {
-        return isset($this->server[ $key ]);
+        return isset($this->server[$key]);
     }
 
 
@@ -116,10 +116,10 @@ 
     public function unSetServerParam($key, $unset_from_global_too = false)
     {
         // because unset may not actually remove var
-        $this->server[ $key ] = null;
-        unset($this->server[ $key ]);
+        $this->server[$key] = null;
+        unset($this->server[$key]);
         if ($unset_from_global_too) {
-            unset($_SERVER[ $key ]);
+            unset($_SERVER[$key]);
         }
     }
 
@@ -153,8 +153,8 @@ 
             'REMOTE_ADDR',
         ];
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                $potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
+            if (isset($this->server[$key])) {
+                $potential_ip = array_map('trim', explode(',', $this->server[$key]));
                 foreach ($potential_ip as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;

core/services/bootstrap/BootstrapRequestResponseObjects.php

Indentation +69 added lines, -69 removed lines

@@ -28,84 +28,84 @@
  */
 class BootstrapRequestResponseObjects
 {
-    /**
-     * @type LegacyRequestInterface $legacy_request
-     */
-    protected $legacy_request;
+	/**
+	 * @type LegacyRequestInterface $legacy_request
+	 */
+	protected $legacy_request;
 
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
 
-    /**
-     * @var RequestInterface $request
-     */
-    protected $request;
+	/**
+	 * @var RequestInterface $request
+	 */
+	protected $request;
 
-    /**
-     * @var ResponseInterface $response
-     */
-    protected $response;
+	/**
+	 * @var ResponseInterface $response
+	 */
+	protected $response;
 
 
-    /**
-     * BootstrapRequestResponseObjects constructor.
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * BootstrapRequestResponseObjects constructor.
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
 
-    /**
-     * @return void
-     */
-    public function buildRequestResponse()
-    {
-        $request_params = new RequestParams(new RequestSanitizer(), $_GET, $_POST);
-        $server_params = new ServerParams(new ServerSanitizer(), $_SERVER);
-        // load our Request and Response objects
-        $this->request = new Request($request_params, $server_params);
-        $this->response = new Response();
-        $this->loader->share(RequestParams::class, $request_params);
-        $this->loader->share(ServerParams::class, $server_params);
-    }
+	/**
+	 * @return void
+	 */
+	public function buildRequestResponse()
+	{
+		$request_params = new RequestParams(new RequestSanitizer(), $_GET, $_POST);
+		$server_params = new ServerParams(new ServerSanitizer(), $_SERVER);
+		// load our Request and Response objects
+		$this->request = new Request($request_params, $server_params);
+		$this->response = new Response();
+		$this->loader->share(RequestParams::class, $request_params);
+		$this->loader->share(ServerParams::class, $server_params);
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     */
-    public function shareRequestResponse()
-    {
-        $this->loader->share('EventEspresso\core\services\request\Request', $this->request);
-        $this->loader->share('EventEspresso\core\services\request\Response', $this->response);
-        EE_Dependency_Map::instance()->setRequest($this->request);
-        EE_Dependency_Map::instance()->setResponse($this->response);
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 */
+	public function shareRequestResponse()
+	{
+		$this->loader->share('EventEspresso\core\services\request\Request', $this->request);
+		$this->loader->share('EventEspresso\core\services\request\Response', $this->response);
+		EE_Dependency_Map::instance()->setRequest($this->request);
+		EE_Dependency_Map::instance()->setResponse($this->response);
+	}
 
 
-    /**
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    public function setupLegacyRequest()
-    {
-        espresso_load_required(
-            'EE_Request',
-            EE_CORE . 'request_stack/EE_Request.core.php'
-        );
-        $this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
-        $this->legacy_request->setRequest($this->request);
-        $this->legacy_request->admin = $this->request->isAdmin();
-        $this->legacy_request->ajax = $this->request->isAjax();
-        $this->legacy_request->front_ajax = $this->request->isFrontAjax();
-        EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
-        $this->loader->share('EE_Request', $this->legacy_request);
-        $this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
-    }
+	/**
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	public function setupLegacyRequest()
+	{
+		espresso_load_required(
+			'EE_Request',
+			EE_CORE . 'request_stack/EE_Request.core.php'
+		);
+		$this->legacy_request = new EE_Request($_GET, $_POST, $_COOKIE, $_SERVER);
+		$this->legacy_request->setRequest($this->request);
+		$this->legacy_request->admin = $this->request->isAdmin();
+		$this->legacy_request->ajax = $this->request->isAjax();
+		$this->legacy_request->front_ajax = $this->request->isFrontAjax();
+		EE_Dependency_Map::instance()->setLegacyRequest($this->legacy_request);
+		$this->loader->share('EE_Request', $this->legacy_request);
+		$this->loader->share('EventEspresso\core\services\request\LegacyRequestInterface', $this->legacy_request);
+	}
 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Spacing +107 added lines, -107 removed lines

@@ -70,15 +70,15 @@ 
         // offsets:    0 . 1 . 2 . 3 . 4
         $version_parts = explode('.', $min_core_version);
         // check they specified the micro version (after 2nd period)
-        if (! isset($version_parts[2])) {
+        if ( ! isset($version_parts[2])) {
             $version_parts[2] = '0';
         }
         // if they didn't specify the 'p', or 'rc' part. Just assume the lowest possible
         // soon we can assume that's 'rc', but this current version is 'alpha'
-        if (! isset($version_parts[3])) {
+        if ( ! isset($version_parts[3])) {
             $version_parts[3] = 'dev';
         }
-        if (! isset($version_parts[4])) {
+        if ( ! isset($version_parts[4])) {
             $version_parts[4] = '000';
         }
         return implode('.', $version_parts);
@@ -270,7 +270,7 @@ 
         );
         // does this addon work with this version of core or WordPress ?
         // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return;
         }
         // register namespaces
@@ -346,7 +346,7 @@ 
             );
         }
         // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+        if (isset(self::$_settings[$addon_name]) && ! did_action('activate_plugin')) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -378,7 +378,7 @@ 
         // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
         return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
             ? $class_name
-            : 'EE_' . $class_name;
+            : 'EE_'.$class_name;
     }
 
 
@@ -540,9 +540,9 @@ 
         $incompatibility_message = '';
         // check whether this addon version is compatible with EE core
         if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+            isset(EE_Register_Addon::$_incompatible_addons[$addon_name])
             && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 $addon_settings['version']
             )
         ) {
@@ -553,7 +553,7 @@ 
                 ),
                 $addon_name,
                 '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+                EE_Register_Addon::$_incompatible_addons[$addon_name],
                 '<span style="font-weight: bold; color: #D54E21;">',
                 '</span><br />'
             );
@@ -585,7 +585,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             /** @var RequestInterface $request */
@@ -596,8 +596,8 @@ 
                 EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
             }
             unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
             // BAIL FROM THE ADDON REGISTRATION PROCESS
@@ -648,12 +648,12 @@ 
             // Note: the presence of pue_options in the addon registration options will initialize the $_settings
             // property for the add-on, but the add-on is only partially initialized.  Hence, the additional check.
             if (
-                ! isset(self::$_settings[ $addon_name ])
-                || (isset(self::$_settings[ $addon_name ])
-                    && ! isset(self::$_settings[ $addon_name ]['class_name'])
+                ! isset(self::$_settings[$addon_name])
+                || (isset(self::$_settings[$addon_name])
+                    && ! isset(self::$_settings[$addon_name]['class_name'])
                 )
             ) {
-                self::$_settings[ $addon_name ] = $addon_settings;
+                self::$_settings[$addon_name] = $addon_settings;
                 $addon                          = self::_load_and_init_addon_class($addon_name);
                 $addon->set_activation_indicator_option();
                 // dont bother setting up the rest of the addon.
@@ -679,10 +679,10 @@ 
             );
         }
         // make sure addon settings are set correctly without overwriting anything existing
-        if (isset(self::$_settings[ $addon_name ])) {
-            self::$_settings[ $addon_name ] += $addon_settings;
+        if (isset(self::$_settings[$addon_name])) {
+            self::$_settings[$addon_name] += $addon_settings;
         } else {
-            self::$_settings[ $addon_name ] = $addon_settings;
+            self::$_settings[$addon_name] = $addon_settings;
         }
         return false;
     }
@@ -695,13 +695,13 @@ 
      */
     private static function _setup_autoloaders(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_paths'])) {
             // setup autoloader for single file
-            EEH_Autoloader::instance()->register_autoloader(self::$_settings[ $addon_name ]['autoloader_paths']);
+            EEH_Autoloader::instance()->register_autoloader(self::$_settings[$addon_name]['autoloader_paths']);
         }
         // setup autoloaders for folders
-        if (! empty(self::$_settings[ $addon_name ]['autoloader_folders'])) {
-            foreach ((array) self::$_settings[ $addon_name ]['autoloader_folders'] as $autoloader_folder) {
+        if ( ! empty(self::$_settings[$addon_name]['autoloader_folders'])) {
+            foreach ((array) self::$_settings[$addon_name]['autoloader_folders'] as $autoloader_folder) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($autoloader_folder);
             }
         }
@@ -719,27 +719,27 @@ 
     {
         // register new models
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+            ! empty(self::$_settings[$addon_name]['model_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_paths'])
         ) {
             EE_Register_Model::register(
                 $addon_name,
                 [
-                    'model_paths' => self::$_settings[ $addon_name ]['model_paths'],
-                    'class_paths' => self::$_settings[ $addon_name ]['class_paths'],
+                    'model_paths' => self::$_settings[$addon_name]['model_paths'],
+                    'class_paths' => self::$_settings[$addon_name]['class_paths'],
                 ]
             );
         }
         // register model extensions
         if (
-            ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+            ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+            || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
         ) {
             EE_Register_Model_Extensions::register(
                 $addon_name,
                 [
-                    'model_extension_paths' => self::$_settings[ $addon_name ]['model_extension_paths'],
-                    'class_extension_paths' => self::$_settings[ $addon_name ]['class_extension_paths'],
+                    'model_extension_paths' => self::$_settings[$addon_name]['model_extension_paths'],
+                    'class_extension_paths' => self::$_settings[$addon_name]['class_extension_paths'],
                 ]
             );
         }
@@ -754,10 +754,10 @@ 
     private static function _register_data_migration_scripts(string $addon_name)
     {
         // setup DMS
-        if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
             EE_Register_Data_Migration_Scripts::register(
                 $addon_name,
-                ['dms_paths' => self::$_settings[ $addon_name ]['dms_paths']]
+                ['dms_paths' => self::$_settings[$addon_name]['dms_paths']]
             );
         }
     }
@@ -771,12 +771,12 @@ 
     private static function _register_config(string $addon_name)
     {
         // if config_class is present let's register config.
-        if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+        if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
             EE_Register_Config::register(
-                self::$_settings[ $addon_name ]['config_class'],
+                self::$_settings[$addon_name]['config_class'],
                 [
-                    'config_section' => self::$_settings[ $addon_name ]['config_section'],
-                    'config_name'    => self::$_settings[ $addon_name ]['config_name'],
+                    'config_section' => self::$_settings[$addon_name]['config_section'],
+                    'config_name'    => self::$_settings[$addon_name]['config_name'],
                 ]
             );
         }
@@ -790,10 +790,10 @@ 
      */
     private static function _register_admin_pages(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
             EE_Register_Admin_Page::register(
                 $addon_name,
-                ['page_path' => self::$_settings[ $addon_name ]['admin_path']]
+                ['page_path' => self::$_settings[$addon_name]['admin_path']]
             );
         }
     }
@@ -806,10 +806,10 @@ 
      */
     private static function _register_modules(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
             EE_Register_Module::register(
                 $addon_name,
-                ['module_paths' => self::$_settings[ $addon_name ]['module_paths']]
+                ['module_paths' => self::$_settings[$addon_name]['module_paths']]
             );
         }
     }
@@ -823,14 +823,14 @@ 
     private static function _register_shortcodes(string $addon_name)
     {
         if (
-            ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-            || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+            ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+            || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
         ) {
             EE_Register_Shortcode::register(
                 $addon_name,
                 [
-                    'shortcode_paths' => self::$_settings[ $addon_name ]['shortcode_paths'] ?? [],
-                    'shortcode_fqcns' => self::$_settings[ $addon_name ]['shortcode_fqcns'] ?? [],
+                    'shortcode_paths' => self::$_settings[$addon_name]['shortcode_paths'] ?? [],
+                    'shortcode_fqcns' => self::$_settings[$addon_name]['shortcode_fqcns'] ?? [],
                 ]
             );
         }
@@ -844,10 +844,10 @@ 
      */
     private static function _register_widgets(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
             EE_Register_Widget::register(
                 $addon_name,
-                ['widget_paths' => self::$_settings[ $addon_name ]['widget_paths']]
+                ['widget_paths' => self::$_settings[$addon_name]['widget_paths']]
             );
         }
     }
@@ -860,12 +860,12 @@ 
      */
     private static function _register_capabilities(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['capabilities'])) {
+        if ( ! empty(self::$_settings[$addon_name]['capabilities'])) {
             EE_Register_Capabilities::register(
                 $addon_name,
                 [
-                    'capabilities'    => self::$_settings[ $addon_name ]['capabilities'],
-                    'capability_maps' => self::$_settings[ $addon_name ]['capability_maps'],
+                    'capabilities'    => self::$_settings[$addon_name]['capabilities'],
+                    'capability_maps' => self::$_settings[$addon_name]['capability_maps'],
                 ]
             );
         }
@@ -878,7 +878,7 @@ 
      */
     private static function _register_message_types(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
+        if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
             add_action(
                 'EE_Brewing_Regular___messages_caf',
                 ['EE_Register_Addon', 'register_message_types']
@@ -895,15 +895,15 @@ 
     private static function _register_custom_post_types(string $addon_name)
     {
         if (
-            ! empty(self::$_settings[ $addon_name ]['custom_post_types'])
-            || ! empty(self::$_settings[ $addon_name ]['custom_taxonomies'])
+            ! empty(self::$_settings[$addon_name]['custom_post_types'])
+            || ! empty(self::$_settings[$addon_name]['custom_taxonomies'])
         ) {
             EE_Register_CPT::register(
                 $addon_name,
                 [
-                    'cpts'          => self::$_settings[ $addon_name ]['custom_post_types'],
-                    'cts'           => self::$_settings[ $addon_name ]['custom_taxonomies'],
-                    'default_terms' => self::$_settings[ $addon_name ]['default_terms'],
+                    'cpts'          => self::$_settings[$addon_name]['custom_post_types'],
+                    'cts'           => self::$_settings[$addon_name]['custom_taxonomies'],
+                    'default_terms' => self::$_settings[$addon_name]['default_terms'],
                 ]
             );
         }
@@ -921,10 +921,10 @@ 
      */
     private static function _register_payment_methods(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+        if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
             EE_Register_Payment_Method::register(
                 $addon_name,
-                ['payment_method_paths' => self::$_settings[ $addon_name ]['payment_method_paths']]
+                ['payment_method_paths' => self::$_settings[$addon_name]['payment_method_paths']]
             );
         }
     }
@@ -940,10 +940,10 @@ 
      */
     private static function registerPrivacyPolicies(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['privacy_policies'])) {
+        if ( ! empty(self::$_settings[$addon_name]['privacy_policies'])) {
             EE_Register_Privacy_Policy::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['privacy_policies']
+                self::$_settings[$addon_name]['privacy_policies']
             );
         }
     }
@@ -955,10 +955,10 @@ 
      */
     private static function registerPersonalDataExporters(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_exporters'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_exporters'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_exporters']
+                self::$_settings[$addon_name]['personal_data_exporters']
             );
         }
     }
@@ -970,10 +970,10 @@ 
      */
     private static function registerPersonalDataErasers(string $addon_name)
     {
-        if (! empty(self::$_settings[ $addon_name ]['personal_data_erasers'])) {
+        if ( ! empty(self::$_settings[$addon_name]['personal_data_erasers'])) {
             EE_Register_Personal_Data_Eraser::register(
                 $addon_name,
-                self::$_settings[ $addon_name ]['personal_data_erasers']
+                self::$_settings[$addon_name]['personal_data_erasers']
             );
         }
     }
@@ -991,10 +991,10 @@ 
     private static function _load_and_init_addon_class(string $addon_name): EE_Addon
     {
         $addon = LoaderFactory::getLoader()->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
+            self::$_settings[$addon_name]['class_name'],
             ['EE_Registry::create(addon)' => true]
         );
-        if (! $addon instanceof EE_Addon) {
+        if ( ! $addon instanceof EE_Addon) {
             throw new DomainException(
                 sprintf(
                     esc_html__(
@@ -1013,16 +1013,16 @@ 
         EE_Register_Addon::injectAddonDomain($addon_name, $addon);
 
         $addon->set_name($addon_name);
-        $addon->set_plugin_slug(self::$_settings[ $addon_name ]['plugin_slug']);
-        $addon->set_plugin_basename(self::$_settings[ $addon_name ]['plugin_basename']);
-        $addon->set_main_plugin_file(self::$_settings[ $addon_name ]['main_file_path']);
-        $addon->set_plugin_action_slug(self::$_settings[ $addon_name ]['plugin_action_slug']);
-        $addon->set_plugins_page_row(self::$_settings[ $addon_name ]['plugins_page_row']);
-        $addon->set_version(self::$_settings[ $addon_name ]['version']);
-        $addon->set_min_core_version(self::_effective_version(self::$_settings[ $addon_name ]['min_core_version']));
-        $addon->set_config_section(self::$_settings[ $addon_name ]['config_section']);
-        $addon->set_config_class(self::$_settings[ $addon_name ]['config_class']);
-        $addon->set_config_name(self::$_settings[ $addon_name ]['config_name']);
+        $addon->set_plugin_slug(self::$_settings[$addon_name]['plugin_slug']);
+        $addon->set_plugin_basename(self::$_settings[$addon_name]['plugin_basename']);
+        $addon->set_main_plugin_file(self::$_settings[$addon_name]['main_file_path']);
+        $addon->set_plugin_action_slug(self::$_settings[$addon_name]['plugin_action_slug']);
+        $addon->set_plugins_page_row(self::$_settings[$addon_name]['plugins_page_row']);
+        $addon->set_version(self::$_settings[$addon_name]['version']);
+        $addon->set_min_core_version(self::_effective_version(self::$_settings[$addon_name]['min_core_version']));
+        $addon->set_config_section(self::$_settings[$addon_name]['config_section']);
+        $addon->set_config_class(self::$_settings[$addon_name]['config_class']);
+        $addon->set_config_name(self::$_settings[$addon_name]['config_name']);
         do_action(
             'AHEE__EE_Register_Addon___load_and_init_addon_class',
             $addon,
@@ -1033,10 +1033,10 @@ 
         // because we don't have the plugin's mainfile path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
-                [$addon, self::$_settings[ $addon_name ]['admin_callback']]
+                [$addon, self::$_settings[$addon_name]['admin_callback']]
             );
         }
         return $addon;
@@ -1052,19 +1052,19 @@ 
     {
         if ($addon instanceof RequiresDomainInterface && $addon->domain() === null) {
             // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
+            $domain = self::$_settings[$addon_name]['domain'] instanceof DomainInterface
+                ? self::$_settings[$addon_name]['domain']
                 : null;
             // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+            if ($domain === null && self::$_settings[$addon_name]['domain_fqcn'] !== '') {
                 $domain = LoaderFactory::getLoader()->getShared(
-                    self::$_settings[ $addon_name ]['domain_fqcn'],
+                    self::$_settings[$addon_name]['domain_fqcn'],
                     [
                         new EventEspresso\core\domain\values\FilePath(
-                            self::$_settings[ $addon_name ]['main_file_path']
+                            self::$_settings[$addon_name]['main_file_path']
                         ),
                         EventEspresso\core\domain\values\Version::fromString(
-                            self::$_settings[ $addon_name ]['version']
+                            self::$_settings[$addon_name]['version']
                         ),
                     ]
                 );
@@ -1095,7 +1095,7 @@ 
     public static function register_message_types()
     {
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['message_types'])) {
+            if ( ! empty($settings['message_types'])) {
                 foreach ((array) $settings['message_types'] as $message_type => $message_type_settings) {
                     EE_Register_Message_Type::register($message_type, $message_type_settings);
                 }
@@ -1116,74 +1116,74 @@ 
      */
     public static function deregister($addon_name = '')
     {
-        if (isset(self::$_settings[ $addon_name ]['class_name'])) {
+        if (isset(self::$_settings[$addon_name]['class_name'])) {
             try {
                 do_action('AHEE__EE_Register_Addon__deregister__before', $addon_name);
-                $class_name = self::$_settings[ $addon_name ]['class_name'];
-                if (! empty(self::$_settings[ $addon_name ]['dms_paths'])) {
+                $class_name = self::$_settings[$addon_name]['class_name'];
+                if ( ! empty(self::$_settings[$addon_name]['dms_paths'])) {
                     // setup DMS
                     EE_Register_Data_Migration_Scripts::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['admin_path'])) {
+                if ( ! empty(self::$_settings[$addon_name]['admin_path'])) {
                     // register admin page
                     EE_Register_Admin_Page::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['module_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['module_paths'])) {
                     // add to list of modules to be registered
                     EE_Register_Module::deregister($addon_name);
                 }
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['shortcode_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['shortcode_fqcns'])
+                    ! empty(self::$_settings[$addon_name]['shortcode_paths'])
+                    || ! empty(self::$_settings[$addon_name]['shortcode_fqcns'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Shortcode::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['config_class'])) {
+                if ( ! empty(self::$_settings[$addon_name]['config_class'])) {
                     // if config_class present let's register config.
-                    EE_Register_Config::deregister(self::$_settings[ $addon_name ]['config_class']);
+                    EE_Register_Config::deregister(self::$_settings[$addon_name]['config_class']);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['widget_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['widget_paths'])) {
                     // add to list of widgets to be registered
                     EE_Register_Widget::deregister($addon_name);
                 }
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['model_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_paths'])
+                    ! empty(self::$_settings[$addon_name]['model_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model::deregister($addon_name);
                 }
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['model_extension_paths'])
-                    || ! empty(self::$_settings[ $addon_name ]['class_extension_paths'])
+                    ! empty(self::$_settings[$addon_name]['model_extension_paths'])
+                    || ! empty(self::$_settings[$addon_name]['class_extension_paths'])
                 ) {
                     // add to list of shortcodes to be registered
                     EE_Register_Model_Extensions::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['message_types'])) {
-                    foreach ((array) self::$_settings[ $addon_name ]['message_types'] as $message_type => $message_type_settings) {
+                if ( ! empty(self::$_settings[$addon_name]['message_types'])) {
+                    foreach ((array) self::$_settings[$addon_name]['message_types'] as $message_type => $message_type_settings) {
                         EE_Register_Message_Type::deregister($message_type);
                     }
                 }
                 // deregister capabilities for addon
                 if (
-                    ! empty(self::$_settings[ $addon_name ]['capabilities'])
-                    || ! empty(self::$_settings[ $addon_name ]['capability_maps'])
+                    ! empty(self::$_settings[$addon_name]['capabilities'])
+                    || ! empty(self::$_settings[$addon_name]['capability_maps'])
                 ) {
                     EE_Register_Capabilities::deregister($addon_name);
                 }
                 // deregister custom_post_types for addon
-                if (! empty(self::$_settings[ $addon_name ]['custom_post_types'])) {
+                if ( ! empty(self::$_settings[$addon_name]['custom_post_types'])) {
                     EE_Register_CPT::deregister($addon_name);
                 }
-                if (! empty(self::$_settings[ $addon_name ]['payment_method_paths'])) {
+                if ( ! empty(self::$_settings[$addon_name]['payment_method_paths'])) {
                     EE_Register_Payment_Method::deregister($addon_name);
                 }
                 $addon = EE_Registry::instance()->getAddon($class_name);
                 if ($addon instanceof EE_Addon) {
                     remove_action(
-                        'deactivate_' . $addon->get_main_plugin_file_basename(),
+                        'deactivate_'.$addon->get_main_plugin_file_basename(),
                         [$addon, 'deactivation']
                     );
                     remove_action(
@@ -1207,7 +1207,7 @@ 
             } catch (Exception $e) {
                 new ExceptionLogger($e);
             }
-            unset(self::$_settings[ $addon_name ]);
+            unset(self::$_settings[$addon_name]);
             do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
         }
     }

Indentation +1127 added lines, -1127 removed lines

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