eventespresso / event-espresso-core

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Indentation +151 added lines, -151 removed lines

@@ -19,163 +19,163 @@
 class EE_Register_Payment_Method implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered payment methods
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered payment methods
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     * Method for registering new EE_PMT_Base children
-     *
-     * @param string  $addon_name           a unique identifier for this set of modules Required.
-     * @param array   $setup_args           an array of arguments provided for registering modules Required.{
-     * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
-     *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
-     *                                      the files EE_PMT_Payomatic.pm.php)
-     *                                      }
-     * @return bool
-     * @throws EE_Error
-     * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
-     *                                      children, or to the EED_Module files themselves
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @since    4.5.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            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__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
-            // array of full server paths to any EE_PMT_Base children used
-            'payment_method_paths' => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : [],
-        ];
-        // add to list of modules to be registered
-        add_filter(
-            'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
-            ['EE_Register_Payment_Method', 'add_payment_methods']
-        );
-        // If EE_Payment_Method_Manager::register_payment_methods has already been called,
-        // then we need to add our caps for this payment method manually
-        if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
-            $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            // register payment methods directly
-            foreach (self::$_settings[ $addon_name ]['payment_method_paths'] as $payment_method_path) {
-                $payment_method_manager->register_payment_method($payment_method_path);
-            }
-            $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-            $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $addon_name ])
-            );
-        }
-        return true;
-    }
+	/**
+	 * Method for registering new EE_PMT_Base children
+	 *
+	 * @param string  $addon_name           a unique identifier for this set of modules Required.
+	 * @param array   $setup_args           an array of arguments provided for registering modules Required.{
+	 * @type string[] $payment_method_paths each element is the folder containing the EE_PMT_Base child class
+	 *                                      (eg, 'public_html/wp-content/plugins/my_plugin/Payomatic/' which contains
+	 *                                      the files EE_PMT_Payomatic.pm.php)
+	 *                                      }
+	 * @return bool
+	 * @throws EE_Error
+	 * @type array payment_method_paths    an array of full server paths to folders containing any EE_PMT_Base
+	 *                                      children, or to the EED_Module files themselves
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @since    4.5.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['payment_method_paths'])) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Payment Methods with EE_Register_Payment_Method::register(), you must include a "payment_method_id" (a unique identifier for this set of modules), and an array containing the following keys: "payment_method_paths" (an array of full server paths to folders that contain modules, or to the module files themselves)',
+					'event_espresso'
+				)
+			);
+		}
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			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__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register modules has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register modules.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = [
+			// array of full server paths to any EE_PMT_Base children used
+			'payment_method_paths' => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: [],
+		];
+		// add to list of modules to be registered
+		add_filter(
+			'FHEE__EE_Payment_Method_Manager__register_payment_methods__payment_methods_to_register',
+			['EE_Register_Payment_Method', 'add_payment_methods']
+		);
+		// If EE_Payment_Method_Manager::register_payment_methods has already been called,
+		// then we need to add our caps for this payment method manually
+		if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
+			$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			// register payment methods directly
+			foreach (self::$_settings[ $addon_name ]['payment_method_paths'] as $payment_method_path) {
+				$payment_method_manager->register_payment_method($payment_method_path);
+			}
+			$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+			$capabilities->addCaps(
+				self::getPaymentMethodCapabilities(self::$_settings[ $addon_name ])
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Filters the list of payment methods to add ours.
-     * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
-     *
-     * @param array $payment_method_folders array of paths to all payment methods that require registering
-     * @return array
-     */
-    public static function add_payment_methods(array $payment_method_folders): array
-    {
-        $payment_method_paths = [];
-        foreach (self::$_settings as $settings) {
-            $payment_method_paths[] = $settings['payment_method_paths'];
-        }
-        return array_merge($payment_method_folders, ...$payment_method_paths);
-    }
+	/**
+	 * Filters the list of payment methods to add ours.
+	 * and they're just full filepaths to FOLDERS containing a payment method class file. Eg.
+	 *
+	 * @param array $payment_method_folders array of paths to all payment methods that require registering
+	 * @return array
+	 */
+	public static function add_payment_methods(array $payment_method_folders): array
+	{
+		$payment_method_paths = [];
+		foreach (self::$_settings as $settings) {
+			$payment_method_paths[] = $settings['payment_method_paths'];
+		}
+		return array_merge($payment_method_folders, ...$payment_method_paths);
+	}
 
 
-    /**
-     * This deregisters a module that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the module that was previously registered
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (isset(self::$_settings[ $addon_name ])) {
-            // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $addon_name ];
-            unset(self::$_settings[ $addon_name ]);
-            add_action(
-                'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
-                    $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
-                    $capabilities->removeCaps(
-                        EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
-                    );
-                }
-            );
-        }
-    }
+	/**
+	 * This deregisters a module that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the module that was previously registered
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (isset(self::$_settings[ $addon_name ])) {
+			// set action for just this module id to delay deregistration until core is loaded and ready.
+			$module_settings = self::$_settings[ $addon_name ];
+			unset(self::$_settings[ $addon_name ]);
+			add_action(
+				'AHEE__EE_System__core_loaded_and_ready',
+				function () use ($module_settings) {
+					$capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
+					$capabilities->removeCaps(
+						EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)
+					);
+				}
+			);
+		}
+	}
 
 
-    /**
-     * returns an array of the caps that get added when a Payment Method is registered
-     *
-     * @param array $settings
-     * @return array
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
-     *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
-     */
-    public static function getPaymentMethodCapabilities(array $settings): array
-    {
-        $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-        $payment_method_caps    = ['administrator' => []];
-        if (isset($settings['payment_method_paths'])) {
-            foreach ($settings['payment_method_paths'] as $payment_method_path) {
-                $payment_method_caps = $payment_method_manager->addPaymentMethodCap(
-                    strtolower(basename($payment_method_path)),
-                    $payment_method_caps
-                );
-            }
-        }
-        return $payment_method_caps;
-    }
+	/**
+	 * returns an array of the caps that get added when a Payment Method is registered
+	 *
+	 * @param array $settings
+	 * @return array
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @access private  Developers do NOT use this method.  It's only public for PHP5.3 closure support (see deregister)
+	 *                  When we drop support for PHP5.3 this will be made private again.  You have been warned.
+	 */
+	public static function getPaymentMethodCapabilities(array $settings): array
+	{
+		$payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+		$payment_method_caps    = ['administrator' => []];
+		if (isset($settings['payment_method_paths'])) {
+			foreach ($settings['payment_method_paths'] as $payment_method_path) {
+				$payment_method_caps = $payment_method_manager->addPaymentMethodCap(
+					strtolower(basename($payment_method_path)),
+					$payment_method_caps
+				);
+			}
+		}
+		return $payment_method_caps;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -59,7 +59,7 @@ 
             );
         }
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
         // make sure this was called in the right place!
@@ -77,7 +77,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // array of full server paths to any EE_PMT_Base children used
             'payment_method_paths' => isset($setup_args['payment_method_paths'])
                 ? (array) $setup_args['payment_method_paths']
@@ -93,12 +93,12 @@ 
         if (did_action('FHEE__EE_Payment_Method_Manager__register_payment_methods__registered_payment_methods')) {
             $payment_method_manager = LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             // register payment methods directly
-            foreach (self::$_settings[ $addon_name ]['payment_method_paths'] as $payment_method_path) {
+            foreach (self::$_settings[$addon_name]['payment_method_paths'] as $payment_method_path) {
                 $payment_method_manager->register_payment_method($payment_method_path);
             }
             $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
             $capabilities->addCaps(
-                self::getPaymentMethodCapabilities(self::$_settings[ $addon_name ])
+                self::getPaymentMethodCapabilities(self::$_settings[$addon_name])
             );
         }
         return true;
@@ -135,13 +135,13 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             // set action for just this module id to delay deregistration until core is loaded and ready.
-            $module_settings = self::$_settings[ $addon_name ];
-            unset(self::$_settings[ $addon_name ]);
+            $module_settings = self::$_settings[$addon_name];
+            unset(self::$_settings[$addon_name]);
             add_action(
                 'AHEE__EE_System__core_loaded_and_ready',
-                function () use ($module_settings) {
+                function() use ($module_settings) {
                     $capabilities = LoaderFactory::getLoader()->getShared('EE_Capabilities');
                     $capabilities->removeCaps(
                         EE_Register_Payment_Method::getPaymentMethodCapabilities($module_settings)

core/libraries/plugin_api/EE_Register_Model_Extensions.lib.php

Indentation +120 added lines, -120 removed lines

@@ -12,132 +12,132 @@
 class EE_Register_Model_Extensions implements EEI_Plugin_API
 {
 
-    protected static $_registry;
+	protected static $_registry;
 
-    protected static $_extensions = [];
+	protected static $_extensions = [];
 
 
-    /**
-     * register method for setting up model extensions
-     *
-     * @param string $addon_name            unique id for the extensions being setup
-     * @param array  $setup_args            {
-     * @return bool
-     * @throws EE_Error
-     * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
-     *                                      the models naming convention, which is:
-     *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something having
-     *                                      to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      model_name_extended} is the model extended.
-     *                                      The class contained in teh file should extend
-     *                                      EEME_Base_{model_name_extended}.model_ext.php.
-     *                                      Where {your_plugin_slug} is really anything you want (but something
-     *                                      having to do with your addon, like 'Calendar' or '3D_View') and
-     *                                      {model_name_extended} is the model extended. The class contained in teh
-     *                                      file should extend EEME_Base
-     * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
-     *                                      the model class extension naming convention, which is:
-     *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc.
-     *                                      The class contained in the file should extend EEE_Base_Class
-     *                                      ._{model_name_extended}.class_ext.php.
-     *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
-     *                                      and {model_name_extended} is the name of the model extended, eg
-     *                                      'Attendee','Event',etc. The class contained in the file should extend
-     *                                      EEE_Base_Class.
-     *                                      }
-     *
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name)
-            || ! is_array($setup_args)
-            || (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
-        ) {
-            throw new EE_Error(
-                __(
-                    'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * register method for setting up model extensions
+	 *
+	 * @param string $addon_name            unique id for the extensions being setup
+	 * @param array  $setup_args            {
+	 * @return bool
+	 * @throws EE_Error
+	 * @type  array  $model_extension_paths array of folders containing DB model extensions, where each file follows
+	 *                                      the models naming convention, which is:
+	 *                                      EEME_{your_plugin_slug}_model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something having
+	 *                                      to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      model_name_extended} is the model extended.
+	 *                                      The class contained in teh file should extend
+	 *                                      EEME_Base_{model_name_extended}.model_ext.php.
+	 *                                      Where {your_plugin_slug} is really anything you want (but something
+	 *                                      having to do with your addon, like 'Calendar' or '3D_View') and
+	 *                                      {model_name_extended} is the model extended. The class contained in teh
+	 *                                      file should extend EEME_Base
+	 * @type array   $class_extension_paths array of folders containing DB class extensions, where each file follows
+	 *                                      the model class extension naming convention, which is:
+	 *                                      EEE_{your_plugin_slug}_model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc.
+	 *                                      The class contained in the file should extend EEE_Base_Class
+	 *                                      ._{model_name_extended}.class_ext.php.
+	 *                                      Where {your_plugin_slug} is something like 'Calendar','MailChimp',etc,
+	 *                                      and {model_name_extended} is the name of the model extended, eg
+	 *                                      'Attendee','Event',etc. The class contained in the file should extend
+	 *                                      EEE_Base_Class.
+	 *                                      }
+	 *
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name)
+			|| ! is_array($setup_args)
+			|| (empty($setup_args['model_extension_paths']) && empty($setup_args['class_extension_paths']))
+		) {
+			throw new EE_Error(
+				__(
+					'In order to register Model extensions with EE_Register_Model_Extensions::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_extension_paths" (an array of full server paths to folders that contain model extensions), and "class_extension_paths" (an array of full server paths to folders that contain class extensions)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
-        // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    '<br />',
-                    did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
-                    did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
-                ),
-                '4.3'
-            );
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
+		// check correct loading
+		if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt was made to register "%1$s" as a Model extension has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.%2$s Hook Status: %2$s "AHEE__EE_System__load_espresso_addons" : %3$s %2$s "AHEE__EE_Admin__loaded" : %4$s%2$s',
+						'event_espresso'
+					),
+					$addon_name,
+					'<br />',
+					did_action('AHEE__EE_System__load_espresso_addons') ? 'action done' : 'action NOT done',
+					did_action('AHEE__EE_Admin__loaded') ? 'action done' : 'action NOT done'
+				),
+				'4.3'
+			);
+		}
 
-        self::$_registry[ $addon_name ]   = $setup_args;
-        self::$_extensions[ $addon_name ] = [];
+		self::$_registry[ $addon_name ]   = $setup_args;
+		self::$_extensions[ $addon_name ] = [];
 
-        if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
-            // remove all files that are not PHP
-            foreach ($class_to_filepath_map as $class => $path) {
-                if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
-                }
-            }
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname;
-            }
-            unset($setup_args['model_extension_paths']);
-        }
-        if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname;
-            }
-            unset($setup_args['class_extension_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            throw new EE_Error(
-                sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-        return true;
-    }
+		if (isset($setup_args['model_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
+			// remove all files that are not PHP
+			foreach ($class_to_filepath_map as $class => $path) {
+				if (substr($path, strlen($path) - 3) !== 'php') {
+					unset($class_to_filepath_map[ $class ]);
+				}
+			}
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname;
+			}
+			unset($setup_args['model_extension_paths']);
+		}
+		if (isset($setup_args['class_extension_paths'])) {
+			require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname;
+			}
+			unset($setup_args['class_extension_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			throw new EE_Error(
+				sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        if (isset(self::$_registry[ $addon_name ])) {
-            unset(self::$_registry[ $addon_name ]);
-            foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
-                foreach ($extension_of_type as $extension) {
-                    $extension->deregister();
-                }
-            }
-        }
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		if (isset(self::$_registry[ $addon_name ])) {
+			unset(self::$_registry[ $addon_name ]);
+			foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
+				foreach ($extension_of_type as $extension) {
+					$extension->deregister();
+				}
+			}
+		}
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -67,11 +67,11 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
         // check correct loading
-        if (! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons') || did_action('AHEE__EE_Admin__loaded')) {
             EE_Error::doing_it_wrong(
                 __METHOD__,
                 sprintf(
@@ -88,30 +88,30 @@ 
             );
         }
 
-        self::$_registry[ $addon_name ]   = $setup_args;
-        self::$_extensions[ $addon_name ] = [];
+        self::$_registry[$addon_name]   = $setup_args;
+        self::$_extensions[$addon_name] = [];
 
         if (isset($setup_args['model_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEME_Base.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEME_Base.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_extension_paths']);
             // remove all files that are not PHP
             foreach ($class_to_filepath_map as $class => $path) {
                 if (substr($path, strlen($path) - 3) !== 'php') {
-                    unset($class_to_filepath_map[ $class ]);
+                    unset($class_to_filepath_map[$class]);
                 }
             }
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['models'][ $classname ] = new $classname;
+                self::$_extensions[$addon_name]['models'][$classname] = new $classname;
             }
             unset($setup_args['model_extension_paths']);
         }
         if (isset($setup_args['class_extension_paths'])) {
-            require_once(EE_LIBRARIES . 'plugin_api/db/EEE_Base_Class.lib.php');
+            require_once(EE_LIBRARIES.'plugin_api/db/EEE_Base_Class.lib.php');
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_extension_paths']);
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                self::$_extensions[ $addon_name ]['classes'][ $classname ] = new $classname;
+                self::$_extensions[$addon_name]['classes'][$classname] = new $classname;
             }
             unset($setup_args['class_extension_paths']);
         }
@@ -131,9 +131,9 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        if (isset(self::$_registry[ $addon_name ])) {
-            unset(self::$_registry[ $addon_name ]);
-            foreach (self::$_extensions[ $addon_name ] as $extension_of_type) {
+        if (isset(self::$_registry[$addon_name])) {
+            unset(self::$_registry[$addon_name]);
+            foreach (self::$_extensions[$addon_name] as $extension_of_type) {
                 foreach ($extension_of_type as $extension) {
                     $extension->deregister();
                 }

core/libraries/plugin_api/EE_Register_Shortcode.lib.php

Indentation +146 added lines, -146 removed lines

@@ -20,161 +20,161 @@
 class EE_Register_Shortcode implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered shortcodes
-     *
-     * @var array
-     */
-    protected static $_settings = [];
+	/**
+	 * Holds values for registered shortcodes
+	 *
+	 * @var array
+	 */
+	protected static $_settings = [];
 
 
-    /**
-     *    Method for registering new EE_Shortcodes
-     *
-     * @param string $addon_name    a unique identifier for this set of modules Required.
-     * @param array  $setup_args    an array of arguments provided for registering shortcodes Required.
-     * @type array shortcode_paths  an array of full server paths to folders containing any EES_Shortcodes
-     * @type array shortcode_fqcns  an array of fully qualified class names for any new shortcode classes to register.
-     *                              Shortcode classes should extend EspressoShortcode
-     *                              and be properly namespaced so they are autoloaded.
-     * @return bool
-     * @throws EE_Error
-     * @since    4.3.0
-     * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name)
-            || ! is_array($setup_args)
-            || (
-               empty($setup_args['shortcode_paths']))
-               && empty($setup_args['shortcode_fqcns'])
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register Modules with EE_Register_Shortcode::register(), you must include a "shortcode_id" (a unique identifier for this set of shortcodes), and an array containing the following keys: "shortcode_paths" (an array of full server paths to folders that contain shortcodes, or to the shortcode files themselves)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 *    Method for registering new EE_Shortcodes
+	 *
+	 * @param string $addon_name    a unique identifier for this set of modules Required.
+	 * @param array  $setup_args    an array of arguments provided for registering shortcodes Required.
+	 * @type array shortcode_paths  an array of full server paths to folders containing any EES_Shortcodes
+	 * @type array shortcode_fqcns  an array of fully qualified class names for any new shortcode classes to register.
+	 *                              Shortcode classes should extend EspressoShortcode
+	 *                              and be properly namespaced so they are autoloaded.
+	 * @return bool
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 * @since    4.9.46.rc.025  for the new `shortcode_fqcns` array argument.
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name)
+			|| ! is_array($setup_args)
+			|| (
+			   empty($setup_args['shortcode_paths']))
+			   && empty($setup_args['shortcode_fqcns'])
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register Modules with EE_Register_Shortcode::register(), you must include a "shortcode_id" (a unique identifier for this set of shortcodes), and an array containing the following keys: "shortcode_paths" (an array of full server paths to folders that contain shortcodes, or to the shortcode files themselves)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_settings[ $addon_name ])) {
+			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__register_shortcodes_modules_and_widgets')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                esc_html__(
-                    'An attempt to register shortcodes has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register shortcodes.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
-            // array of full server paths to any EES_Shortcodes used by the shortcode
-            'shortcode_paths' => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : [],
-            'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : [],
-        ];
-        // add to list of shortcodes to be registered
-        add_filter(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            ['EE_Register_Shortcode', 'add_shortcodes']
-        );
+		// make sure this was called in the right place!
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System__register_shortcodes_modules_and_widgets')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				esc_html__(
+					'An attempt to register shortcodes has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__register_shortcodes_modules_and_widgets" hook to register shortcodes.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		// setup $_settings array from incoming values.
+		self::$_settings[ $addon_name ] = [
+			// array of full server paths to any EES_Shortcodes used by the shortcode
+			'shortcode_paths' => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: [],
+			'shortcode_fqcns' => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: [],
+		];
+		// add to list of shortcodes to be registered
+		add_filter(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			['EE_Register_Shortcode', 'add_shortcodes']
+		);
 
-        add_filter(
-            'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
-            ['EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection']
-        );
-        return true;
-    }
+		add_filter(
+			'FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection',
+			['EE_Register_Shortcode', 'instantiateAndAddToShortcodeCollection']
+		);
+		return true;
+	}
 
 
-    /**
-     * Filters the list of shortcodes to add ours.
-     * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
-     * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
-     *
-     * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
-     * @return array
-     */
-    public static function add_shortcodes(array $shortcodes_to_register): array
-    {
-        $shortcode_paths = [];
-        foreach (self::$_settings as $settings) {
-            $shortcode_paths[] = $settings['shortcode_paths'];
-        }
-        return array_merge($shortcodes_to_register, ...$shortcode_paths);
-    }
+	/**
+	 * Filters the list of shortcodes to add ours.
+	 * and they're just full filepaths to FOLDERS containing a shortcode class file. Eg.
+	 * array('espresso_monkey'=>'/public_html/wonder-site/wp-content/plugins/ee4/shortcodes/espresso_monkey'...)
+	 *
+	 * @param array $shortcodes_to_register array of paths to all shortcodes that require registering
+	 * @return array
+	 */
+	public static function add_shortcodes(array $shortcodes_to_register): array
+	{
+		$shortcode_paths = [];
+		foreach (self::$_settings as $settings) {
+			$shortcode_paths[] = $settings['shortcode_paths'];
+		}
+		return array_merge($shortcodes_to_register, ...$shortcode_paths);
+	}
 
 
-    /**
-     * Hooks into
-     * FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection and
-     * registers any provided shortcode fully qualified class names.
-     *
-     * @param CollectionInterface $shortcodes_collection
-     * @return CollectionInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function instantiateAndAddToShortcodeCollection(
-        CollectionInterface $shortcodes_collection
-    ): CollectionInterface {
-        foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
-                foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
-                        throw new InvalidClassException(
-                            sprintf(
-                                esc_html__(
-                                    'Are you sure %s is the right fully qualified class name for the shortcode class?',
-                                    'event_espresso'
-                                ),
-                                $shortcode_fqcn
-                            )
-                        );
-                    }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
-                        // register dependencies
-                        EE_Dependency_Map::register_dependencies(
-                            $shortcode_fqcn,
-                            [
-                                'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
-                            ]
-                        );
-                    }
-                    $shortcodes_collection->add(LoaderFactory::getLoader()->getShared($shortcode_fqcn));
-                }
-            }
-        }
-        return $shortcodes_collection;
-    }
+	/**
+	 * Hooks into
+	 * FHEE__EventEspresso_core_services_shortcodes_ShortcodesManager__registerShortcodes__shortcode_collection and
+	 * registers any provided shortcode fully qualified class names.
+	 *
+	 * @param CollectionInterface $shortcodes_collection
+	 * @return CollectionInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function instantiateAndAddToShortcodeCollection(
+		CollectionInterface $shortcodes_collection
+	): CollectionInterface {
+		foreach (self::$_settings as $settings) {
+			if (! empty($settings['shortcode_fqcns'])) {
+				foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
+					if (! class_exists($shortcode_fqcn)) {
+						throw new InvalidClassException(
+							sprintf(
+								esc_html__(
+									'Are you sure %s is the right fully qualified class name for the shortcode class?',
+									'event_espresso'
+								),
+								$shortcode_fqcn
+							)
+						);
+					}
+					if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
+						// register dependencies
+						EE_Dependency_Map::register_dependencies(
+							$shortcode_fqcn,
+							[
+								'EventEspresso\core\services\cache\PostRelatedCacheManager' => EE_Dependency_Map::load_from_cache,
+							]
+						);
+					}
+					$shortcodes_collection->add(LoaderFactory::getLoader()->getShared($shortcode_fqcn));
+				}
+			}
+		}
+		return $shortcodes_collection;
+	}
 
 
-    /**
-     * This deregisters a shortcode that was previously registered with a specific $addon_name.
-     *
-     * @param string $addon_name the name for the shortcode that was previously registered
-     * @return void
-     * @since    4.3.0
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_settings[ $addon_name ]);
-    }
+	/**
+	 * This deregisters a shortcode that was previously registered with a specific $addon_name.
+	 *
+	 * @param string $addon_name the name for the shortcode that was previously registered
+	 * @return void
+	 * @since    4.3.0
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_settings[ $addon_name ]);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -60,7 +60,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_settings[ $addon_name ])) {
+        if (isset(self::$_settings[$addon_name])) {
             return true;
         }
 
@@ -79,7 +79,7 @@ 
             );
         }
         // setup $_settings array from incoming values.
-        self::$_settings[ $addon_name ] = [
+        self::$_settings[$addon_name] = [
             // array of full server paths to any EES_Shortcodes used by the shortcode
             'shortcode_paths' => isset($setup_args['shortcode_paths'])
                 ? (array) $setup_args['shortcode_paths']
@@ -136,9 +136,9 @@ 
         CollectionInterface $shortcodes_collection
     ): CollectionInterface {
         foreach (self::$_settings as $settings) {
-            if (! empty($settings['shortcode_fqcns'])) {
+            if ( ! empty($settings['shortcode_fqcns'])) {
                 foreach ($settings['shortcode_fqcns'] as $shortcode_fqcn) {
-                    if (! class_exists($shortcode_fqcn)) {
+                    if ( ! class_exists($shortcode_fqcn)) {
                         throw new InvalidClassException(
                             sprintf(
                                 esc_html__(
@@ -149,7 +149,7 @@ 
                             )
                         );
                     }
-                    if (! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
+                    if ( ! EE_Dependency_Map::instance()->has_dependency_for_class($shortcode_fqcn)) {
                         // register dependencies
                         EE_Dependency_Map::register_dependencies(
                             $shortcode_fqcn,
@@ -175,6 +175,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_settings[ $addon_name ]);
+        unset(self::$_settings[$addon_name]);
     }
 }

core/libraries/plugin_api/EEI_Plugin_API.lib.php

Indentation +17 added lines, -17 removed lines

@@ -18,23 +18,23 @@
 interface EEI_Plugin_API
 {
 
-    /**
-     * Used to register a component with EE.
-     *
-     * @param string $addon_name a unique name for the component being registered
-     * @param array  $setup_args an array of key value pairs of info for registering the component
-     * @return bool
-     * @since 4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool;
+	/**
+	 * Used to register a component with EE.
+	 *
+	 * @param string $addon_name a unique name for the component being registered
+	 * @param array  $setup_args an array of key value pairs of info for registering the component
+	 * @return bool
+	 * @since 4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool;
 
 
-    /**
-     * Used to deregister a component with EE.
-     *
-     * @param string $addon_name a unique name for the component being registered
-     * @return void
-     * @since 4.3.0
-     */
-    public static function deregister(string $addon_name = '');
+	/**
+	 * Used to deregister a component with EE.
+	 *
+	 * @param string $addon_name a unique name for the component being registered
+	 * @return void
+	 * @since 4.3.0
+	 */
+	public static function deregister(string $addon_name = '');
 }

core/libraries/plugin_api/EE_Register_Messages_Template_Pack.lib.php

Indentation +198 added lines, -198 removed lines

@@ -12,202 +12,202 @@
 {
 
 
-    /**
-     * Holds values for registered template pack
-     *
-     * @since 4.5.0
-     *
-     * @var array
-     */
-    protected static $_registry = [];
-
-
-    /**
-     * Used to register a new template pack with the messages system.
-     *
-     * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
-     * change entire layouts for a set of message templates.  This method is used to register the new template pack and
-     * automatically have it loaded in the appropriate places.
-     *
-     * This registry also verifies that there isn't already a template pack registered with the same name and if there
-     * is then it will add an EE_Error notice.
-     *
-     * Note that this only handles registering the your Template Pack class with the message template pack system.
-     * However, there is also a naming schema you must follow for templates you are providing with your template pack.
-     *
-     * @param string $addon_name The internal reference used to refer to this template pack.  Note, this is first come,
-     *                           first serve.  If there is already a template pack registered with this name then the
-     *                           registry will assign a unique reference for it so it can still be activated (but this
-     *                           makes it harder to deregister as it will be unique per load - so its best to try to
-     *                           make this a unique string!)
-     * @param array  $setup_args array {
-     *                           An array of required values for registering the template pack.
-     * @type string  $path       The path for the new template pack class.
-     * @type string  $classname  The name of the new Template Pack Class.
-     *                           }
-     * @return bool
-     * @throws EE_Error
-     *
-     * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
-     *         supports.
-     *
-     *
-     * @since  4.5.0
-     * @see    EE_Messages_Template_Pack_Default for an example class
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-
-        // check for required params
-        if (empty($addon_name) || empty($setup_args['path']) || empty($setup_args['classname'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
-
-        // check that incoming $addon_name doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
-        }
-
-
-        // make sure this was called in the right place!
-        if (
-            ! did_action('EE_Brewing_Regular___messages_caf')
-            || did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.5.0'
-            );
-        }
-
-        if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $addon_name ] = [
-                'path'      => (string) $setup_args['path'],
-                'classname' => (string) $setup_args['classname'],
-            ];
-        }
-
-        // hook into the system
-        add_filter(
-            'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
-            ['EE_Register_Messages_Template_Pack', 'set_template_pack_path'],
-            10
-        );
-        add_filter(
-            'FHEE__EED_Messages__get_template_packs__template_packs',
-            ['EE_Register_Messages_Template_Pack', 'set_template_pack'],
-            10
-        );
-        return true;
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
-     * to the messages autoloader paths.
-     *
-     * @param array $paths Array of paths already registered with the messages autoloader
-     *
-     * @return array
-     * @since  4.5.0
-     *
-     */
-    public static function set_template_pack_path(array $paths): array
-    {
-        foreach (self::$_registry as $args) {
-            $paths[] = $args['path'];
-        }
-        return $paths;
-    }
-
-
-    /**
-     * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
-     * registered template pack to the template packs array when requested by client code.
-     *
-     * @param EE_Messages_Template_Pack[] $template_packs
-     * @return EE_Messages_Template_Pack[]
-     * @since 4.5.0
-     *
-     */
-    public static function set_template_pack(array $template_packs): array
-    {
-        foreach (self::$_registry as $args) {
-            // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
-            }
-
-            // check again!
-            if (class_exists($args['classname'])) {
-                $template_pack                           = new $args['classname'];
-                $template_packs[ $template_pack->dbref ] = $template_pack;
-            }
-        }
-
-        return $template_packs;
-    }
-
-
-    /**
-     * This verifies that the classes for each registered template pack are unique  names.
-     *
-     * @param string $classname The classname being checked
-     *
-     * @return bool
-     */
-    private static function _verify_class_not_exist(string $classname): bool
-    {
-        // loop through the existing registry and see if the classname is already present.
-        foreach (self::$_registry as $args) {
-            if ($args['classname'] == $classname) {
-                EE_Error::add_error(
-                    sprintf(
-                        __(
-                            'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
-                            'event_espresso'
-                        ),
-                        $classname
-                    ),
-                    __FILE__,
-                    __LINE__,
-                    __FUNCTION__
-                );
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This deregisters a variation set that was previously registered with the given slug.
-     *
-     * @param string $addon_name The name for the variation set that was previously registered.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_registry[ $addon_name ]);
-    }
+	/**
+	 * Holds values for registered template pack
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array
+	 */
+	protected static $_registry = [];
+
+
+	/**
+	 * Used to register a new template pack with the messages system.
+	 *
+	 * Template packs are primarily defined via class extending EE_Messages_Template_Pack and are typically used to
+	 * change entire layouts for a set of message templates.  This method is used to register the new template pack and
+	 * automatically have it loaded in the appropriate places.
+	 *
+	 * This registry also verifies that there isn't already a template pack registered with the same name and if there
+	 * is then it will add an EE_Error notice.
+	 *
+	 * Note that this only handles registering the your Template Pack class with the message template pack system.
+	 * However, there is also a naming schema you must follow for templates you are providing with your template pack.
+	 *
+	 * @param string $addon_name The internal reference used to refer to this template pack.  Note, this is first come,
+	 *                           first serve.  If there is already a template pack registered with this name then the
+	 *                           registry will assign a unique reference for it so it can still be activated (but this
+	 *                           makes it harder to deregister as it will be unique per load - so its best to try to
+	 *                           make this a unique string!)
+	 * @param array  $setup_args array {
+	 *                           An array of required values for registering the template pack.
+	 * @type string  $path       The path for the new template pack class.
+	 * @type string  $classname  The name of the new Template Pack Class.
+	 *                           }
+	 * @return bool
+	 * @throws EE_Error
+	 *
+	 * @see    core/libraries/messages/defaults/default/* for all the example templates the default template pack
+	 *         supports.
+	 *
+	 *
+	 * @since  4.5.0
+	 * @see    EE_Messages_Template_Pack_Default for an example class
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+
+		// check for required params
+		if (empty($addon_name) || empty($setup_args['path']) || empty($setup_args['classname'])) {
+			throw new EE_Error(
+				__(
+					'In order to register a new template pack for the EE Messages system, you must include a value to reference the template pack being registered and the setup_args must have the path for the new template pack class as well as the classname for the new Template Pack Class. ',
+					'event_espresso'
+				)
+			);
+		}
+
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
+
+		// check that incoming $addon_name doesn't already exist. If it does then we'll create a unique reference for this template pack.
+		if (isset(self::$_registry[ $addon_name ])) {
+			$addon_name = uniqid() . '_' . $addon_name;
+		}
+
+
+		// make sure this was called in the right place!
+		if (
+			! did_action('EE_Brewing_Regular___messages_caf')
+			|| did_action('AHEE__EE_System__perform_activations_upgrades_and_migrations')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'A EE Messages Template Pack given the reference "%s" has been attempted to be registered with the EE Messages System.  It may or may not work because it should be only called on the "EE_Brewing_Regular__messages_caf" hook.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.5.0'
+			);
+		}
+
+		if (self::_verify_class_not_exist($setup_args['classname'])) {
+			self::$_registry[ $addon_name ] = [
+				'path'      => (string) $setup_args['path'],
+				'classname' => (string) $setup_args['classname'],
+			];
+		}
+
+		// hook into the system
+		add_filter(
+			'FHEE__EED_Messages___set_messages_paths___MSG_PATHS',
+			['EE_Register_Messages_Template_Pack', 'set_template_pack_path'],
+			10
+		);
+		add_filter(
+			'FHEE__EED_Messages__get_template_packs__template_packs',
+			['EE_Register_Messages_Template_Pack', 'set_template_pack'],
+			10
+		);
+		return true;
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages___set_messages_paths___MSG_PATHS filter.  This adds this template packs path
+	 * to the messages autoloader paths.
+	 *
+	 * @param array $paths Array of paths already registered with the messages autoloader
+	 *
+	 * @return array
+	 * @since  4.5.0
+	 *
+	 */
+	public static function set_template_pack_path(array $paths): array
+	{
+		foreach (self::$_registry as $args) {
+			$paths[] = $args['path'];
+		}
+		return $paths;
+	}
+
+
+	/**
+	 * Callback for the FHEE__EED_Messages__get_template_packs__template_packs filter. This adds the instantiated,
+	 * registered template pack to the template packs array when requested by client code.
+	 *
+	 * @param EE_Messages_Template_Pack[] $template_packs
+	 * @return EE_Messages_Template_Pack[]
+	 * @since 4.5.0
+	 *
+	 */
+	public static function set_template_pack(array $template_packs): array
+	{
+		foreach (self::$_registry as $args) {
+			// verify class_exists
+			if (! class_exists($args['classname'])) {
+				require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+			}
+
+			// check again!
+			if (class_exists($args['classname'])) {
+				$template_pack                           = new $args['classname'];
+				$template_packs[ $template_pack->dbref ] = $template_pack;
+			}
+		}
+
+		return $template_packs;
+	}
+
+
+	/**
+	 * This verifies that the classes for each registered template pack are unique  names.
+	 *
+	 * @param string $classname The classname being checked
+	 *
+	 * @return bool
+	 */
+	private static function _verify_class_not_exist(string $classname): bool
+	{
+		// loop through the existing registry and see if the classname is already present.
+		foreach (self::$_registry as $args) {
+			if ($args['classname'] == $classname) {
+				EE_Error::add_error(
+					sprintf(
+						__(
+							'The %s template pack that you just activated cannot be registered with the messages system because there is already a template pack active using the same classname.  Contact the author of this template pack to let them know of the conflict.  To stop seeing this message you will need to deactivate this template pack.',
+							'event_espresso'
+						),
+						$classname
+					),
+					__FILE__,
+					__LINE__,
+					__FUNCTION__
+				);
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This deregisters a variation set that was previously registered with the given slug.
+	 *
+	 * @param string $addon_name The name for the variation set that was previously registered.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_registry[ $addon_name ]);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -69,13 +69,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
 
         // check that incoming $addon_name doesn't already exist. If it does then we'll create a unique reference for this template pack.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
+        if (isset(self::$_registry[$addon_name])) {
+            $addon_name = uniqid().'_'.$addon_name;
         }
 
 
@@ -98,7 +98,7 @@ 
         }
 
         if (self::_verify_class_not_exist($setup_args['classname'])) {
-            self::$_registry[ $addon_name ] = [
+            self::$_registry[$addon_name] = [
                 'path'      => (string) $setup_args['path'],
                 'classname' => (string) $setup_args['classname'],
             ];
@@ -151,14 +151,14 @@ 
     {
         foreach (self::$_registry as $args) {
             // verify class_exists
-            if (! class_exists($args['classname'])) {
-                require_once($args['path'] . '/' . $args['classname'] . '.class.php');
+            if ( ! class_exists($args['classname'])) {
+                require_once($args['path'].'/'.$args['classname'].'.class.php');
             }
 
             // check again!
             if (class_exists($args['classname'])) {
                 $template_pack                           = new $args['classname'];
-                $template_packs[ $template_pack->dbref ] = $template_pack;
+                $template_packs[$template_pack->dbref] = $template_pack;
             }
         }
 
@@ -208,6 +208,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_registry[ $addon_name ]);
+        unset(self::$_registry[$addon_name]);
     }
 }

core/libraries/plugin_api/EE_Register_Config.lib.php

Indentation +103 added lines, -103 removed lines

@@ -12,119 +12,119 @@
 class EE_Register_Config implements EEI_Plugin_API
 {
 
-    /**
-     * Holds registered EE_Config items
-     *
-     * @var array
-     */
-    protected static $_ee_config_registry = [];
+	/**
+	 * Holds registered EE_Config items
+	 *
+	 * @var array
+	 */
+	protected static $_ee_config_registry = [];
 
 
-    /**
-     * Handles registering the new config with the EE_Config::instance()->addons property
-     *
-     * @param string $addon_name    The name of the Config class being registered.
-     *                              Note this class must extend EE_Config Base and must have
-     *                              already been registered with an autoloader.
-     * @param array  $setup_args    {
-     *
-     * @type  string $config_name       Optional.  by default the new config will be registered to
-     *                                  EE_Config::instance()->addons->{config_class},
-     *                                  but supplying a "config_name" will set the property name
-     *                                  that this variable is accessible by.
-     *                                  ie: EE_Config::instance()->addons->{config_name}
-     *                              }
-     * @return bool
-     * @throws EE_Error
-     *
-     * @since    4.3.0
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 * Handles registering the new config with the EE_Config::instance()->addons property
+	 *
+	 * @param string $addon_name    The name of the Config class being registered.
+	 *                              Note this class must extend EE_Config Base and must have
+	 *                              already been registered with an autoloader.
+	 * @param array  $setup_args    {
+	 *
+	 * @type  string $config_name       Optional.  by default the new config will be registered to
+	 *                                  EE_Config::instance()->addons->{config_class},
+	 *                                  but supplying a "config_name" will set the property name
+	 *                                  that this variable is accessible by.
+	 *                                  ie: EE_Config::instance()->addons->{config_name}
+	 *                              }
+	 * @return bool
+	 * @throws EE_Error
+	 *
+	 * @since    4.3.0
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        $setup_args['config_name']    = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
-            ? $setup_args['config_name'] : $addon_name;
-        $setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
-            ? $setup_args['config_section'] : 'addons';
+		$setup_args['config_name']    = isset($setup_args['config_name']) && ! empty($setup_args['config_name'])
+			? $setup_args['config_name'] : $addon_name;
+		$setup_args['config_section'] = isset($setup_args['config_section']) && ! empty($setup_args['config_section'])
+			? $setup_args['config_section'] : 'addons';
 
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
-                    'event_espresso'
-                )
-            );
-        }
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['config_name'])) {
+			throw new EE_Error(
+				__(
+					'In order to register a Config Class with EE_Register_Config::register(), you must include a "config_class" (the actual class name for this config class). As well, you can supply an array containing the following keys: "config_section" the main section of the config object the settings will be saved under (by default the new config will be registered under EE_Config::instance()->modules or EE_Config::instance()->addons depending on what type of class is calling this), "config_name" (by default the new config will be registered to EE_Config::instance()->{config_section}->{config_class}, but supplying a "config_name" will set the property name that this variable is accessible by. ie: EE_Config::instance()->{config_section}->{config_name})',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_ee_config_registry[ $addon_name ])) {
+			return true;
+		}
 
 
-        // first find out if this happened too late.
-        if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
-                        'event_espresso'
-                    ),
-                    $setup_args['config_name']
-                ),
-                '4.3'
-            );
-        }
-        // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $addon_name ] = [
-            'section' => $setup_args['config_section'],
-            'name'    => $setup_args['config_name'],
-        ];
+		// first find out if this happened too late.
+		if (did_action('AHEE__EE_System__load_core_configuration__begin')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt to register "%s" as an EE_Config object has failed because it was not registered at the correct hookpoint.  Please register before the "AHEE__EE_System__load_core_configuration__begin" hook has fired',
+						'event_espresso'
+					),
+					$setup_args['config_name']
+				),
+				'4.3'
+			);
+		}
+		// add incoming stuff to our registry property
+		self::$_ee_config_registry[ $addon_name ] = [
+			'section' => $setup_args['config_section'],
+			'name'    => $setup_args['config_name'],
+		];
 
-        add_action('AHEE__EE_Config___load_core_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
-        add_action('AHEE__EE_Config__update_espresso_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
-        return true;
-    }
+		add_action('AHEE__EE_Config___load_core_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
+		add_action('AHEE__EE_Config__update_espresso_config__end', ['EE_Register_Config', 'set_config'], 15, 1);
+		return true;
+	}
 
 
-    /**
-     * Callback for the AHEE__EE_Config___load_core_config__end hook.
-     * basically just calls EE_Config->get_config()
-     * which will take care of loading or creating our config object for us
-     *
-     * @param EE_Config $EE_Config
-     * @return void
-     * @throws EE_Error
-     * @since    4.3.0
-     */
-    public static function set_config(EE_Config $EE_Config)
-    {
-        foreach (self::$_ee_config_registry as $addon_name => $settings) {
-            // first some validation of our incoming class_name.
-            //  We'll throw an error early if its' not registered correctly
-            if (! class_exists($addon_name)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
-                            'event_espresso'
-                        ),
-                        $addon_name
-                    )
-                );
-            }
-            $EE_Config->get_config($settings['section'], $settings['name'], $addon_name);
-        }
-    }
+	/**
+	 * Callback for the AHEE__EE_Config___load_core_config__end hook.
+	 * basically just calls EE_Config->get_config()
+	 * which will take care of loading or creating our config object for us
+	 *
+	 * @param EE_Config $EE_Config
+	 * @return void
+	 * @throws EE_Error
+	 * @since    4.3.0
+	 */
+	public static function set_config(EE_Config $EE_Config)
+	{
+		foreach (self::$_ee_config_registry as $addon_name => $settings) {
+			// first some validation of our incoming class_name.
+			//  We'll throw an error early if its' not registered correctly
+			if (! class_exists($addon_name)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The "%s" config class can not be registered with EE_Config because it does not exist.  Verify that an autoloader has been set for this class',
+							'event_espresso'
+						),
+						$addon_name
+					)
+				);
+			}
+			$EE_Config->get_config($settings['section'], $settings['name'], $addon_name);
+		}
+	}
 
 
-    /**
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_ee_config_registry[ $addon_name ]);
-    }
+	/**
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_ee_config_registry[ $addon_name ]);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -58,7 +58,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_ee_config_registry[ $addon_name ])) {
+        if (isset(self::$_ee_config_registry[$addon_name])) {
             return true;
         }
 
@@ -78,7 +78,7 @@ 
             );
         }
         // add incoming stuff to our registry property
-        self::$_ee_config_registry[ $addon_name ] = [
+        self::$_ee_config_registry[$addon_name] = [
             'section' => $setup_args['config_section'],
             'name'    => $setup_args['config_name'],
         ];
@@ -104,7 +104,7 @@ 
         foreach (self::$_ee_config_registry as $addon_name => $settings) {
             // first some validation of our incoming class_name.
             //  We'll throw an error early if its' not registered correctly
-            if (! class_exists($addon_name)) {
+            if ( ! class_exists($addon_name)) {
                 throw new EE_Error(
                     sprintf(
                         __(
@@ -125,6 +125,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_ee_config_registry[ $addon_name ]);
+        unset(self::$_ee_config_registry[$addon_name]);
     }
 }

core/libraries/plugin_api/EE_Register_CPT.lib.php

Indentation +229 added lines, -229 removed lines

@@ -13,256 +13,256 @@
 class EE_Register_CPT implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered variations
-     *
-     * @since 4.5.0
-     *
-     * @var array[][][]
-     */
-    protected static $_registry = [];
+	/**
+	 * Holds values for registered variations
+	 *
+	 * @since 4.5.0
+	 *
+	 * @var array[][][]
+	 */
+	protected static $_registry = [];
 
 
-    /**
-     * Used to register new CPTs and Taxonomies.
-     *
-     * @param string $addon_name              reference used for the addon registering cpts and cts
-     * @param array  $setup_args              {
-     *                                        An array of required values for registering the cpts and taxonomies
-     * @type array   $cpts                    {
-     *                                        An array of cpts and their arguments.(short example below)
-     * @return bool
-     * @throws  EE_Error
-     * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
-     *                                        'people' => array(
-     *                                        'singular_name' => __('People', 'event_espresso'),
-     *                                        'plural_name' => __('People', 'event_espresso'),
-     *                                        'singular_slug' => __('people', 'event_espresso'),
-     *                                        'plural_slug' => __('peoples', 'event_espresso'),
-     *                                        'class_name' => 'EE_People'
-     *                                        )
-     *                                        },
-     * @type array   $cts                     {
-     *                                        An array of custom taxonomies and their arguments (short example below).
-     * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example.
-     *                                        'espresso_people_type' => array(
-     *                                        'singular_name' => __('People Type', 'event_espresso'),
-     *                                        'plural_name' => __('People Types', 'event_espresso'),
-     *                                        'args' => array()
-     *                                        )
-     *                                        },
-     * @type array   $default_terms           {
-     *                                        An array of terms to set as the default for a given taxonomy and the
-     *                                        custom post types applied to.
-     *                                        'taxonomy_name' => array(
-     *                                        'term' => array( 'cpt_a_name', 'cpt_b_name' )
-     *                                        )
-     *                                        }
-     *                                        }
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
+	/**
+	 * Used to register new CPTs and Taxonomies.
+	 *
+	 * @param string $addon_name              reference used for the addon registering cpts and cts
+	 * @param array  $setup_args              {
+	 *                                        An array of required values for registering the cpts and taxonomies
+	 * @type array   $cpts                    {
+	 *                                        An array of cpts and their arguments.(short example below)
+	 * @return bool
+	 * @throws  EE_Error
+	 * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
+	 *                                        'people' => array(
+	 *                                        'singular_name' => __('People', 'event_espresso'),
+	 *                                        'plural_name' => __('People', 'event_espresso'),
+	 *                                        'singular_slug' => __('people', 'event_espresso'),
+	 *                                        'plural_slug' => __('peoples', 'event_espresso'),
+	 *                                        'class_name' => 'EE_People'
+	 *                                        )
+	 *                                        },
+	 * @type array   $cts                     {
+	 *                                        An array of custom taxonomies and their arguments (short example below).
+	 * @see CustomTaxonomyDefinitions::setTaxonomies() for a more complete example.
+	 *                                        'espresso_people_type' => array(
+	 *                                        'singular_name' => __('People Type', 'event_espresso'),
+	 *                                        'plural_name' => __('People Types', 'event_espresso'),
+	 *                                        'args' => array()
+	 *                                        )
+	 *                                        },
+	 * @type array   $default_terms           {
+	 *                                        An array of terms to set as the default for a given taxonomy and the
+	 *                                        custom post types applied to.
+	 *                                        'taxonomy_name' => array(
+	 *                                        'term' => array( 'cpt_a_name', 'cpt_b_name' )
+	 *                                        )
+	 *                                        }
+	 *                                        }
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
 
-        // check for required params
-        if (empty($addon_name)) {
-            throw new EE_Error(
-                __(
-                    'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered',
-                    'event_espresso'
-                )
-            );
-        }
+		// check for required params
+		if (empty($addon_name)) {
+			throw new EE_Error(
+				__(
+					'In order to register custom post types and custom taxonomies, you must include a value to reference what had been registered',
+					'event_espresso'
+				)
+			);
+		}
 
-        if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
-            throw new EE_Error(
-                __(
-                    'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
-                    'event_espresso'
-                )
-            );
-        }
+		if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
+			throw new EE_Error(
+				__(
+					'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_registry[ $addon_name ])) {
+			return true;
+		}
 
-        // make sure cpt ref is unique.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
-        }
+		// make sure cpt ref is unique.
+		if (isset(self::$_registry[ $addon_name ])) {
+			$addon_name = uniqid() . '_' . $addon_name;
+		}
 
-        // make sure this was called in the right place!
-        if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'EE_Register_CPT has been called and given a reference of "%s".  It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.5.0'
-            );
-        }
-        // validate incoming args
-        $validated = [
-            'cpts'          => isset($setup_args['cpts'])
-                ? (array) $setup_args['cpts']
-                : [],
-            'cts'           => isset($setup_args['cts'])
-                ? (array) $setup_args['cts']
-                : [],
-            'default_terms' => isset($setup_args['default_terms'])
-                ? (array) $setup_args['default_terms']
-                : [],
-        ];
+		// make sure this was called in the right place!
+		if (did_action('AHEE__EE_System__load_CPTs_and_session__complete')) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'EE_Register_CPT has been called and given a reference of "%s".  It may or may not work because it should be called on or before "AHEE__EE_System__load_CPTs_and_session__complete" action hook.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.5.0'
+			);
+		}
+		// validate incoming args
+		$validated = [
+			'cpts'          => isset($setup_args['cpts'])
+				? (array) $setup_args['cpts']
+				: [],
+			'cts'           => isset($setup_args['cts'])
+				? (array) $setup_args['cts']
+				: [],
+			'default_terms' => isset($setup_args['default_terms'])
+				? (array) $setup_args['default_terms']
+				: [],
+		];
 
-        self::$_registry[ $addon_name ] = $validated;
+		self::$_registry[ $addon_name ] = $validated;
 
-        // hook into to cpt system
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
-            [__CLASS__, 'filterCustomPostTypeDefinitions'],
-            5
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            [__CLASS__, 'filterCustomTaxonomyDefinitions'],
-            5
-        );
-        add_action(
-            'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
-            [__CLASS__, 'registerCustomTaxonomyTerm'],
-            5
-        );
-        return true;
-    }
+		// hook into to cpt system
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
+			[__CLASS__, 'filterCustomPostTypeDefinitions'],
+			5
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			[__CLASS__, 'filterCustomTaxonomyDefinitions'],
+			5
+		);
+		add_action(
+			'AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end',
+			[__CLASS__, 'registerCustomTaxonomyTerm'],
+			5
+		);
+		return true;
+	}
 
 
-    /**
-     * Callback for
-     * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes
-     * that adds additional custom post types to be registered.
-     *
-     * @param array $custom_post_type_definitions array of cpts that are already set
-     * @return array new array of cpts and their registration information
-     */
-    public static function filterCustomPostTypeDefinitions(array $custom_post_type_definitions): array
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
-            }
-        }
-        return $custom_post_type_definitions;
-    }
+	/**
+	 * Callback for
+	 * FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes
+	 * that adds additional custom post types to be registered.
+	 *
+	 * @param array $custom_post_type_definitions array of cpts that are already set
+	 * @return array new array of cpts and their registration information
+	 */
+	public static function filterCustomPostTypeDefinitions(array $custom_post_type_definitions): array
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
+				$custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
+			}
+		}
+		return $custom_post_type_definitions;
+	}
 
 
-    /**
-     * Callback for
-     * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies
-     * that adds additional custom taxonomies to be registered.
-     *
-     * @param array $custom_taxonomy_definitions array of cts that are already set.
-     * @return array new array of cts and their registration information.
-     */
-    public static function filterCustomTaxonomyDefinitions(array $custom_taxonomy_definitions): array
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
-            }
-        }
-        return $custom_taxonomy_definitions;
-    }
+	/**
+	 * Callback for
+	 * FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies
+	 * that adds additional custom taxonomies to be registered.
+	 *
+	 * @param array $custom_taxonomy_definitions array of cts that are already set.
+	 * @return array new array of cts and their registration information.
+	 */
+	public static function filterCustomTaxonomyDefinitions(array $custom_taxonomy_definitions): array
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cts'] as $ct_name => $ct_settings) {
+				$custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
+			}
+		}
+		return $custom_taxonomy_definitions;
+	}
 
 
-    /**
-     * Callback for
-     * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end
-     * which is used to set the default terms
-     *
-     * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms
-     * @return void
-     */
-    public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['default_terms'] as $taxonomy => $terms) {
-                foreach ($terms as $term => $cpts) {
-                    $register_custom_taxonomy_terms->registerCustomTaxonomyTerm(
-                        $taxonomy,
-                        $term,
-                        $cpts
-                    );
-                }
-            }
-        }
-    }
+	/**
+	 * Callback for
+	 * AHEE__EventEspresso_core_domain_services_custom_post_types_RegisterCustomTaxonomyTerms__construct_end
+	 * which is used to set the default terms
+	 *
+	 * @param RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms
+	 * @return void
+	 */
+	public static function registerCustomTaxonomyTerm(RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['default_terms'] as $taxonomy => $terms) {
+				foreach ($terms as $term => $cpts) {
+					$register_custom_taxonomy_terms->registerCustomTaxonomyTerm(
+						$taxonomy,
+						$term,
+						$cpts
+					);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * @param array $cpts array of cpts that are already set
-     * @return array new array of cpts and their registration information
-     * @deprecated 4.9.62.p
-     */
-    public static function filter_cpts(array $cpts): array
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $cpts[ $cpt_name ] = $cpt_settings;
-            }
-        }
-        return $cpts;
-    }
+	/**
+	 * @param array $cpts array of cpts that are already set
+	 * @return array new array of cpts and their registration information
+	 * @deprecated 4.9.62.p
+	 */
+	public static function filter_cpts(array $cpts): array
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
+				$cpts[ $cpt_name ] = $cpt_settings;
+			}
+		}
+		return $cpts;
+	}
 
 
-    /**
-     * @param array $cts array of cts that are already set.
-     * @return array new array of cts and their registration information.
-     * @deprecated 4.9.62.p
-     */
-    public static function filter_cts(array $cts): array
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $cts[ $ct_name ] = $ct_settings;
-            }
-        }
-        return $cts;
-    }
+	/**
+	 * @param array $cts array of cts that are already set.
+	 * @return array new array of cts and their registration information.
+	 * @deprecated 4.9.62.p
+	 */
+	public static function filter_cts(array $cts): array
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['cts'] as $ct_name => $ct_settings) {
+				$cts[ $ct_name ] = $ct_settings;
+			}
+		}
+		return $cts;
+	}
 
 
-    /**
-     * @param EE_Register_CPTs $cpt_class
-     * @return void
-     * @deprecated 4.9.62.p
-     */
-    public static function default_terms(EE_Register_CPTs $cpt_class)
-    {
-        foreach (self::$_registry as $registries) {
-            foreach ($registries['default_terms'] as $taxonomy => $terms) {
-                foreach ($terms as $term => $cpts) {
-                    $cpt_class->set_default_term($taxonomy, $term, $cpts);
-                }
-            }
-        }
-    }
+	/**
+	 * @param EE_Register_CPTs $cpt_class
+	 * @return void
+	 * @deprecated 4.9.62.p
+	 */
+	public static function default_terms(EE_Register_CPTs $cpt_class)
+	{
+		foreach (self::$_registry as $registries) {
+			foreach ($registries['default_terms'] as $taxonomy => $terms) {
+				foreach ($terms as $term => $cpts) {
+					$cpt_class->set_default_term($taxonomy, $term, $cpts);
+				}
+			}
+		}
+	}
 
 
-    /**
-     * This deregisters whats been registered on this class (for the given slug).
-     *
-     * @param string $addon_name The reference for the item registered to be removed.
-     *
-     * @return void
-     * @since 4.5.0
-     *
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_registry[ $addon_name ]);
-    }
+	/**
+	 * This deregisters whats been registered on this class (for the given slug).
+	 *
+	 * @param string $addon_name The reference for the item registered to be removed.
+	 *
+	 * @return void
+	 * @since 4.5.0
+	 *
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_registry[ $addon_name ]);
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -73,7 +73,7 @@ 
             );
         }
 
-        if (! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
+        if ( ! is_array($setup_args) || (empty($setup_args['cpts']) && empty($setup_args['cts']))) {
             throw new EE_Error(
                 __(
                     'In order to register custom post types or custom taxonomies, you must include an array containing either an array of custom post types to register (key "cpts"), an array of custom taxonomies ("cts") or both.',
@@ -83,13 +83,13 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_registry[ $addon_name ])) {
+        if (isset(self::$_registry[$addon_name])) {
             return true;
         }
 
         // make sure cpt ref is unique.
-        if (isset(self::$_registry[ $addon_name ])) {
-            $addon_name = uniqid() . '_' . $addon_name;
+        if (isset(self::$_registry[$addon_name])) {
+            $addon_name = uniqid().'_'.$addon_name;
         }
 
         // make sure this was called in the right place!
@@ -119,7 +119,7 @@ 
                 : [],
         ];
 
-        self::$_registry[ $addon_name ] = $validated;
+        self::$_registry[$addon_name] = $validated;
 
         // hook into to cpt system
         add_filter(
@@ -153,7 +153,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $custom_post_type_definitions[ $cpt_name ] = $cpt_settings;
+                $custom_post_type_definitions[$cpt_name] = $cpt_settings;
             }
         }
         return $custom_post_type_definitions;
@@ -172,7 +172,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $custom_taxonomy_definitions[ $ct_name ] = $ct_settings;
+                $custom_taxonomy_definitions[$ct_name] = $ct_settings;
             }
         }
         return $custom_taxonomy_definitions;
@@ -212,7 +212,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cpts'] as $cpt_name => $cpt_settings) {
-                $cpts[ $cpt_name ] = $cpt_settings;
+                $cpts[$cpt_name] = $cpt_settings;
             }
         }
         return $cpts;
@@ -228,7 +228,7 @@ 
     {
         foreach (self::$_registry as $registries) {
             foreach ($registries['cts'] as $ct_name => $ct_settings) {
-                $cts[ $ct_name ] = $ct_settings;
+                $cts[$ct_name] = $ct_settings;
             }
         }
         return $cts;
@@ -263,6 +263,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_registry[ $addon_name ]);
+        unset(self::$_registry[$addon_name]);
     }
 }

core/libraries/plugin_api/EE_Register_Addon.lib.php

Indentation +1257 added lines, -1257 removed lines

@@ -22,1261 +22,1261 @@
 class EE_Register_Addon implements EEI_Plugin_API
 {
 
-    /**
-     * 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 = [];
-
-    /**
-     * @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 LoaderInterface
-     */
-    protected static $loader;
-
-
-    /**
-     * 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 boolean
-     */
-    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 string                   $pue_options
-     * @type array                    $capabilities                     an array indexed by role name
-     *                                                                  (i.e administrator,author ) and the values
-     *                                                                  are an array of caps to add to the role.
-     *                                                                  'administrator' => array(
-     *                                                                  'read_addon',
-     *                                                                  'edit_addon',
-     *                                                                  etc.
-     *                                                                  ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
-     *                                                                  for any addons that need to register any
-     *                                                                  special meta mapped capabilities.  Should
-     *                                                                  be indexed where the key is the
-     *                                                                  EE_Meta_Capability_Map class name and the
-     *                                                                  values are the arguments sent to the class.
-     * @type array                    $model_paths                      array of folders containing DB models
-     * @return boolean
-     * @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(string $addon_name = '', array $setup_args = []): bool
-    {
-        if (! self::$loader instanceof LoaderInterface) {
-            self::$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
-        }
-        // make sure this was called in the right place!
-        if (
-            ! did_action('activate_plugin')
-            && (
-                ! 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'
-            );
-            return false;
-        }
-        // required fields MUST be present, so let's make sure they are.
-        EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
-        // get class name for addon
-        $class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
-        // setup $_settings array from incoming values.
-        $addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
-        // setup PUE
-        EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
-        // does this addon work with this version of core or WordPress ?
-        // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return false;
-        }
-        // 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 false;
-        }
-        // 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);
-        return $addon instanceof EE_Addon;
-    }
-
-
-    /**
-     * @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) || ! is_array($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 (! isset($setup_args['main_file_path']) || 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 $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']
-                : [],
-            // array of PUE options used by the addon
-            'pue_options'           => isset($setup_args['pue_options'])
-                ? (array) $setup_args['pue_options']
-                : [],
-            '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'      => isset($setup_args['plugins_page_row'])
-                ? (array) $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 boolean
-     */
-    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(
-                __(
-                    '%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(
-                __(
-                    '%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(
-                __(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
-
-
-    /**
-     * if plugin update engine is being used for auto-updates,
-     * then let's set that up now before going any further so that ALL addons can be updated
-     * (not needed if PUE is not being used)
-     *
-     * @param string $addon_name
-     * @param string $class_name
-     * @param array  $setup_args
-     * @return void
-     */
-    private static function _parse_pue_options(string $addon_name, string $class_name, array $setup_args)
-    {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = [
-                'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
-                    ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
-                'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
-                    ? (string) $setup_args['pue_options']['plugin_basename']
-                    : plugin_basename($setup_args['main_file_path']),
-                'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
-                    ? (string) $setup_args['pue_options']['checkPeriod']
-                    : '24',
-                'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
-                    ? (string) $setup_args['pue_options']['use_wp_update']
-                    : false,
-            ];
-            add_action(
-                'AHEE__EE_System__brew_espresso__after_pue_init',
-                ['EE_Register_Addon', 'load_pue_update']
-            );
-        }
-    }
-
-
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     */
-    private static function _setup_namespaces(array $addon_settings)
-    {
-        //
-        if (
-            isset(
-                $addon_settings['namespace']['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 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);
-            }
-        }
-    }
-
-
-    /**
-     * 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_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_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_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
-     */
-    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 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
-     */
-    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']
-            );
-        }
-    }
-
-
-    /**
-     * 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 = self::$loader->getShared(
-            self::$_settings[ $addon_name ]['class_name'],
-            ['EE_Registry::create(addon)' => true]
-        );
-        if (! $addon instanceof EE_Addon) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
-                    self::$_settings[ $addon_name ]['class_name']
-                )
-            );
-        }
-        // setter inject dep map if required
-        if ($addon->dependencyMap() === null) {
-            $addon->setDependencyMap(self::$loader->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']);
-        // setup the add-on's pue_slug if we have one.
-        if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
-        }
-        // unfortunately this can't be hooked in upon construction, because we don't have
-        // the plugin mainfile's path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), [$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   $VID:$
-     */
-    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 = self::$loader->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);
-            }
-        }
-    }
-
-
-    /**
-     *    load_pue_update - Update notifications
-     *
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function load_pue_update()
-    {
-        // 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 (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
-                // 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'            => EE_Registry::instance()->NET_CFG->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'],
-                    ]
-                );
-            }
-        }
-    }
-
-
-    /**
-     * 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(string $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);
-            } 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);
-        }
-    }
+	/**
+	 * 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 = [];
+
+	/**
+	 * @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 LoaderInterface
+	 */
+	protected static $loader;
+
+
+	/**
+	 * 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 boolean
+	 */
+	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 string                   $pue_options
+	 * @type array                    $capabilities                     an array indexed by role name
+	 *                                                                  (i.e administrator,author ) and the values
+	 *                                                                  are an array of caps to add to the role.
+	 *                                                                  'administrator' => array(
+	 *                                                                  'read_addon',
+	 *                                                                  'edit_addon',
+	 *                                                                  etc.
+	 *                                                                  ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
+	 *                                                                  for any addons that need to register any
+	 *                                                                  special meta mapped capabilities.  Should
+	 *                                                                  be indexed where the key is the
+	 *                                                                  EE_Meta_Capability_Map class name and the
+	 *                                                                  values are the arguments sent to the class.
+	 * @type array                    $model_paths                      array of folders containing DB models
+	 * @return boolean
+	 * @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(string $addon_name = '', array $setup_args = []): bool
+	{
+		if (! self::$loader instanceof LoaderInterface) {
+			self::$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
+		}
+		// make sure this was called in the right place!
+		if (
+			! did_action('activate_plugin')
+			&& (
+				! 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'
+			);
+			return false;
+		}
+		// required fields MUST be present, so let's make sure they are.
+		EE_Register_Addon::_verify_parameters($addon_name, $setup_args);
+		// get class name for addon
+		$class_name = EE_Register_Addon::_parse_class_name($addon_name, $setup_args);
+		// setup $_settings array from incoming values.
+		$addon_settings = EE_Register_Addon::_get_addon_settings($class_name, $setup_args);
+		// setup PUE
+		EE_Register_Addon::_parse_pue_options($addon_name, $class_name, $setup_args);
+		// does this addon work with this version of core or WordPress ?
+		// does this addon work with this version of core or WordPress ?
+		if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return false;
+		}
+		// 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 false;
+		}
+		// 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);
+		return $addon instanceof EE_Addon;
+	}
+
+
+	/**
+	 * @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) || ! is_array($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 (! isset($setup_args['main_file_path']) || 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 $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']
+				: [],
+			// array of PUE options used by the addon
+			'pue_options'           => isset($setup_args['pue_options'])
+				? (array) $setup_args['pue_options']
+				: [],
+			'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'      => isset($setup_args['plugins_page_row'])
+				? (array) $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 boolean
+	 */
+	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(
+				__(
+					'%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(
+				__(
+					'%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(
+				__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
+
+
+	/**
+	 * if plugin update engine is being used for auto-updates,
+	 * then let's set that up now before going any further so that ALL addons can be updated
+	 * (not needed if PUE is not being used)
+	 *
+	 * @param string $addon_name
+	 * @param string $class_name
+	 * @param array  $setup_args
+	 * @return void
+	 */
+	private static function _parse_pue_options(string $addon_name, string $class_name, array $setup_args)
+	{
+		if (! empty($setup_args['pue_options'])) {
+			self::$_settings[ $addon_name ]['pue_options'] = [
+				'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
+					? (string) $setup_args['pue_options']['pue_plugin_slug']
+					: 'espresso_' . strtolower($class_name),
+				'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
+					? (string) $setup_args['pue_options']['plugin_basename']
+					: plugin_basename($setup_args['main_file_path']),
+				'checkPeriod'     => isset($setup_args['pue_options']['checkPeriod'])
+					? (string) $setup_args['pue_options']['checkPeriod']
+					: '24',
+				'use_wp_update'   => isset($setup_args['pue_options']['use_wp_update'])
+					? (string) $setup_args['pue_options']['use_wp_update']
+					: false,
+			];
+			add_action(
+				'AHEE__EE_System__brew_espresso__after_pue_init',
+				['EE_Register_Addon', 'load_pue_update']
+			);
+		}
+	}
+
+
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 */
+	private static function _setup_namespaces(array $addon_settings)
+	{
+		//
+		if (
+			isset(
+				$addon_settings['namespace']['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 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);
+			}
+		}
+	}
+
+
+	/**
+	 * 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_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_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_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
+	 */
+	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 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
+	 */
+	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']
+			);
+		}
+	}
+
+
+	/**
+	 * 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 = self::$loader->getShared(
+			self::$_settings[ $addon_name ]['class_name'],
+			['EE_Registry::create(addon)' => true]
+		);
+		if (! $addon instanceof EE_Addon) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
+					self::$_settings[ $addon_name ]['class_name']
+				)
+			);
+		}
+		// setter inject dep map if required
+		if ($addon->dependencyMap() === null) {
+			$addon->setDependencyMap(self::$loader->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']);
+		// setup the add-on's pue_slug if we have one.
+		if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
+			$addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+		}
+		// unfortunately this can't be hooked in upon construction, because we don't have
+		// the plugin mainfile's path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), [$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   $VID:$
+	 */
+	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 = self::$loader->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);
+			}
+		}
+	}
+
+
+	/**
+	 *    load_pue_update - Update notifications
+	 *
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function load_pue_update()
+	{
+		// 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 (self::$_settings as $settings) {
+			if (! empty($settings['pue_options'])) {
+				// 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'            => EE_Registry::instance()->NET_CFG->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'],
+					]
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * 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(string $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);
+			} 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);
+		}
+	}
 }

Spacing +116 added lines, -116 removed lines

@@ -74,15 +74,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);
@@ -259,7 +259,7 @@ 
      */
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
-        if (! self::$loader instanceof LoaderInterface) {
+        if ( ! self::$loader instanceof LoaderInterface) {
             self::$loader = EventEspresso\core\services\loaders\LoaderFactory::getLoader();
         }
         // make sure this was called in the right place!
@@ -293,7 +293,7 @@ 
         EE_Register_Addon::_parse_pue_options($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)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return false;
         }
         // register namespaces
@@ -358,7 +358,7 @@ 
                 )
             );
         }
-        if (! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
+        if ( ! isset($setup_args['main_file_path']) || empty($setup_args['main_file_path'])) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -370,7 +370,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__(
@@ -402,7 +402,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;
     }
 
 
@@ -570,9 +570,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']
             )
         ) {
@@ -583,7 +583,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 />'
             );
@@ -615,7 +615,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             unset($_GET['activate'], $_REQUEST['activate']);
@@ -643,11 +643,11 @@ 
      */
     private static function _parse_pue_options(string $addon_name, string $class_name, array $setup_args)
     {
-        if (! empty($setup_args['pue_options'])) {
-            self::$_settings[ $addon_name ]['pue_options'] = [
+        if ( ! empty($setup_args['pue_options'])) {
+            self::$_settings[$addon_name]['pue_options'] = [
                 'pue_plugin_slug' => isset($setup_args['pue_options']['pue_plugin_slug'])
                     ? (string) $setup_args['pue_options']['pue_plugin_slug']
-                    : 'espresso_' . strtolower($class_name),
+                    : 'espresso_'.strtolower($class_name),
                 'plugin_basename' => isset($setup_args['pue_options']['plugin_basename'])
                     ? (string) $setup_args['pue_options']['plugin_basename']
                     : plugin_basename($setup_args['main_file_path']),
@@ -706,12 +706,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.
@@ -720,10 +720,10 @@ 
             return true;
         }
         // 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;
     }
@@ -736,13 +736,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);
             }
         }
@@ -760,27 +760,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'],
                 ]
             );
         }
@@ -795,10 +795,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']]
             );
         }
     }
@@ -812,12 +812,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'],
                 ]
             );
         }
@@ -831,10 +831,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']]
             );
         }
     }
@@ -847,10 +847,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']]
             );
         }
     }
@@ -864,14 +864,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'] ?? [],
                 ]
             );
         }
@@ -885,10 +885,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']]
             );
         }
     }
@@ -901,12 +901,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'],
                 ]
             );
         }
@@ -919,7 +919,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']
@@ -936,15 +936,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'],
                 ]
             );
         }
@@ -962,10 +962,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']]
             );
         }
     }
@@ -981,10 +981,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']
             );
         }
     }
@@ -996,10 +996,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']
             );
         }
     }
@@ -1011,10 +1011,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']
             );
         }
     }
@@ -1032,14 +1032,14 @@ 
     private static function _load_and_init_addon_class(string $addon_name): EE_Addon
     {
         $addon = self::$loader->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__('The "%1$s" EE_Addon class failed to instantiate!', 'event_espresso'),
-                    self::$_settings[ $addon_name ]['class_name']
+                    self::$_settings[$addon_name]['class_name']
                 )
             );
         }
@@ -1051,28 +1051,28 @@ 
         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']);
         // setup the add-on's pue_slug if we have one.
-        if (! empty(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug'])) {
-            $addon->setPueSlug(self::$_settings[ $addon_name ]['pue_options']['pue_plugin_slug']);
+        if ( ! empty(self::$_settings[$addon_name]['pue_options']['pue_plugin_slug'])) {
+            $addon->setPueSlug(self::$_settings[$addon_name]['pue_options']['pue_plugin_slug']);
         }
         // unfortunately this can't be hooked in upon construction, because we don't have
         // the plugin mainfile's path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), [$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;
@@ -1088,19 +1088,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 = self::$loader->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']
                         ),
                     ]
                 );
@@ -1123,11 +1123,11 @@ 
     public static function load_pue_update()
     {
         // 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 (self::$_settings as $settings) {
-            if (! empty($settings['pue_options'])) {
+            if ( ! empty($settings['pue_options'])) {
                 // initiate the class and start the plugin update engine!
                 new PluginUpdateEngineChecker(
                 // host file URL
@@ -1135,7 +1135,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
                     [
@@ -1164,7 +1164,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);
                 }
@@ -1185,74 +1185,74 @@ 
      */
     public static function deregister(string $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(
@@ -1275,7 +1275,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);
         }
     }

core/libraries/plugin_api/EE_Register_Model.lib.php

Indentation +172 added lines, -172 removed lines

@@ -11,190 +11,190 @@
  */
 class EE_Register_Model implements EEI_Plugin_API
 {
-    /**
-     *
-     * @var array keys are the model_id used to register with, values are the array provided to register them, exactly
-     *      like EE_Register_Model::register()'s 2nd arg
-     */
-    protected static $_model_registry;
+	/**
+	 *
+	 * @var array keys are the model_id used to register with, values are the array provided to register them, exactly
+	 *      like EE_Register_Model::register()'s 2nd arg
+	 */
+	protected static $_model_registry;
 
-    /**
-     *
-     * @var array keys are model names, values are their class names. Stored on registration and used
-     * on a hook
-     */
-    protected static $_model_name_to_classname_map;
+	/**
+	 *
+	 * @var array keys are model names, values are their class names. Stored on registration and used
+	 * on a hook
+	 */
+	protected static $_model_name_to_classname_map;
 
 
-    /**
-     * @param string $addon_name  unique id for it
-     * @param array  $setup_args  {
-     * @type array   $model_paths array of folders containing DB models, where each file follows the models naming
-     *                            convention, which is: EEM_{model_name}.model.php which contains a single class called
-     *                            EEM_{model_name}. Eg. you could pass
-     *                            "public_html/wp-content/plugins/my_addon/db_models" (with or without trailing slash)
-     *                            and in that folder put each of your model files, like "EEM_Food.model.php" which
-     *                            contains the class "EEM_Food" and
-     *                            "EEM_Monkey.model.php" which contains the class "EEM_Monkey". These will be
-     *                            autoloaded and added to the EE registry so they can be used like ordinary models. The
-     *                            class contained in each file should extend EEM_Base.
-     * @type array   $class_paths array of folders containing DB classes, where each file follows the model class
-     *                            naming convention, which is EE_{model_name}.class.php. The class contained in each
-     *                            file should extend EE_Base_Class
-     *
-     * }
-     * @return bool
-     * @throws EE_Error
-     */
-    public static function register(string $addon_name = '', array $setup_args = []): bool
-    {
-        // required fields MUST be present, so let's make sure they are.
-        if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['model_paths'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register Models with EE_Register_Model::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_paths" (an array of full server paths to folders that contain models)',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * @param string $addon_name  unique id for it
+	 * @param array  $setup_args  {
+	 * @type array   $model_paths array of folders containing DB models, where each file follows the models naming
+	 *                            convention, which is: EEM_{model_name}.model.php which contains a single class called
+	 *                            EEM_{model_name}. Eg. you could pass
+	 *                            "public_html/wp-content/plugins/my_addon/db_models" (with or without trailing slash)
+	 *                            and in that folder put each of your model files, like "EEM_Food.model.php" which
+	 *                            contains the class "EEM_Food" and
+	 *                            "EEM_Monkey.model.php" which contains the class "EEM_Monkey". These will be
+	 *                            autoloaded and added to the EE registry so they can be used like ordinary models. The
+	 *                            class contained in each file should extend EEM_Base.
+	 * @type array   $class_paths array of folders containing DB classes, where each file follows the model class
+	 *                            naming convention, which is EE_{model_name}.class.php. The class contained in each
+	 *                            file should extend EE_Base_Class
+	 *
+	 * }
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public static function register(string $addon_name = '', array $setup_args = []): bool
+	{
+		// required fields MUST be present, so let's make sure they are.
+		if (empty($addon_name) || ! is_array($setup_args) || empty($setup_args['model_paths'])) {
+			throw new EE_Error(
+				__(
+					'In order to register Models with EE_Register_Model::register(), you must include a "model_id" (a unique identifier for this set of models), and an array containing the following keys: "model_paths" (an array of full server paths to folders that contain models)',
+					'event_espresso'
+				)
+			);
+		}
 
-        // make sure we don't register twice
-        if (isset(self::$_model_registry[ $addon_name ])) {
-            return true;
-        }
+		// make sure we don't register twice
+		if (isset(self::$_model_registry[ $addon_name ])) {
+			return true;
+		}
 
-        if (
-            ! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('FHEE__EE_System__parse_model_names')
-            || did_action('FHEE__EE_System__parse_implemented_model_names')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                sprintf(
-                    __(
-                        'An attempt was made to register "%s" as a group models has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                ),
-                '4.5'
-            );
-        }
-        self::$_model_registry[ $addon_name ] = $setup_args;
+		if (
+			! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('FHEE__EE_System__parse_model_names')
+			|| did_action('FHEE__EE_System__parse_implemented_model_names')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				sprintf(
+					__(
+						'An attempt was made to register "%s" as a group models has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register models.',
+						'event_espresso'
+					),
+					$addon_name
+				),
+				'4.5'
+			);
+		}
+		self::$_model_registry[ $addon_name ] = $setup_args;
 
-        if ((isset($setup_args['model_paths']) && ! isset($setup_args['class_paths']))
-            || (! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        'You must register both "model_paths" AND "class_paths", not just one or the other You provided %s',
-                        'event_espresso'
-                    ),
-                    implode(", ", array_keys($setup_args))
-                )
-            );
-        }
-        if (isset($setup_args['model_paths'])) {
-            // make sure they passed in an array
-            if (! is_array($setup_args['model_paths'])) {
-                $setup_args['model_paths'] = [$setup_args['model_paths']];
-            }
-            // we want to add this as a model folder
-            // and autoload them all
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            $model_name_to_classname_map = [];
-            foreach (array_keys($class_to_filepath_map) as $classname) {
-                $model_name_to_classname_map[ str_replace("EEM_", "", $classname) ] = $classname;
-            }
-            self::$_model_name_to_classname_map[ $addon_name ] = $model_name_to_classname_map;
-            add_filter('FHEE__EE_System__parse_model_names', ['EE_Register_Model', 'add_addon_models']);
-            add_filter(
-                'FHEE__EE_System__parse_implemented_model_names',
-                ['EE_Register_Model', 'add_addon_models']
-            );
-            add_filter('FHEE__EE_Registry__load_model__paths', ['EE_Register_Model', 'add_model_folders']);
-            unset($setup_args['model_paths']);
-        }
-        if (isset($setup_args['class_paths'])) {
-            // make sure they passed in an array
-            if (! is_array($setup_args['class_paths'])) {
-                $setup_args['class_paths'] = [$setup_args['class_paths']];
-            }
-            $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_paths']);
-            EEH_Autoloader::register_autoloader($class_to_filepath_map);
-            add_filter('FHEE__EE_Registry__load_class__paths', ['EE_Register_Model', 'add_class_folders']);
-            unset($setup_args['class_paths']);
-        }
-        foreach ($setup_args as $unknown_key => $unknown_config) {
-            self::deregister($addon_name);
-            throw new EE_Error(
-                sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
-            );
-        }
-        return true;
-    }
+		if ((isset($setup_args['model_paths']) && ! isset($setup_args['class_paths']))
+			|| (! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'You must register both "model_paths" AND "class_paths", not just one or the other You provided %s',
+						'event_espresso'
+					),
+					implode(", ", array_keys($setup_args))
+				)
+			);
+		}
+		if (isset($setup_args['model_paths'])) {
+			// make sure they passed in an array
+			if (! is_array($setup_args['model_paths'])) {
+				$setup_args['model_paths'] = [$setup_args['model_paths']];
+			}
+			// we want to add this as a model folder
+			// and autoload them all
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['model_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			$model_name_to_classname_map = [];
+			foreach (array_keys($class_to_filepath_map) as $classname) {
+				$model_name_to_classname_map[ str_replace("EEM_", "", $classname) ] = $classname;
+			}
+			self::$_model_name_to_classname_map[ $addon_name ] = $model_name_to_classname_map;
+			add_filter('FHEE__EE_System__parse_model_names', ['EE_Register_Model', 'add_addon_models']);
+			add_filter(
+				'FHEE__EE_System__parse_implemented_model_names',
+				['EE_Register_Model', 'add_addon_models']
+			);
+			add_filter('FHEE__EE_Registry__load_model__paths', ['EE_Register_Model', 'add_model_folders']);
+			unset($setup_args['model_paths']);
+		}
+		if (isset($setup_args['class_paths'])) {
+			// make sure they passed in an array
+			if (! is_array($setup_args['class_paths'])) {
+				$setup_args['class_paths'] = [$setup_args['class_paths']];
+			}
+			$class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_paths']);
+			EEH_Autoloader::register_autoloader($class_to_filepath_map);
+			add_filter('FHEE__EE_Registry__load_class__paths', ['EE_Register_Model', 'add_class_folders']);
+			unset($setup_args['class_paths']);
+		}
+		foreach ($setup_args as $unknown_key => $unknown_config) {
+			self::deregister($addon_name);
+			throw new EE_Error(
+				sprintf(__("The key '%s' is not a known key for registering a model", "event_espresso"), $unknown_key)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Filters the core list of models
-     *
-     * @param array $core_models
-     * @return array keys are model names (eg 'Event') and values are their classes (eg 'EE_Event')
-     */
-    public static function add_addon_models(array $core_models = []): array
-    {
-        $models = [];
-        foreach (self::$_model_name_to_classname_map as $model_map) {
-            $models[] = $model_map;
-        }
-        return array_merge($core_models, ...$models);
-    }
+	/**
+	 * Filters the core list of models
+	 *
+	 * @param array $core_models
+	 * @return array keys are model names (eg 'Event') and values are their classes (eg 'EE_Event')
+	 */
+	public static function add_addon_models(array $core_models = []): array
+	{
+		$models = [];
+		foreach (self::$_model_name_to_classname_map as $model_map) {
+			$models[] = $model_map;
+		}
+		return array_merge($core_models, ...$models);
+	}
 
 
-    /**
-     * Filters the list of model folders
-     *
-     * @param array $folders
-     * @return array of folder paths
-     */
-    public static function add_model_folders(array $folders = []): array
-    {
-        $model_folders = [];
-        foreach (self::$_model_registry as $setup_args) {
-            if (isset($setup_args['model_paths'])) {
-                $model_folders[] = (array) $setup_args['model_paths'];
-            }
-        }
-        return array_merge($folders, ...$model_folders);
-    }
+	/**
+	 * Filters the list of model folders
+	 *
+	 * @param array $folders
+	 * @return array of folder paths
+	 */
+	public static function add_model_folders(array $folders = []): array
+	{
+		$model_folders = [];
+		foreach (self::$_model_registry as $setup_args) {
+			if (isset($setup_args['model_paths'])) {
+				$model_folders[] = (array) $setup_args['model_paths'];
+			}
+		}
+		return array_merge($folders, ...$model_folders);
+	}
 
 
-    /**
-     * Filters the array of model class paths
-     *
-     * @param array $folders
-     * @return array of folder paths
-     */
-    public static function add_class_folders(array $folders = []): array
-    {
-        $class_folders = [];
-        foreach (self::$_model_registry as $setup_args) {
-            if (isset($setup_args['class_paths'])) {
-                $class_folders[] = (array) $setup_args['class_paths'];
-            }
-        }
-        return array_merge($folders, ...$class_folders);
-    }
+	/**
+	 * Filters the array of model class paths
+	 *
+	 * @param array $folders
+	 * @return array of folder paths
+	 */
+	public static function add_class_folders(array $folders = []): array
+	{
+		$class_folders = [];
+		foreach (self::$_model_registry as $setup_args) {
+			if (isset($setup_args['class_paths'])) {
+				$class_folders[] = (array) $setup_args['class_paths'];
+			}
+		}
+		return array_merge($folders, ...$class_folders);
+	}
 
 
-    /**
-     * deregister
-     *
-     * @param string $addon_name
-     */
-    public static function deregister(string $addon_name = '')
-    {
-        unset(self::$_model_registry[ $addon_name ], self::$_model_name_to_classname_map[ $addon_name ]);
-    }
+	/**
+	 * deregister
+	 *
+	 * @param string $addon_name
+	 */
+	public static function deregister(string $addon_name = '')
+	{
+		unset(self::$_model_registry[ $addon_name ], self::$_model_name_to_classname_map[ $addon_name ]);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -59,7 +59,7 @@ 
         }
 
         // make sure we don't register twice
-        if (isset(self::$_model_registry[ $addon_name ])) {
+        if (isset(self::$_model_registry[$addon_name])) {
             return true;
         }
 
@@ -80,10 +80,10 @@ 
                 '4.5'
             );
         }
-        self::$_model_registry[ $addon_name ] = $setup_args;
+        self::$_model_registry[$addon_name] = $setup_args;
 
         if ((isset($setup_args['model_paths']) && ! isset($setup_args['class_paths']))
-            || (! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))) {
+            || ( ! isset($setup_args['model_paths']) && isset($setup_args['class_paths']))) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -96,7 +96,7 @@ 
         }
         if (isset($setup_args['model_paths'])) {
             // make sure they passed in an array
-            if (! is_array($setup_args['model_paths'])) {
+            if ( ! is_array($setup_args['model_paths'])) {
                 $setup_args['model_paths'] = [$setup_args['model_paths']];
             }
             // we want to add this as a model folder
@@ -105,9 +105,9 @@ 
             EEH_Autoloader::register_autoloader($class_to_filepath_map);
             $model_name_to_classname_map = [];
             foreach (array_keys($class_to_filepath_map) as $classname) {
-                $model_name_to_classname_map[ str_replace("EEM_", "", $classname) ] = $classname;
+                $model_name_to_classname_map[str_replace("EEM_", "", $classname)] = $classname;
             }
-            self::$_model_name_to_classname_map[ $addon_name ] = $model_name_to_classname_map;
+            self::$_model_name_to_classname_map[$addon_name] = $model_name_to_classname_map;
             add_filter('FHEE__EE_System__parse_model_names', ['EE_Register_Model', 'add_addon_models']);
             add_filter(
                 'FHEE__EE_System__parse_implemented_model_names',
@@ -118,7 +118,7 @@ 
         }
         if (isset($setup_args['class_paths'])) {
             // make sure they passed in an array
-            if (! is_array($setup_args['class_paths'])) {
+            if ( ! is_array($setup_args['class_paths'])) {
                 $setup_args['class_paths'] = [$setup_args['class_paths']];
             }
             $class_to_filepath_map = EEH_File::get_contents_of_folders($setup_args['class_paths']);
@@ -195,6 +195,6 @@ 
      */
     public static function deregister(string $addon_name = '')
     {
-        unset(self::$_model_registry[ $addon_name ], self::$_model_name_to_classname_map[ $addon_name ]);
+        unset(self::$_model_registry[$addon_name], self::$_model_name_to_classname_map[$addon_name]);
     }
 }