eventespresso / event-espresso-core

core/services/addon/api/VersionParser.php

Indentation +105 added lines, -105 removed lines

@@ -17,117 +17,117 @@
  */
 class VersionParser
 {
-    public static function getAddonVersion(string $main_file): string
-    {
-        $version = VersionParser::read(dirname($main_file) . '/VERSION');
-        $version = trim($version);
-        if (! empty($version)) {
-            return $version;
-        }
-        return VersionParser::getVersionFromMainfile($main_file);
-    }
+	public static function getAddonVersion(string $main_file): string
+	{
+		$version = VersionParser::read(dirname($main_file) . '/VERSION');
+		$version = trim($version);
+		if (! empty($version)) {
+			return $version;
+		}
+		return VersionParser::getVersionFromMainfile($main_file);
+	}
 
 
-    private static function getVersionFromMainfile(string $main_file): string
-    {
-        $matches       = [];
-        $file_contents = VersionParser::read($main_file, true);
-        preg_match('~[/*#@]*Version:\s*(?<version>\S*)~', $file_contents, $matches);
-        if (isset($matches['version'])) {
-            $currentVersion = trim($matches['version']);
-            if (! empty($currentVersion)) {
-                return $currentVersion;
-            }
-        }
-        throw new RuntimeException(
-            sprintf(
-                esc_html__('Could not parse version from main file: %s', 'event_espresso'),
-                $main_file
-            )
-        );
-    }
+	private static function getVersionFromMainfile(string $main_file): string
+	{
+		$matches       = [];
+		$file_contents = VersionParser::read($main_file, true);
+		preg_match('~[/*#@]*Version:\s*(?<version>\S*)~', $file_contents, $matches);
+		if (isset($matches['version'])) {
+			$currentVersion = trim($matches['version']);
+			if (! empty($currentVersion)) {
+				return $currentVersion;
+			}
+		}
+		throw new RuntimeException(
+			sprintf(
+				esc_html__('Could not parse version from main file: %s', 'event_espresso'),
+				$main_file
+			)
+		);
+	}
 
 
-    /**
-     * Checks if a file exists.
-     * If $throw_exception is true, then throws exception if file does not exist.
-     *
-     * @param string $file_path
-     * @param bool   $throw_exception
-     * @return bool
-     * @throws RuntimeException
-     */
-    private static function exists(string $file_path, bool $throw_exception = false): bool
-    {
-        if (! file_exists($file_path)) {
-            if ($throw_exception) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__('File does not exist: %s', 'event_espresso'),
-                        $file_path
-                    )
-                );
-            }
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * Checks if a file exists.
+	 * If $throw_exception is true, then throws exception if file does not exist.
+	 *
+	 * @param string $file_path
+	 * @param bool   $throw_exception
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	private static function exists(string $file_path, bool $throw_exception = false): bool
+	{
+		if (! file_exists($file_path)) {
+			if ($throw_exception) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__('File does not exist: %s', 'event_espresso'),
+						$file_path
+					)
+				);
+			}
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Checks if a file is readable.
-     * If $throw_exception is true, then throws exception if file is not readable.
-     *
-     * @param string $file_path
-     * @param bool   $throw_exception
-     * @return bool
-     * @throws RuntimeException
-     */
-    private static function isReadable(string $file_path, bool $throw_exception = false): bool
-    {
-        if (! is_readable($file_path)) {
-            if ($throw_exception) {
-                throw new RuntimeException(
-                    sprintf(
-                        esc_html__('File is not readable: %s', 'event_espresso'),
-                        $file_path
-                    )
-                );
-            }
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * Checks if a file is readable.
+	 * If $throw_exception is true, then throws exception if file is not readable.
+	 *
+	 * @param string $file_path
+	 * @param bool   $throw_exception
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	private static function isReadable(string $file_path, bool $throw_exception = false): bool
+	{
+		if (! is_readable($file_path)) {
+			if ($throw_exception) {
+				throw new RuntimeException(
+					sprintf(
+						esc_html__('File is not readable: %s', 'event_espresso'),
+						$file_path
+					)
+				);
+			}
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Reads and returns file contents.
-     * If $throw_exception is true, then throws exception if there is an error reading the file.
-     *
-     * @param string $file_path
-     * @param bool   $throw_exception
-     * @return string
-     * @throws RuntimeException
-     */
-    private static function read(string $file_path, bool $throw_exception = false): string
-    {
-        if (
-            VersionParser::exists($file_path, $throw_exception)
-            && VersionParser::isReadable($file_path, $throw_exception)
-        ) {
-            $file_contents = file_get_contents($file_path);
-            if ($file_contents !== false) {
-                return $file_contents;
-            }
-        }
-        if ($throw_exception) {
-            throw new RuntimeException(
-                sprintf(
-                    esc_html__('Error reading file: %s', 'event_espresso'),
-                    $file_path
-                )
-            );
-        }
-        return '';
-    }
+	/**
+	 * Reads and returns file contents.
+	 * If $throw_exception is true, then throws exception if there is an error reading the file.
+	 *
+	 * @param string $file_path
+	 * @param bool   $throw_exception
+	 * @return string
+	 * @throws RuntimeException
+	 */
+	private static function read(string $file_path, bool $throw_exception = false): string
+	{
+		if (
+			VersionParser::exists($file_path, $throw_exception)
+			&& VersionParser::isReadable($file_path, $throw_exception)
+		) {
+			$file_contents = file_get_contents($file_path);
+			if ($file_contents !== false) {
+				return $file_contents;
+			}
+		}
+		if ($throw_exception) {
+			throw new RuntimeException(
+				sprintf(
+					esc_html__('Error reading file: %s', 'event_espresso'),
+					$file_path
+				)
+			);
+		}
+		return '';
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -19,9 +19,9 @@ 
 {
     public static function getAddonVersion(string $main_file): string
     {
-        $version = VersionParser::read(dirname($main_file) . '/VERSION');
+        $version = VersionParser::read(dirname($main_file).'/VERSION');
         $version = trim($version);
-        if (! empty($version)) {
+        if ( ! empty($version)) {
             return $version;
         }
         return VersionParser::getVersionFromMainfile($main_file);
@@ -35,7 +35,7 @@ 
         preg_match('~[/*#@]*Version:\s*(?<version>\S*)~', $file_contents, $matches);
         if (isset($matches['version'])) {
             $currentVersion = trim($matches['version']);
-            if (! empty($currentVersion)) {
+            if ( ! empty($currentVersion)) {
                 return $currentVersion;
             }
         }
@@ -59,7 +59,7 @@ 
      */
     private static function exists(string $file_path, bool $throw_exception = false): bool
     {
-        if (! file_exists($file_path)) {
+        if ( ! file_exists($file_path)) {
             if ($throw_exception) {
                 throw new RuntimeException(
                     sprintf(
@@ -85,7 +85,7 @@ 
      */
     private static function isReadable(string $file_path, bool $throw_exception = false): bool
     {
-        if (! is_readable($file_path)) {
+        if ( ! is_readable($file_path)) {
             if ($throw_exception) {
                 throw new RuntimeException(
                     sprintf(

core/services/addon/api/AddonApiFactory.php

Indentation +38 added lines, -38 removed lines

@@ -15,46 +15,46 @@
  */
 class AddonApiFactory
 {
-    public static function addonApiV1(
-        int $ID,
-        string $main_file,
-        string $name,
-        string $display_name,
-        string $namespace,
-        string $min_core_version
-    ): AddonApi {
-        $addon_collection = AddonApiFactory::getAddonCollection();
-        $slug = AddonApiFactory::getSlugFromMainfile($main_file);
-        if ($addon_collection->hasAddon($slug)) {
-            return $addon_collection->getAddon($slug);
-        }
-        $addon = AddonApiFactory::createAddon();
-        $addon->setID($ID);
-        $addon->setSlug($slug);
-        $addon->setName($name);
-        $addon->setDisplayName($display_name);
-        $addon->setMainFile($main_file);
-        $addon->setVersion(VersionParser::getAddonVersion($main_file));
-        $addon->setMinCoreVersion($min_core_version);
-        $addon->setNamespace($namespace);
-        $addon_collection->addAddon($addon);
-        return $addon;
-    }
+	public static function addonApiV1(
+		int $ID,
+		string $main_file,
+		string $name,
+		string $display_name,
+		string $namespace,
+		string $min_core_version
+	): AddonApi {
+		$addon_collection = AddonApiFactory::getAddonCollection();
+		$slug = AddonApiFactory::getSlugFromMainfile($main_file);
+		if ($addon_collection->hasAddon($slug)) {
+			return $addon_collection->getAddon($slug);
+		}
+		$addon = AddonApiFactory::createAddon();
+		$addon->setID($ID);
+		$addon->setSlug($slug);
+		$addon->setName($name);
+		$addon->setDisplayName($display_name);
+		$addon->setMainFile($main_file);
+		$addon->setVersion(VersionParser::getAddonVersion($main_file));
+		$addon->setMinCoreVersion($min_core_version);
+		$addon->setNamespace($namespace);
+		$addon_collection->addAddon($addon);
+		return $addon;
+	}
 
-    private static function createAddon(): AddonApi
-    {
-        return LoaderFactory::getNew(AddonApi::class);
-    }
+	private static function createAddon(): AddonApi
+	{
+		return LoaderFactory::getNew(AddonApi::class);
+	}
 
-    private static function getSlugFromMainfile(string $main_file): string
-    {
-        $plugin_basename = plugin_basename($main_file);
-        return substr($plugin_basename, 0, strpos($plugin_basename, '/'));
-    }
+	private static function getSlugFromMainfile(string $main_file): string
+	{
+		$plugin_basename = plugin_basename($main_file);
+		return substr($plugin_basename, 0, strpos($plugin_basename, '/'));
+	}
 
 
-    public static function getAddonCollection(): AddonCollection
-    {
-        return LoaderFactory::getShared(AddonCollection::class);
-    }
+	public static function getAddonCollection(): AddonCollection
+	{
+		return LoaderFactory::getShared(AddonCollection::class);
+	}
 }

core/services/bootstrap/BootstrapCore.php

Indentation +187 added lines, -187 removed lines

@@ -54,213 +54,213 @@
  */
 class BootstrapCore
 {
-    private LoaderInterface $loader;
+	private LoaderInterface $loader;
 
-    protected RequestInterface $request;
+	protected RequestInterface $request;
 
-    protected ResponseInterface $response;
+	protected ResponseInterface $response;
 
-    protected RequestStackBuilder $request_stack_builder;
+	protected RequestStackBuilder $request_stack_builder;
 
-    protected RequestStack $request_stack;
+	protected RequestStack $request_stack;
 
 
-    /**
-     * BootstrapCore constructor.
-     */
-    public function __construct()
-    {
-        do_action('AHEE__EventEspresso_core_services_bootstrap_BootstrapCore___construct');
-        // construct request stack and run middleware apps as soon as all WP plugins are loaded
-        add_action('plugins_loaded', [$this, 'initialize'], 0);
-    }
+	/**
+	 * BootstrapCore constructor.
+	 */
+	public function __construct()
+	{
+		do_action('AHEE__EventEspresso_core_services_bootstrap_BootstrapCore___construct');
+		// construct request stack and run middleware apps as soon as all WP plugins are loaded
+		add_action('plugins_loaded', [$this, 'initialize'], 0);
+	}
 
 
-    /**
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws Exception
-     * @throws InvalidArgumentException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     * @throws InvalidRequestStackMiddlewareException
-     * @throws OutOfBoundsException
-     * @throws ReflectionException
-     * @throws Throwable
-     */
-    public function initialize()
-    {
-        $this->bootstrapDependencyInjectionContainer();
-        $this->bootstrapDomain();
-        $bootstrap_request = $this->bootstrapRequestResponseObjects();
-        add_action(
-            'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
-            [$bootstrap_request, 'setupLegacyRequest']
-        );
-        $this->runRequestStack();
-    }
+	/**
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws InvalidArgumentException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidRequestStackMiddlewareException
+	 * @throws OutOfBoundsException
+	 * @throws ReflectionException
+	 * @throws Throwable
+	 */
+	public function initialize()
+	{
+		$this->bootstrapDependencyInjectionContainer();
+		$this->bootstrapDomain();
+		$bootstrap_request = $this->bootstrapRequestResponseObjects();
+		add_action(
+			'EE_Load_Espresso_Core__handle_request__initialize_core_loading',
+			[$bootstrap_request, 'setupLegacyRequest']
+		);
+		$this->runRequestStack();
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws OutOfBoundsException
-     */
-    private function bootstrapDependencyInjectionContainer()
-    {
-        $bootstrap_di = new BootstrapDependencyInjectionContainer();
-        $bootstrap_di->buildLegacyDependencyInjectionContainer();
-        $bootstrap_di->buildLoader();
-        $registry       = $bootstrap_di->getRegistry();
-        $dependency_map = $bootstrap_di->getDependencyMap();
-        $dependency_map->initialize();
-        $registry->initialize();
-        $this->loader = $bootstrap_di->getLoader();
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws OutOfBoundsException
+	 */
+	private function bootstrapDependencyInjectionContainer()
+	{
+		$bootstrap_di = new BootstrapDependencyInjectionContainer();
+		$bootstrap_di->buildLegacyDependencyInjectionContainer();
+		$bootstrap_di->buildLoader();
+		$registry       = $bootstrap_di->getRegistry();
+		$dependency_map = $bootstrap_di->getDependencyMap();
+		$dependency_map->initialize();
+		$registry->initialize();
+		$this->loader = $bootstrap_di->getLoader();
+	}
 
 
-    /**
-     * configures the Domain object for core
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    private function bootstrapDomain()
-    {
-        DomainFactory::getEventEspressoCoreDomain();
-    }
+	/**
+	 * configures the Domain object for core
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	private function bootstrapDomain()
+	{
+		DomainFactory::getEventEspressoCoreDomain();
+	}
 
 
-    /**
-     * sets up the request and response objects
-     *
-     * @return BootstrapRequestResponseObjects
-     * @throws InvalidArgumentException
-     */
-    private function bootstrapRequestResponseObjects(): BootstrapRequestResponseObjects
-    {
-        /** @var BootstrapRequestResponseObjects $bootstrap_request */
-        $bootstrap_request = $this->loader->getShared(
-            'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
-            [$this->loader]
-        );
-        $bootstrap_request->buildRequestResponse();
-        $bootstrap_request->shareRequestResponse();
-        $this->request  = $this->loader->getShared('EventEspresso\core\services\request\Request');
-        $this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
-        return $bootstrap_request;
-    }
+	/**
+	 * sets up the request and response objects
+	 *
+	 * @return BootstrapRequestResponseObjects
+	 * @throws InvalidArgumentException
+	 */
+	private function bootstrapRequestResponseObjects(): BootstrapRequestResponseObjects
+	{
+		/** @var BootstrapRequestResponseObjects $bootstrap_request */
+		$bootstrap_request = $this->loader->getShared(
+			'EventEspresso\core\services\bootstrap\BootstrapRequestResponseObjects',
+			[$this->loader]
+		);
+		$bootstrap_request->buildRequestResponse();
+		$bootstrap_request->shareRequestResponse();
+		$this->request  = $this->loader->getShared('EventEspresso\core\services\request\Request');
+		$this->response = $this->loader->getShared('EventEspresso\core\services\request\Response');
+		return $bootstrap_request;
+	}
 
 
-    /**
-     * run_request_stack
-     * construct request stack and run middleware apps
-     *
-     * @throws EE_Error
-     * @throws Exception
-     * @throws Throwable
-     */
-    public function runRequestStack()
-    {
-        $this->loadAutoloader();
-        $this->setAutoloadersForRequiredFiles();
-        $this->request_stack_builder = $this->buildRequestStack();
-        $this->request_stack         = $this->request_stack_builder->resolve(
-            new RequestStackCoreApp()
-        );
-        $this->request_stack->handleRequest($this->request, $this->response);
-        $this->request_stack->handleResponse();
-    }
+	/**
+	 * run_request_stack
+	 * construct request stack and run middleware apps
+	 *
+	 * @throws EE_Error
+	 * @throws Exception
+	 * @throws Throwable
+	 */
+	public function runRequestStack()
+	{
+		$this->loadAutoloader();
+		$this->setAutoloadersForRequiredFiles();
+		$this->request_stack_builder = $this->buildRequestStack();
+		$this->request_stack         = $this->request_stack_builder->resolve(
+			new RequestStackCoreApp()
+		);
+		$this->request_stack->handleRequest($this->request, $this->response);
+		$this->request_stack->handleResponse();
+	}
 
 
-    /**
-     * load_autoloader
-     *
-     * @throws EE_Error
-     */
-    protected function loadAutoloader()
-    {
-        // load interfaces
-        espresso_load_required(
-            'EEH_Autoloader',
-            EE_CORE . 'helpers/EEH_Autoloader.helper.php'
-        );
-        EEH_Autoloader::instance();
-    }
+	/**
+	 * load_autoloader
+	 *
+	 * @throws EE_Error
+	 */
+	protected function loadAutoloader()
+	{
+		// load interfaces
+		espresso_load_required(
+			'EEH_Autoloader',
+			EE_CORE . 'helpers/EEH_Autoloader.helper.php'
+		);
+		EEH_Autoloader::instance();
+	}
 
 
-    /**
-     * load_required_files
-     *
-     * @throws EE_Error
-     */
-    protected function setAutoloadersForRequiredFiles()
-    {
-        // load interfaces
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
-        // load helpers
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-        // register legacy request stack classes just in case
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack/');
-        // register legacy middleware classes just in case
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware/');
-    }
+	/**
+	 * load_required_files
+	 *
+	 * @throws EE_Error
+	 */
+	protected function setAutoloadersForRequiredFiles()
+	{
+		// load interfaces
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces', true);
+		// load helpers
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+		// register legacy request stack classes just in case
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'request_stack/');
+		// register legacy middleware classes just in case
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'middleware/');
+	}
 
 
-    /**
-     * build_request_stack
-     *
-     * @return RequestStackBuilder
-     */
-    public function buildRequestStack(): RequestStackBuilder
-    {
-        $request_stack_builder = new RequestStackBuilder($this->loader);
-        /**
-         * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
-         * so items at the beginning of the final middleware stack will run last.
-         * First parameter is the middleware classname, second is an array of arguments
-         */
-        $stack_apps = apply_filters(
-            'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
-            [
-                // first in last out
-                BotDetector::class                 => [],
-                DetectFileEditorRequest::class     => [],
-                PreProductionVersionWarning::class => [],
-                RecommendedVersions::class         => [],
-                DetectLogin::class                 => [],
-                // last in first out
-                SkipRequests::class                => [],
-            ]
-        );
-        // legacy filter for backwards compatibility
-        $stack_apps = apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
-            $stack_apps
-        );
-        // load middleware onto stack : FILO (First In Last Out)
-        // items at the beginning of the $stack_apps array will run last
-        foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
-            $request_stack_builder->push([$stack_app, $stack_app_args]);
-        }
-        // finally, we'll add this on its own because we need it to always be part of the stack
-        // and we also need it to always run first because the rest of the system relies on it
-        $request_stack_builder->push(
-            [SetRequestTypeContextChecker::class, []]
-        );
-        return apply_filters(
-            'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
-            $request_stack_builder
-        );
-    }
+	/**
+	 * build_request_stack
+	 *
+	 * @return RequestStackBuilder
+	 */
+	public function buildRequestStack(): RequestStackBuilder
+	{
+		$request_stack_builder = new RequestStackBuilder($this->loader);
+		/**
+		 * ! IMPORTANT ! The middleware stack operates FILO : FIRST IN LAST OUT
+		 * so items at the beginning of the final middleware stack will run last.
+		 * First parameter is the middleware classname, second is an array of arguments
+		 */
+		$stack_apps = apply_filters(
+			'FHEE__EventEspresso_core_services_bootstrap_BootstrapCore__buildRequestStack__stack_apps',
+			[
+				// first in last out
+				BotDetector::class                 => [],
+				DetectFileEditorRequest::class     => [],
+				PreProductionVersionWarning::class => [],
+				RecommendedVersions::class         => [],
+				DetectLogin::class                 => [],
+				// last in first out
+				SkipRequests::class                => [],
+			]
+		);
+		// legacy filter for backwards compatibility
+		$stack_apps = apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__stack_apps',
+			$stack_apps
+		);
+		// load middleware onto stack : FILO (First In Last Out)
+		// items at the beginning of the $stack_apps array will run last
+		foreach ((array) $stack_apps as $stack_app => $stack_app_args) {
+			$request_stack_builder->push([$stack_app, $stack_app_args]);
+		}
+		// finally, we'll add this on its own because we need it to always be part of the stack
+		// and we also need it to always run first because the rest of the system relies on it
+		$request_stack_builder->push(
+			[SetRequestTypeContextChecker::class, []]
+		);
+		return apply_filters(
+			'FHEE__EE_Bootstrap__build_request_stack__request_stack_builder',
+			$request_stack_builder
+		);
+	}
 }

core/libraries/plugin_api/db/EEE_Base_Class.lib.php

Indentation +121 added lines, -121 removed lines

@@ -30,139 +30,139 @@
  */
 abstract class EEE_Base_Class
 {
-    const extending_method_prefix        = 'ext_';
+	const extending_method_prefix        = 'ext_';
 
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
 
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string
-     */
-    protected string $_model_name_extended = '';
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string
+	 */
+	protected string $_model_name_extended = '';
 
-    /**
-     * The model this extends
-     *
-     * @var EE_Base_Class|null
-     */
-    protected $_ = null;
+	/**
+	 * The model this extends
+	 *
+	 * @var EE_Base_Class|null
+	 */
+	protected $_ = null;
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function __construct(?string $model_name_extended = '')
-    {
-        if ($model_name_extended) {
-            // setting this inside a conditional for backwards compatibility
-            // because non-updated child classes may set the property directly and not pass to this constructor
-            $this->_model_name_extended = $model_name_extended;
-        }
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                // not translated because this is happening prior to the WP init hook when translations are set up
-                "When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
-            );
-        }
-        if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
-            throw new EE_Error(
-                sprintf(
-                    "Hooked in model object extension '%s' too late! The model object %s has already been used!",
-                    get_class($this),
-                    $this->_model_name_extended
-                )
-            );
-        }
+	/**
+	 * @throws EE_Error
+	 */
+	public function __construct(?string $model_name_extended = '')
+	{
+		if ($model_name_extended) {
+			// setting this inside a conditional for backwards compatibility
+			// because non-updated child classes may set the property directly and not pass to this constructor
+			$this->_model_name_extended = $model_name_extended;
+		}
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				// not translated because this is happening prior to the WP init hook when translations are set up
+				"When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
+			);
+		}
+		if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
+			throw new EE_Error(
+				sprintf(
+					"Hooked in model object extension '%s' too late! The model object %s has already been used!",
+					get_class($this),
+					$this->_model_name_extended
+				)
+			);
+		}
 
-        add_action("AHEE__EE_{$this->_model_name_extended}__construct", [$this, 'extendBaseClass']);
-    }
+		add_action("AHEE__EE_{$this->_model_name_extended}__construct", [$this, 'extendBaseClass']);
+	}
 
 
-    public function extendBaseClass()
-    {
-        $this->_register_extending_methods();
-    }
+	public function extendBaseClass()
+	{
+		$this->_register_extending_methods();
+	}
 
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model],
-                    10,
-                    10
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					[$this, self::dynamic_callback_method_prefix . $method_name_on_model],
+					10,
+					10
+				);
+			}
+		}
+	}
 
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model]
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					[$this, self::dynamic_callback_method_prefix . $method_name_on_model]
+				);
+			}
+		}
+	}
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function __call($callback_method_name, $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            $model_called           = $args[1];
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $args_provided_to_method_on_model = $args[2];
-            $extending_method                 = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                        "event_espresso"
-                    ),
-                    $this->_model_name_extended,
-                    get_class($this),
-                    $extending_method,
-                    $extending_method
-                )
-            );
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                $callback_method_name,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	public function __call($callback_method_name, $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			$model_called           = $args[1];
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$args_provided_to_method_on_model = $args[2];
+			$extending_method                 = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+						"event_espresso"
+					),
+					$this->_model_name_extended,
+					get_class($this),
+					$extending_method,
+					$extending_method
+				)
+			);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+				$callback_method_name,
+				get_class($this)
+			)
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -59,13 +59,13 @@ 
             // because non-updated child classes may set the property directly and not pass to this constructor
             $this->_model_name_extended = $model_name_extended;
         }
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 // not translated because this is happening prior to the WP init hook when translations are set up
                 "When declaring a class extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'",
             );
         }
-        if (did_action('AHEE__EE_' . $this->_model_name_extended . '__construct__end')) {
+        if (did_action('AHEE__EE_'.$this->_model_name_extended.'__construct__end')) {
             throw new EE_Error(
                 sprintf(
                     "Hooked in model object extension '%s' too late! The model object %s has already been used!",
@@ -98,7 +98,7 @@ 
                 $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model],
+                    [$this, self::dynamic_callback_method_prefix.$method_name_on_model],
                     10,
                     10
                 );
@@ -120,7 +120,7 @@ 
                 $callback_name        = "FHEE__EE_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model]
+                    [$this, self::dynamic_callback_method_prefix.$method_name_on_model]
                 );
             }
         }
@@ -140,7 +140,7 @@ 
             $this->_ = $model_called;
             // phpcs:enable
             $args_provided_to_method_on_model = $args[2];
-            $extending_method                 = self::extending_method_prefix . $method_called_on_model;
+            $extending_method                 = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
             }

core/libraries/plugin_api/db/EEME_Base.lib.php

Indentation +209 added lines, -209 removed lines

@@ -65,237 +65,237 @@
  */
 abstract class EEME_Base
 {
-    const extending_method_prefix        = 'ext_';
+	const extending_method_prefix        = 'ext_';
 
-    const dynamic_callback_method_prefix = 'dynamic_callback_method_';
+	const dynamic_callback_method_prefix = 'dynamic_callback_method_';
 
-    protected array $_extra_tables = [];
+	protected array $_extra_tables = [];
 
-    protected array $_extra_fields = [];
+	protected array $_extra_fields = [];
 
-    protected array $_extra_relations = [];
+	protected array $_extra_relations = [];
 
-    /**
-     * The model name that is extended (not classname)
-     *
-     * @var string
-     */
-    protected string $_model_name_extended = '';
+	/**
+	 * The model name that is extended (not classname)
+	 *
+	 * @var string
+	 */
+	protected string $_model_name_extended = '';
 
-    /**
-     * The model this extends
-     *
-     * @var EEM_Base|null
-     */
-    protected $_ = null;
+	/**
+	 * The model this extends
+	 *
+	 * @var EEM_Base|null
+	 */
+	protected $_ = null;
 
 
-    /**
-     * @throws EE_Error
-     */
-    public function __construct(?string $model_name_extended = '')
-    {
-        if ($model_name_extended) {
-            // setting this inside a conditional for backwards compatibility
-            // because non-updated child classes may set the property directly and not pass to this constructor
-            $this->_model_name_extended = $model_name_extended;
-        }
-        if (! $this->_model_name_extended) {
-            throw new EE_Error(
-                // not translated because this is happening prior to the WP init hook when translations are set up
-                "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'"
-            );
-        }
-        $construct_end_action = "AHEE__EEM_{$this->_model_name_extended}__construct__end";
-        if (did_action($construct_end_action)) {
-            throw new EE_Error(
-                sprintf(
-                    "Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
-                    get_class($this),
-                    $this->_model_name_extended,
-                    $construct_end_action
-                )
-            );
-        }
-        add_action("AHEE__EEM_{$this->_model_name_extended}__instance__before_construct", [$this, 'extendModel']);
-    }
+	/**
+	 * @throws EE_Error
+	 */
+	public function __construct(?string $model_name_extended = '')
+	{
+		if ($model_name_extended) {
+			// setting this inside a conditional for backwards compatibility
+			// because non-updated child classes may set the property directly and not pass to this constructor
+			$this->_model_name_extended = $model_name_extended;
+		}
+		if (! $this->_model_name_extended) {
+			throw new EE_Error(
+				// not translated because this is happening prior to the WP init hook when translations are set up
+				"When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'"
+			);
+		}
+		$construct_end_action = "AHEE__EEM_{$this->_model_name_extended}__construct__end";
+		if (did_action($construct_end_action)) {
+			throw new EE_Error(
+				sprintf(
+					"Hooked in model extension '%s' too late! The model %s has already been used! We know because the action %s has been fired",
+					get_class($this),
+					$this->_model_name_extended,
+					$construct_end_action
+				)
+			);
+		}
+		add_action("AHEE__EEM_{$this->_model_name_extended}__instance__before_construct", [$this, 'extendModel']);
+	}
 
 
-    /**
-     * Used to populate the $_extra_tables, $_extra_fields, and $_extra_relations arrays;
-     *
-     * @return void
-     * @since 5.0.42
-     */
-    public function registerExtensions() {
-        // Intentionally left blank, child classes should override this method to populate the arrays
-        // with their own values.
-        // For example:
-        // $this->_extra_tables    = [...];
-        // $this->_extra_fields    = [...];
-        // $this->_extra_relations = [...];
-    }
+	/**
+	 * Used to populate the $_extra_tables, $_extra_fields, and $_extra_relations arrays;
+	 *
+	 * @return void
+	 * @since 5.0.42
+	 */
+	public function registerExtensions() {
+		// Intentionally left blank, child classes should override this method to populate the arrays
+		// with their own values.
+		// For example:
+		// $this->_extra_tables    = [...];
+		// $this->_extra_fields    = [...];
+		// $this->_extra_relations = [...];
+	}
 
 
-    public function extendModel()
-    {
-        $this->registerExtensions();
-        add_filter(
-            "FHEE__EEM_{$this->_model_name_extended}__construct__tables",
-            [$this, 'add_extra_tables_on_filter']
-        );
-        add_filter(
-            "FHEE__EEM_{$this->_model_name_extended}__construct__fields",
-            [$this, 'add_extra_fields_on_filter']
-        );
-        add_filter(
-            "FHEE__EEM_{$this->_model_name_extended}__construct__model_relations",
-            [$this, 'add_extra_relations_on_filter']
-        );
-        $this->_register_extending_methods();
-    }
+	public function extendModel()
+	{
+		$this->registerExtensions();
+		add_filter(
+			"FHEE__EEM_{$this->_model_name_extended}__construct__tables",
+			[$this, 'add_extra_tables_on_filter']
+		);
+		add_filter(
+			"FHEE__EEM_{$this->_model_name_extended}__construct__fields",
+			[$this, 'add_extra_fields_on_filter']
+		);
+		add_filter(
+			"FHEE__EEM_{$this->_model_name_extended}__construct__model_relations",
+			[$this, 'add_extra_relations_on_filter']
+		);
+		$this->_register_extending_methods();
+	}
 
 
-    /**
-     * @param array $existing_tables
-     * @return array
-     */
-    public function add_extra_tables_on_filter($existing_tables)
-    {
-        return array_merge($existing_tables, $this->_extra_tables);
-    }
+	/**
+	 * @param array $existing_tables
+	 * @return array
+	 */
+	public function add_extra_tables_on_filter($existing_tables)
+	{
+		return array_merge($existing_tables, $this->_extra_tables);
+	}
 
 
-    /**
-     * @param array $existing_fields
-     * @return array
-     */
-    public function add_extra_fields_on_filter($existing_fields)
-    {
-        if ($this->_extra_fields) {
-            foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = [];
-                }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
-                );
-            }
-        }
-        return $existing_fields;
-    }
+	/**
+	 * @param array $existing_fields
+	 * @return array
+	 */
+	public function add_extra_fields_on_filter($existing_fields)
+	{
+		if ($this->_extra_fields) {
+			foreach ($this->_extra_fields as $table_alias => $fields) {
+				if (! isset($existing_fields[ $table_alias ])) {
+					$existing_fields[ $table_alias ] = [];
+				}
+				$existing_fields[ $table_alias ] = array_merge(
+					(array) $existing_fields[ $table_alias ],
+					$this->_extra_fields[ $table_alias ]
+				);
+			}
+		}
+		return $existing_fields;
+	}
 
 
-    /**
-     * @param array $existing_relations
-     * @return array
-     */
-    public function add_extra_relations_on_filter($existing_relations)
-    {
-        return array_merge($existing_relations, $this->_extra_relations);
-    }
+	/**
+	 * @param array $existing_relations
+	 * @return array
+	 */
+	public function add_extra_relations_on_filter($existing_relations)
+	{
+		return array_merge($existing_relations, $this->_extra_relations);
+	}
 
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    protected function _register_extending_methods()
-    {
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name        = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                add_filter(
-                    $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model],
-                    10,
-                    10
-                );
-            }
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically makes them functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	protected function _register_extending_methods()
+	{
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name        = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				add_filter(
+					$callback_name,
+					[$this, self::dynamic_callback_method_prefix . $method_name_on_model],
+					10,
+					10
+				);
+			}
+		}
+	}
 
 
-    /**
-     * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
-     * model extended. (Internally uses filters, and the __call magic method)
-     */
-    public function deregister()
-    {
-        remove_filter(
-            "FHEE__EEM_{$this->_model_name_extended}__construct__tables",
-            [$this, 'add_extra_tables_on_filter']
-        );
-        remove_filter(
-            "FHEE__EEM_{$this->_model_name_extended}__construct__fields",
-            [$this, 'add_extra_fields_on_filter']
-        );
-        remove_filter(
-            "FHEE__EEM_{$this->_model_name_extended}__construct__model_relations",
-            [$this, 'add_extra_relations_on_filter']
-        );
-        $all_methods = get_class_methods(get_class($this));
-        foreach ($all_methods as $method_name) {
-            if (strpos($method_name, self::extending_method_prefix) === 0) {
-                $method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
-                $callback_name        = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
-                remove_filter(
-                    $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model]
-                );
-            }
-        }
-        $model_to_reset = "EEM_$this->_model_name_extended";
-        if (class_exists($model_to_reset)) {
-            $model_to_reset::reset();
-        }
-    }
+	/**
+	 * scans the child of EEME_Base for functions starting with ext_, and magically REMOVES them as functions on the
+	 * model extended. (Internally uses filters, and the __call magic method)
+	 */
+	public function deregister()
+	{
+		remove_filter(
+			"FHEE__EEM_{$this->_model_name_extended}__construct__tables",
+			[$this, 'add_extra_tables_on_filter']
+		);
+		remove_filter(
+			"FHEE__EEM_{$this->_model_name_extended}__construct__fields",
+			[$this, 'add_extra_fields_on_filter']
+		);
+		remove_filter(
+			"FHEE__EEM_{$this->_model_name_extended}__construct__model_relations",
+			[$this, 'add_extra_relations_on_filter']
+		);
+		$all_methods = get_class_methods(get_class($this));
+		foreach ($all_methods as $method_name) {
+			if (strpos($method_name, self::extending_method_prefix) === 0) {
+				$method_name_on_model = str_replace(self::extending_method_prefix, '', $method_name);
+				$callback_name        = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
+				remove_filter(
+					$callback_name,
+					[$this, self::dynamic_callback_method_prefix . $method_name_on_model]
+				);
+			}
+		}
+		$model_to_reset = "EEM_$this->_model_name_extended";
+		if (class_exists($model_to_reset)) {
+			$model_to_reset::reset();
+		}
+	}
 
 
-    /**
-     * @param string $callback_method_name
-     * @param array  $args
-     * @return mixed
-     * @throws EE_Error
-     */
-    public function __call(string $callback_method_name, array $args)
-    {
-        if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
-            // it's a dynamic callback for a method name
-            $method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
-            // intentionally skipping first array element, ie: [, is correct
-            [, $model_called, $args_provided_to_method_on_model] = $args;
-            // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
-            $this->_ = $model_called;
-            // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
-            if (method_exists($this, $extending_method)) {
-                return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            "An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
-                            "event_espresso"
-                        ),
-                        $this->_model_name_extended,
-                        get_class($this),
-                        $extending_method,
-                        $extending_method
-                    )
-                );
-            }
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
-                    $callback_method_name,
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @param string $callback_method_name
+	 * @param array  $args
+	 * @return mixed
+	 * @throws EE_Error
+	 */
+	public function __call(string $callback_method_name, array $args)
+	{
+		if (strpos($callback_method_name, self::dynamic_callback_method_prefix) === 0) {
+			// it's a dynamic callback for a method name
+			$method_called_on_model = str_replace(self::dynamic_callback_method_prefix, '', $callback_method_name);
+			// intentionally skipping first array element, ie: [, is correct
+			[, $model_called, $args_provided_to_method_on_model] = $args;
+			// phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
+			$this->_ = $model_called;
+			// phpcs:enable
+			$extending_method = self::extending_method_prefix . $method_called_on_model;
+			if (method_exists($this, $extending_method)) {
+				return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							"An odd error occurred. Model '%s' had a method called on it that it didn't recognize. So it passed it onto the model extension '%s' (because it had a function named '%s' which should be able to handle it), but the function '%s' doesnt exist!)",
+							"event_espresso"
+						),
+						$this->_model_name_extended,
+						get_class($this),
+						$extending_method,
+						$extending_method
+					)
+				);
+			}
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__("There is no method named '%s' on '%s'", "event_espresso"),
+					$callback_method_name,
+					get_class($this)
+				)
+			);
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -100,7 +100,7 @@ 
             // because non-updated child classes may set the property directly and not pass to this constructor
             $this->_model_name_extended = $model_name_extended;
         }
-        if (! $this->_model_name_extended) {
+        if ( ! $this->_model_name_extended) {
             throw new EE_Error(
                 // not translated because this is happening prior to the WP init hook when translations are set up
                 "When declaring a model extension, you must define its _model_name_extended property. It should be a model name like 'Attendee' or 'Event'"
@@ -174,12 +174,12 @@ 
     {
         if ($this->_extra_fields) {
             foreach ($this->_extra_fields as $table_alias => $fields) {
-                if (! isset($existing_fields[ $table_alias ])) {
-                    $existing_fields[ $table_alias ] = [];
+                if ( ! isset($existing_fields[$table_alias])) {
+                    $existing_fields[$table_alias] = [];
                 }
-                $existing_fields[ $table_alias ] = array_merge(
-                    (array) $existing_fields[ $table_alias ],
-                    $this->_extra_fields[ $table_alias ]
+                $existing_fields[$table_alias] = array_merge(
+                    (array) $existing_fields[$table_alias],
+                    $this->_extra_fields[$table_alias]
                 );
             }
         }
@@ -210,7 +210,7 @@ 
                 $callback_name        = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 add_filter(
                     $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model],
+                    [$this, self::dynamic_callback_method_prefix.$method_name_on_model],
                     10,
                     10
                 );
@@ -244,7 +244,7 @@ 
                 $callback_name        = "FHEE__EEM_{$this->_model_name_extended}__$method_name_on_model";
                 remove_filter(
                     $callback_name,
-                    [$this, self::dynamic_callback_method_prefix . $method_name_on_model]
+                    [$this, self::dynamic_callback_method_prefix.$method_name_on_model]
                 );
             }
         }
@@ -271,7 +271,7 @@ 
             // phpcs:disable WordPress.WP.I18n.SingleUnderscoreGetTextFunction
             $this->_ = $model_called;
             // phpcs:enable
-            $extending_method = self::extending_method_prefix . $method_called_on_model;
+            $extending_method = self::extending_method_prefix.$method_called_on_model;
             if (method_exists($this, $extending_method)) {
                 return call_user_func_array([$this, $extending_method], $args_provided_to_method_on_model);
             } else {

core/libraries/plugin_api/EE_Register_Payment_Method.lib.php

Indentation +156 added lines, -156 removed lines

@@ -18,170 +18,170 @@
  */
 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')) {
-            /** @var EE_Payment_Method_Manager $payment_method_manager */
-            $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')) {
+			/** @var EE_Payment_Method_Manager $payment_method_manager */
+			$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;
+	}
 
 
-    public static function reset(): void
-    {
-        self::$_settings = [];
-    }
+	public static function reset(): void
+	{
+		self::$_settings = [];
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -58,7 +58,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!
@@ -76,7 +76,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 @@ 
             /** @var EE_Payment_Method_Manager $payment_method_manager */
             $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_Addon.lib.php

Indentation +1278 added lines, -1278 removed lines

@@ -24,1282 +24,1282 @@
  */
 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.
-     */
-    protected static $_incompatible_addons = [
-        'Multi_Event_Registration' => '2.0.11.rc.002',
-        'Promotions'               => '1.0.0.rc.084',
-        'EE_WPUsers'               => '2.1.3.p',
-    ];
-
-    /**
-     * @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 bool
-     */
-    public static function _meets_min_core_version_requirement(
-        string $min_core_version,
-        string $actual_core_version = EVENT_ESPRESSO_VERSION
-    ): bool {
-        return version_compare(
-            self::_effective_version($actual_core_version),
-            self::_effective_version($min_core_version),
-            '>='
-        );
-    }
-
-
-    /**
-     * Method for registering new EE_Addons.
-     * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
-     * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
-     * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
-     * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
-     * 'activate_plugin', it registers the addon still, but its components are not registered
-     * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
-     * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
-     * (so that we can detect that the addon has activated on the subsequent request)
-     *
-     * @param string                  $addon_name                       [Required] the EE_Addon's name.
-     * @param array                   $setup_args                       {
-     *                                                                  An array of arguments provided for registering
-     *                                                                  the message type.
-     * @type  string                  $class_name                       the addon's main file name.
-     *                                                                  If left blank, generated from the addon name,
-     *                                                                  changes something like "calendar" to
-     *                                                                  "EE_Calendar"
-     * @type string                   $min_core_version                 the minimum version of EE Core that the
-     *                                                                  addon will work with. eg "4.8.1.rc.084"
-     * @type string                   $version                          the "software" version for the addon. eg
-     *                                                                  "1.0.0.p" for a first stable release, or
-     *                                                                  "1.0.0.rc.043" for a version in progress
-     * @type string                   $main_file_path                   the full server path to the main file
-     *                                                                  loaded directly by WP
-     * @type DomainInterface          $domain                           child class of
-     *                                                                  EventEspresso\core\domain\DomainBase
-     * @type string                   $domain_fqcn                      Fully Qualified Class Name
-     *                                                                  for the addon's Domain class
-     *                                                                  (see EventEspresso\core\domain\Domain)
-     * @type string                   $admin_path                       full server path to the folder where the
-     *                                                                  addon\'s admin files reside
-     * @type string                   $admin_callback                   a method to be called when the EE Admin is
-     *                                                                  first invoked, can be used for hooking into
-     *                                                                  any admin page
-     * @type string                   $config_section                   the section name for this addon's
-     *                                                                  configuration settings section
-     *                                                                  (defaults to "addons")
-     * @type string                   $config_class                     the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $config_name                      the class name for this addon's
-     *                                                                  configuration settings object
-     * @type string                   $autoloader_paths                 [Required] an array of class names and the full
-     *                                                                  server paths to those files.
-     * @type string                   $autoloader_folders               an array of  "full server paths" for any
-     *                                                                  folders containing classes that might be
-     *                                                                  invoked by the addon
-     * @type string                   $dms_paths                        [Required] an array of full server paths to
-     *                                                                  folders that contain data migration scripts.
-     *                                                                  The key should be the EE_Addon class name that
-     *                                                                  this set of data migration scripts belongs to.
-     *                                                                  If the EE_Addon class is namespaced, then this
-     *                                                                  needs to be the Fully Qualified Class Name
-     * @type string                   $module_paths                     an array of full server paths to any
-     *                                                                  EED_Modules used by the addon
-     * @type string                   $shortcode_paths                  an array of full server paths to folders
-     *                                                                  that contain EES_Shortcodes
-     * @type string                   $widget_paths                     an array of full server paths to folders
-     *                                                                  that contain WP_Widgets
-     * @type array                    $capabilities                     an array indexed by role name
-     *                                                                  (i.e administrator,author ) and the values
-     *                                                                  are an array of caps to add to the role.
-     *                                                                  'administrator' => array(
-     *                                                                  'read_addon',
-     *                                                                  'edit_addon',
-     *                                                                  etc.
-     *                                                                  ).
-     * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
-     *                                                                  for any addons that need to register any
-     *                                                                  special meta mapped capabilities.  Should
-     *                                                                  be indexed where the key is the
-     *                                                                  EE_Meta_Capability_Map class name and the
-     *                                                                  values are the arguments sent to the class.
-     * @type array                    $model_paths                      array of folders containing DB models
-     * @return bool
-     * @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
-    {
-        // $addon_name = basename($addon_name);
-        if (! self::$loader instanceof LoaderInterface) {
-            self::$loader = 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);
-        // allow early addon setup or modification of addon api settings
-        self::$_settings = (array) apply_filters(
-            'FHEE__EE_Register_Addon__register',
-            self::$_settings,
-            $addon_name,
-            $class_name,
-            $setup_args
-        );
-        // does this addon work with this version of core or WordPress ?
-        // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
-            return 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);
-        EE_Register_Addon::registerLicense($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) || empty($setup_args)) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
-                    'event_espresso'
-                )
-            );
-        }
-        if (empty($setup_args['main_file_path'])) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
-                        'event_espresso'
-                    ),
-                    implode(',', array_keys($setup_args))
-                )
-            );
-        }
-        // check that addon has not already been registered with that name
-        if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
-                        'event_espresso'
-                    ),
-                    $addon_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $setup_args
-     * @return string
-     */
-    private static function _parse_class_name(string $addon_name, array $setup_args): string
-    {
-        if (empty($setup_args['class_name'])) {
-            // generate one by first separating name with spaces
-            $class_name = str_replace(['-', '_'], ' ', trim($addon_name));
-            // capitalize, then replace spaces with underscores
-            $class_name = str_replace(' ', '_', ucwords($class_name));
-        } else {
-            $class_name = $setup_args['class_name'];
-        }
-        // check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
-        return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
-            ? $class_name
-            : 'EE_' . $class_name;
-    }
-
-
-    /**
-     * @param string $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']
-                : sanitize_key($class_name),
-            // page slug to be used when generating the "Settings" link on the WP plugin page
-            'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
-                ? (string) $setup_args['plugin_action_slug']
-                : '',
-            // the "software" version for the addon
-            'version'               => isset($setup_args['version'])
-                ? (string) $setup_args['version']
-                : '',
-            // the minimum version of EE Core that the addon will work with
-            'min_core_version'      => isset($setup_args['min_core_version'])
-                ? (string) $setup_args['min_core_version']
-                : '',
-            // the minimum version of WordPress that the addon will work with
-            'min_wp_version'        => isset($setup_args['min_wp_version'])
-                ? (string) $setup_args['min_wp_version']
-                : EE_MIN_WP_VER_REQUIRED,
-            // full server path to main file (file loaded directly by WP)
-            'main_file_path'        => isset($setup_args['main_file_path'])
-                ? (string) $setup_args['main_file_path']
-                : '',
-            // instance of \EventEspresso\core\domain\DomainInterface
-            'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
-                ? $setup_args['domain']
-                : null,
-            // Fully Qualified Class Name for the addon's Domain class
-            'domain_fqcn'           => isset($setup_args['domain_fqcn'])
-                ? (string) $setup_args['domain_fqcn']
-                : '',
-            // path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
-            'admin_path'            => isset($setup_args['admin_path'])
-                ? (string) $setup_args['admin_path']
-                : '',
-            // a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
-            'admin_callback'        => isset($setup_args['admin_callback'])
-                ? (string) $setup_args['admin_callback']
-                : '',
-            // the section name for this addon's configuration settings section (defaults to "addons")
-            'config_section'        => isset($setup_args['config_section'])
-                ? (string) $setup_args['config_section']
-                : 'addons',
-            // the class name for this addon's configuration settings object
-            'config_class'          => isset($setup_args['config_class'])
-                ? (string) $setup_args['config_class']
-                : '',
-            // the name given to the config for this addons' configuration settings object (optional)
-            'config_name'           => isset($setup_args['config_name'])
-                ? (string) $setup_args['config_name']
-                : '',
-            // an array of "class names" => "full server paths" for any classes that might be invoked by the addon
-            'autoloader_paths'      => isset($setup_args['autoloader_paths'])
-                ? (array) $setup_args['autoloader_paths']
-                : [],
-            // an array of  "full server paths" for any folders containing classes that might be invoked by the addon
-            'autoloader_folders'    => isset($setup_args['autoloader_folders'])
-                ? (array) $setup_args['autoloader_folders']
-                : [],
-            // array of full server paths to any EE_DMS data migration scripts used by the addon.
-            // The key should be the EE_Addon class name that this set of data migration scripts belongs to.
-            // If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
-            'dms_paths'             => isset($setup_args['dms_paths'])
-                ? (array) $setup_args['dms_paths']
-                : [],
-            // array of full server paths to any EED_Modules used by the addon
-            'module_paths'          => isset($setup_args['module_paths'])
-                ? (array) $setup_args['module_paths']
-                : [],
-            // array of full server paths to any EES_Shortcodes used by the addon
-            'shortcode_paths'       => isset($setup_args['shortcode_paths'])
-                ? (array) $setup_args['shortcode_paths']
-                : [],
-            'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
-                ? (array) $setup_args['shortcode_fqcns']
-                : [],
-            // array of full server paths to any WP_Widgets used by the addon
-            'widget_paths'          => isset($setup_args['widget_paths'])
-                ? (array) $setup_args['widget_paths']
-                : [],
-            'message_types'         => isset($setup_args['message_types'])
-                ? (array) $setup_args['message_types']
-                : [],
-            'capabilities'          => isset($setup_args['capabilities'])
-                ? (array) $setup_args['capabilities']
-                : [],
-            'capability_maps'       => isset($setup_args['capability_maps'])
-                ? (array) $setup_args['capability_maps']
-                : [],
-            'model_paths'           => isset($setup_args['model_paths'])
-                ? (array) $setup_args['model_paths']
-                : [],
-            'class_paths'           => isset($setup_args['class_paths'])
-                ? (array) $setup_args['class_paths']
-                : [],
-            'model_extension_paths' => isset($setup_args['model_extension_paths'])
-                ? (array) $setup_args['model_extension_paths']
-                : [],
-            'class_extension_paths' => isset($setup_args['class_extension_paths'])
-                ? (array) $setup_args['class_extension_paths']
-                : [],
-            'custom_post_types'     => isset($setup_args['custom_post_types'])
-                ? (array) $setup_args['custom_post_types']
-                : [],
-            'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
-                ? (array) $setup_args['custom_taxonomies']
-                : [],
-            'payment_method_paths'  => isset($setup_args['payment_method_paths'])
-                ? (array) $setup_args['payment_method_paths']
-                : [],
-            'pm_slug'               => '',
-            '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']
-                : [],
-            'license'               => isset($setup_args['license'])
-                ? (array) $setup_args['license']
-                : [],
-        ];
-
-        // if plugin_action_slug is NOT set...
-        if (empty($addon_settings['plugin_action_slug'])) {
-            if (! empty($addon_settings['payment_method_paths'])) {
-                // but the addon is a payment method
-                $payment_method_path = reset($addon_settings['payment_method_paths']);
-                $plugin_action_slug = basename(strtolower($payment_method_path));
-                $addon_settings['plugin_action_slug'] = $plugin_action_slug;
-                // let's also set the pm_slug to the same value
-                $addon_settings['pm_slug'] = $plugin_action_slug;
-            } elseif (! empty($addon_settings['admin_path'])) {
-                // or an admin page path IS set
-                $addon_settings['plugin_action_slug'] = basename($addon_settings['admin_path']);
-            }
-        }
-
-        // full server path to main file (file loaded directly by WP)
-        $addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
-        return $addon_settings;
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param array  $addon_settings
-     * @return bool
-     */
-    private static function _addon_is_compatible(string $addon_name, array $addon_settings): bool
-    {
-        global $wp_version;
-        $incompatibility_message = '';
-        // check whether this addon version is compatible with EE core
-        if (
-            isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
-            && ! self::_meets_min_core_version_requirement(
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                $addon_settings['version']
-            )
-        ) {
-            $incompatibility_message = sprintf(
-                esc_html__(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                '<br />',
-                EE_Register_Addon::$_incompatible_addons[ $addon_name ],
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (
-            ! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
-        ) {
-            $incompatibility_message = sprintf(
-                esc_html__(
-                    '%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
-                    'event_espresso'
-                ),
-                $addon_name,
-                self::_effective_version($addon_settings['min_core_version']),
-                self::_effective_version(espresso_version()),
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        } elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
-            $incompatibility_message = sprintf(
-                esc_html__(
-                    '%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
-                    'event_espresso'
-                ),
-                $addon_name,
-                $addon_settings['min_wp_version'],
-                '<br />',
-                '<span style="font-weight: bold; color: #D54E21;">',
-                '</span><br />'
-            );
-        }
-        if (! empty($incompatibility_message)) {
-            // remove 'activate' from the REQUEST
-            // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $request->unSetRequestParam('activate', true);
-            if (current_user_can('activate_plugins')) {
-                // show an error message indicating the plugin didn't activate properly
-                EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
-            }
-            unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
-            // BAIL FROM THE ADDON REGISTRATION PROCESS
-            return false;
-        }
-        // addon IS compatible
-        return true;
-    }
-
-
-    /**
-     * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
-     *
-     * @param array $addon_settings
-     * @return void
-     * @throws EE_Error
-     */
-    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).
-            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']);
-        if (! empty(self::$_settings[ $addon_name ]['pm_slug'])) {
-            $addon->setPaymentmethodSlug(self::$_settings[ $addon_name ]['pm_slug']);
-        }
-        do_action(
-            'AHEE__EE_Register_Addon___load_and_init_addon_class',
-            $addon,
-            $addon_name,
-            self::$_settings
-        );
-        // unfortunately this can't be hooked in upon construction,
-        // because we don't have the plugin's mainfile path upon construction.
-        register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
-        // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
-            add_action(
-                'AHEE__EE_System__load_controllers__load_admin_controllers',
-                [$addon, self::$_settings[ $addon_name ]['admin_callback']]
-            );
-        }
-        return $addon;
-    }
-
-
-    /**
-     * @param string   $addon_name
-     * @param EE_Addon $addon
-     * @since   4.10.13.p
-     */
-    private static function injectAddonDomain(string $addon_name, EE_Addon $addon)
-    {
-        if ($addon instanceof RequiresDomainInterface && $addon->domain() === null) {
-            // using supplied Domain object
-            $domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
-                ? self::$_settings[ $addon_name ]['domain']
-                : null;
-            // or construct one using Domain FQCN
-            if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
-                $domain = 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);
-            }
-        }
-    }
-
-
-    /**
-     * @return void
-     * @deprecated 5.0.0.p
-     */
-    public static function load_pue_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);
-                }
-            }
-        }
-    }
-
-
-    private static function registerLicense($addon_name)
-    {
-        static $request = null;
-        if ($request === null) {
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        }
-        if ($request->isWordPressHeartbeat()) {
-            return;
-        }
-        $addon_settings = self::$_settings[ $addon_name ] ?? [];
-        if (empty($addon_settings)) {
-            return;
-        }
-        $license_data = isset($addon_settings['license']) ? (array) $addon_settings['license'] : [];
-        // copy known values from addon settings to license data if anything's missing
-        $license_data += [
-            'main_file_path'   => $addon_settings['main_file_path'] ?? '',
-            'min_core_version' => $addon_settings['min_core_version'] ?? '',
-            'plugin_id'        => 0, // no corresponding value in addon settings
-            'plugin_slug'      => $addon_settings['plugin_slug'] ?? '',
-            'version'          => $addon_settings['version'] ?? '',
-        ];
-        EventEspresso\core\services\licensing\AddonLicense::register($addon_name, $license_data);
-    }
-
-
-    /**
-     * 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);
-                LoaderFactory::getLoader()->remove($class_name);
-            } catch (OutOfBoundsException $addon_not_yet_registered_exception) {
-                // the add-on was not yet registered in the registry,
-                // so RegistryContainer::__get() throws this exception.
-                // also no need to worry about this or log it,
-                // it's ok to deregister an add-on before its registered in the registry
-            } catch (Exception $e) {
-                new ExceptionLogger($e);
-            }
-            unset(self::$_settings[ $addon_name ]);
-            do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
-        }
-    }
-
-
-    public static function reset(): void
-    {
-        EE_Register_Addon::$_settings = [];
-    }
-
-
-    public static function resetAll(): void
-    {
-        // EE_Register_Addon::reset();
-        EE_Register_Admin_Page::reset();
-        EE_Register_Capabilities::reset();
-        EE_Register_Config::reset();
-        EE_Register_CPT::reset();
-        EE_Register_Data_Migration_Scripts::reset();
-        EE_Register_Message_Type::reset();
-        EE_Register_Messages_Shortcode_Library::reset();
-        EE_Register_Messages_Template_Pack::reset();
-        EE_Register_Messages_Template_Variations::reset();
-        EE_Register_Model::reset();
-        EE_Register_Model_Extensions::reset();
-        EE_Register_Module::reset();
-        EE_Register_Payment_Method::reset();
-        EE_Register_Personal_Data_Eraser::reset();
-        EE_Register_Personal_Data_Exporter::reset();
-        EE_Register_Privacy_Policy::reset();
-        EE_Register_Shortcode::reset();
-        EE_Register_Widget::reset();
-    }
+	/**
+	 * 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.
+	 */
+	protected static $_incompatible_addons = [
+		'Multi_Event_Registration' => '2.0.11.rc.002',
+		'Promotions'               => '1.0.0.rc.084',
+		'EE_WPUsers'               => '2.1.3.p',
+	];
+
+	/**
+	 * @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 bool
+	 */
+	public static function _meets_min_core_version_requirement(
+		string $min_core_version,
+		string $actual_core_version = EVENT_ESPRESSO_VERSION
+	): bool {
+		return version_compare(
+			self::_effective_version($actual_core_version),
+			self::_effective_version($min_core_version),
+			'>='
+		);
+	}
+
+
+	/**
+	 * Method for registering new EE_Addons.
+	 * Should be called AFTER AHEE__EE_System__load_espresso_addons but BEFORE
+	 * AHEE__EE_System___detect_if_activation_or_upgrade__begin in order to register all its components. However, it
+	 * may also be called after the 'activate_plugin' action (when an addon is activated), because an activating addon
+	 * won't be loaded by WP until after AHEE__EE_System__load_espresso_addons has fired. If its called after
+	 * 'activate_plugin', it registers the addon still, but its components are not registered
+	 * (they shouldn't be needed anyways, because it's just an activation request and they won't have a chance to do
+	 * anything anyways). Instead, it just sets the newly-activated addon's activation indicator wp option and returns
+	 * (so that we can detect that the addon has activated on the subsequent request)
+	 *
+	 * @param string                  $addon_name                       [Required] the EE_Addon's name.
+	 * @param array                   $setup_args                       {
+	 *                                                                  An array of arguments provided for registering
+	 *                                                                  the message type.
+	 * @type  string                  $class_name                       the addon's main file name.
+	 *                                                                  If left blank, generated from the addon name,
+	 *                                                                  changes something like "calendar" to
+	 *                                                                  "EE_Calendar"
+	 * @type string                   $min_core_version                 the minimum version of EE Core that the
+	 *                                                                  addon will work with. eg "4.8.1.rc.084"
+	 * @type string                   $version                          the "software" version for the addon. eg
+	 *                                                                  "1.0.0.p" for a first stable release, or
+	 *                                                                  "1.0.0.rc.043" for a version in progress
+	 * @type string                   $main_file_path                   the full server path to the main file
+	 *                                                                  loaded directly by WP
+	 * @type DomainInterface          $domain                           child class of
+	 *                                                                  EventEspresso\core\domain\DomainBase
+	 * @type string                   $domain_fqcn                      Fully Qualified Class Name
+	 *                                                                  for the addon's Domain class
+	 *                                                                  (see EventEspresso\core\domain\Domain)
+	 * @type string                   $admin_path                       full server path to the folder where the
+	 *                                                                  addon\'s admin files reside
+	 * @type string                   $admin_callback                   a method to be called when the EE Admin is
+	 *                                                                  first invoked, can be used for hooking into
+	 *                                                                  any admin page
+	 * @type string                   $config_section                   the section name for this addon's
+	 *                                                                  configuration settings section
+	 *                                                                  (defaults to "addons")
+	 * @type string                   $config_class                     the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $config_name                      the class name for this addon's
+	 *                                                                  configuration settings object
+	 * @type string                   $autoloader_paths                 [Required] an array of class names and the full
+	 *                                                                  server paths to those files.
+	 * @type string                   $autoloader_folders               an array of  "full server paths" for any
+	 *                                                                  folders containing classes that might be
+	 *                                                                  invoked by the addon
+	 * @type string                   $dms_paths                        [Required] an array of full server paths to
+	 *                                                                  folders that contain data migration scripts.
+	 *                                                                  The key should be the EE_Addon class name that
+	 *                                                                  this set of data migration scripts belongs to.
+	 *                                                                  If the EE_Addon class is namespaced, then this
+	 *                                                                  needs to be the Fully Qualified Class Name
+	 * @type string                   $module_paths                     an array of full server paths to any
+	 *                                                                  EED_Modules used by the addon
+	 * @type string                   $shortcode_paths                  an array of full server paths to folders
+	 *                                                                  that contain EES_Shortcodes
+	 * @type string                   $widget_paths                     an array of full server paths to folders
+	 *                                                                  that contain WP_Widgets
+	 * @type array                    $capabilities                     an array indexed by role name
+	 *                                                                  (i.e administrator,author ) and the values
+	 *                                                                  are an array of caps to add to the role.
+	 *                                                                  'administrator' => array(
+	 *                                                                  'read_addon',
+	 *                                                                  'edit_addon',
+	 *                                                                  etc.
+	 *                                                                  ).
+	 * @type EE_Meta_Capability_Map[] $capability_maps                  an array of EE_Meta_Capability_Map object
+	 *                                                                  for any addons that need to register any
+	 *                                                                  special meta mapped capabilities.  Should
+	 *                                                                  be indexed where the key is the
+	 *                                                                  EE_Meta_Capability_Map class name and the
+	 *                                                                  values are the arguments sent to the class.
+	 * @type array                    $model_paths                      array of folders containing DB models
+	 * @return bool
+	 * @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
+	{
+		// $addon_name = basename($addon_name);
+		if (! self::$loader instanceof LoaderInterface) {
+			self::$loader = 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);
+		// allow early addon setup or modification of addon api settings
+		self::$_settings = (array) apply_filters(
+			'FHEE__EE_Register_Addon__register',
+			self::$_settings,
+			$addon_name,
+			$class_name,
+			$setup_args
+		);
+		// does this addon work with this version of core or WordPress ?
+		// does this addon work with this version of core or WordPress ?
+		if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+			return 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);
+		EE_Register_Addon::registerLicense($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) || empty($setup_args)) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to register an EE_Addon with EE_Register_Addon::register(), you must include the "addon_name" (the name of the addon), and an array of arguments.',
+					'event_espresso'
+				)
+			);
+		}
+		if (empty($setup_args['main_file_path'])) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'When registering an addon, you didn\'t provide the "main_file_path", which is the full path to the main file loaded directly by Wordpress. You only provided %s',
+						'event_espresso'
+					),
+					implode(',', array_keys($setup_args))
+				)
+			);
+		}
+		// check that addon has not already been registered with that name
+		if (isset(self::$_settings[ $addon_name ]) && ! did_action('activate_plugin')) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'An EE_Addon with the name "%s" has already been registered and each EE_Addon requires a unique name.',
+						'event_espresso'
+					),
+					$addon_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $setup_args
+	 * @return string
+	 */
+	private static function _parse_class_name(string $addon_name, array $setup_args): string
+	{
+		if (empty($setup_args['class_name'])) {
+			// generate one by first separating name with spaces
+			$class_name = str_replace(['-', '_'], ' ', trim($addon_name));
+			// capitalize, then replace spaces with underscores
+			$class_name = str_replace(' ', '_', ucwords($class_name));
+		} else {
+			$class_name = $setup_args['class_name'];
+		}
+		// check if classname is fully  qualified or is a legacy classname already prefixed with 'EE_'
+		return strpos($class_name, '\\') || strpos($class_name, 'EE_') === 0
+			? $class_name
+			: 'EE_' . $class_name;
+	}
+
+
+	/**
+	 * @param string $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']
+				: sanitize_key($class_name),
+			// page slug to be used when generating the "Settings" link on the WP plugin page
+			'plugin_action_slug'    => isset($setup_args['plugin_action_slug'])
+				? (string) $setup_args['plugin_action_slug']
+				: '',
+			// the "software" version for the addon
+			'version'               => isset($setup_args['version'])
+				? (string) $setup_args['version']
+				: '',
+			// the minimum version of EE Core that the addon will work with
+			'min_core_version'      => isset($setup_args['min_core_version'])
+				? (string) $setup_args['min_core_version']
+				: '',
+			// the minimum version of WordPress that the addon will work with
+			'min_wp_version'        => isset($setup_args['min_wp_version'])
+				? (string) $setup_args['min_wp_version']
+				: EE_MIN_WP_VER_REQUIRED,
+			// full server path to main file (file loaded directly by WP)
+			'main_file_path'        => isset($setup_args['main_file_path'])
+				? (string) $setup_args['main_file_path']
+				: '',
+			// instance of \EventEspresso\core\domain\DomainInterface
+			'domain'                => isset($setup_args['domain']) && $setup_args['domain'] instanceof DomainInterface
+				? $setup_args['domain']
+				: null,
+			// Fully Qualified Class Name for the addon's Domain class
+			'domain_fqcn'           => isset($setup_args['domain_fqcn'])
+				? (string) $setup_args['domain_fqcn']
+				: '',
+			// path to folder containing files for integrating with the EE core admin and/or setting up EE admin pages
+			'admin_path'            => isset($setup_args['admin_path'])
+				? (string) $setup_args['admin_path']
+				: '',
+			// a method to be called when the EE Admin is first invoked, can be used for hooking into any admin page
+			'admin_callback'        => isset($setup_args['admin_callback'])
+				? (string) $setup_args['admin_callback']
+				: '',
+			// the section name for this addon's configuration settings section (defaults to "addons")
+			'config_section'        => isset($setup_args['config_section'])
+				? (string) $setup_args['config_section']
+				: 'addons',
+			// the class name for this addon's configuration settings object
+			'config_class'          => isset($setup_args['config_class'])
+				? (string) $setup_args['config_class']
+				: '',
+			// the name given to the config for this addons' configuration settings object (optional)
+			'config_name'           => isset($setup_args['config_name'])
+				? (string) $setup_args['config_name']
+				: '',
+			// an array of "class names" => "full server paths" for any classes that might be invoked by the addon
+			'autoloader_paths'      => isset($setup_args['autoloader_paths'])
+				? (array) $setup_args['autoloader_paths']
+				: [],
+			// an array of  "full server paths" for any folders containing classes that might be invoked by the addon
+			'autoloader_folders'    => isset($setup_args['autoloader_folders'])
+				? (array) $setup_args['autoloader_folders']
+				: [],
+			// array of full server paths to any EE_DMS data migration scripts used by the addon.
+			// The key should be the EE_Addon class name that this set of data migration scripts belongs to.
+			// If the EE_Addon class is namespaced, then this needs to be the Fully Qualified Class Name
+			'dms_paths'             => isset($setup_args['dms_paths'])
+				? (array) $setup_args['dms_paths']
+				: [],
+			// array of full server paths to any EED_Modules used by the addon
+			'module_paths'          => isset($setup_args['module_paths'])
+				? (array) $setup_args['module_paths']
+				: [],
+			// array of full server paths to any EES_Shortcodes used by the addon
+			'shortcode_paths'       => isset($setup_args['shortcode_paths'])
+				? (array) $setup_args['shortcode_paths']
+				: [],
+			'shortcode_fqcns'       => isset($setup_args['shortcode_fqcns'])
+				? (array) $setup_args['shortcode_fqcns']
+				: [],
+			// array of full server paths to any WP_Widgets used by the addon
+			'widget_paths'          => isset($setup_args['widget_paths'])
+				? (array) $setup_args['widget_paths']
+				: [],
+			'message_types'         => isset($setup_args['message_types'])
+				? (array) $setup_args['message_types']
+				: [],
+			'capabilities'          => isset($setup_args['capabilities'])
+				? (array) $setup_args['capabilities']
+				: [],
+			'capability_maps'       => isset($setup_args['capability_maps'])
+				? (array) $setup_args['capability_maps']
+				: [],
+			'model_paths'           => isset($setup_args['model_paths'])
+				? (array) $setup_args['model_paths']
+				: [],
+			'class_paths'           => isset($setup_args['class_paths'])
+				? (array) $setup_args['class_paths']
+				: [],
+			'model_extension_paths' => isset($setup_args['model_extension_paths'])
+				? (array) $setup_args['model_extension_paths']
+				: [],
+			'class_extension_paths' => isset($setup_args['class_extension_paths'])
+				? (array) $setup_args['class_extension_paths']
+				: [],
+			'custom_post_types'     => isset($setup_args['custom_post_types'])
+				? (array) $setup_args['custom_post_types']
+				: [],
+			'custom_taxonomies'     => isset($setup_args['custom_taxonomies'])
+				? (array) $setup_args['custom_taxonomies']
+				: [],
+			'payment_method_paths'  => isset($setup_args['payment_method_paths'])
+				? (array) $setup_args['payment_method_paths']
+				: [],
+			'pm_slug'               => '',
+			'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']
+				: [],
+			'license'               => isset($setup_args['license'])
+				? (array) $setup_args['license']
+				: [],
+		];
+
+		// if plugin_action_slug is NOT set...
+		if (empty($addon_settings['plugin_action_slug'])) {
+			if (! empty($addon_settings['payment_method_paths'])) {
+				// but the addon is a payment method
+				$payment_method_path = reset($addon_settings['payment_method_paths']);
+				$plugin_action_slug = basename(strtolower($payment_method_path));
+				$addon_settings['plugin_action_slug'] = $plugin_action_slug;
+				// let's also set the pm_slug to the same value
+				$addon_settings['pm_slug'] = $plugin_action_slug;
+			} elseif (! empty($addon_settings['admin_path'])) {
+				// or an admin page path IS set
+				$addon_settings['plugin_action_slug'] = basename($addon_settings['admin_path']);
+			}
+		}
+
+		// full server path to main file (file loaded directly by WP)
+		$addon_settings['plugin_basename'] = plugin_basename($addon_settings['main_file_path']);
+		return $addon_settings;
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param array  $addon_settings
+	 * @return bool
+	 */
+	private static function _addon_is_compatible(string $addon_name, array $addon_settings): bool
+	{
+		global $wp_version;
+		$incompatibility_message = '';
+		// check whether this addon version is compatible with EE core
+		if (
+			isset(EE_Register_Addon::$_incompatible_addons[ $addon_name ])
+			&& ! self::_meets_min_core_version_requirement(
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				$addon_settings['version']
+			)
+		) {
+			$incompatibility_message = sprintf(
+				esc_html__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon is not compatible with this version of Event Espresso.%2$sPlease upgrade your "%1$s" addon to version %3$s or newer to resolve this issue.',
+					'event_espresso'
+				),
+				$addon_name,
+				'<br />',
+				EE_Register_Addon::$_incompatible_addons[ $addon_name ],
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (
+			! self::_meets_min_core_version_requirement($addon_settings['min_core_version'], espresso_version())
+		) {
+			$incompatibility_message = sprintf(
+				esc_html__(
+					'%5$sIMPORTANT!%6$sThe Event Espresso "%1$s" addon requires Event Espresso Core version "%2$s" or higher in order to run.%4$sYour version of Event Espresso Core is currently at "%3$s". Please upgrade Event Espresso Core first and then re-activate "%1$s".',
+					'event_espresso'
+				),
+				$addon_name,
+				self::_effective_version($addon_settings['min_core_version']),
+				self::_effective_version(espresso_version()),
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		} elseif (version_compare($wp_version, $addon_settings['min_wp_version'], '<')) {
+			$incompatibility_message = sprintf(
+				esc_html__(
+					'%4$sIMPORTANT!%5$sThe Event Espresso "%1$s" addon requires WordPress version "%2$s" or greater.%3$sPlease update your version of WordPress to use the "%1$s" addon and to keep your site secure.',
+					'event_espresso'
+				),
+				$addon_name,
+				$addon_settings['min_wp_version'],
+				'<br />',
+				'<span style="font-weight: bold; color: #D54E21;">',
+				'</span><br />'
+			);
+		}
+		if (! empty($incompatibility_message)) {
+			// remove 'activate' from the REQUEST
+			// so WP doesn't erroneously tell the user the plugin activated fine when it didn't
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$request->unSetRequestParam('activate', true);
+			if (current_user_can('activate_plugins')) {
+				// show an error message indicating the plugin didn't activate properly
+				EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
+			}
+			unset($_GET['activate'], $_REQUEST['activate']);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
+			// BAIL FROM THE ADDON REGISTRATION PROCESS
+			return false;
+		}
+		// addon IS compatible
+		return true;
+	}
+
+
+	/**
+	 * register namespaces right away before any other files or classes get loaded, but AFTER the version checks
+	 *
+	 * @param array $addon_settings
+	 * @return void
+	 * @throws EE_Error
+	 */
+	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).
+			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']);
+		if (! empty(self::$_settings[ $addon_name ]['pm_slug'])) {
+			$addon->setPaymentmethodSlug(self::$_settings[ $addon_name ]['pm_slug']);
+		}
+		do_action(
+			'AHEE__EE_Register_Addon___load_and_init_addon_class',
+			$addon,
+			$addon_name,
+			self::$_settings
+		);
+		// unfortunately this can't be hooked in upon construction,
+		// because we don't have the plugin's mainfile path upon construction.
+		register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
+		// call any additional admin_callback functions during load_admin_controller hook
+		if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+			add_action(
+				'AHEE__EE_System__load_controllers__load_admin_controllers',
+				[$addon, self::$_settings[ $addon_name ]['admin_callback']]
+			);
+		}
+		return $addon;
+	}
+
+
+	/**
+	 * @param string   $addon_name
+	 * @param EE_Addon $addon
+	 * @since   4.10.13.p
+	 */
+	private static function injectAddonDomain(string $addon_name, EE_Addon $addon)
+	{
+		if ($addon instanceof RequiresDomainInterface && $addon->domain() === null) {
+			// using supplied Domain object
+			$domain = self::$_settings[ $addon_name ]['domain'] instanceof DomainInterface
+				? self::$_settings[ $addon_name ]['domain']
+				: null;
+			// or construct one using Domain FQCN
+			if ($domain === null && self::$_settings[ $addon_name ]['domain_fqcn'] !== '') {
+				$domain = 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);
+			}
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated 5.0.0.p
+	 */
+	public static function load_pue_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);
+				}
+			}
+		}
+	}
+
+
+	private static function registerLicense($addon_name)
+	{
+		static $request = null;
+		if ($request === null) {
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		}
+		if ($request->isWordPressHeartbeat()) {
+			return;
+		}
+		$addon_settings = self::$_settings[ $addon_name ] ?? [];
+		if (empty($addon_settings)) {
+			return;
+		}
+		$license_data = isset($addon_settings['license']) ? (array) $addon_settings['license'] : [];
+		// copy known values from addon settings to license data if anything's missing
+		$license_data += [
+			'main_file_path'   => $addon_settings['main_file_path'] ?? '',
+			'min_core_version' => $addon_settings['min_core_version'] ?? '',
+			'plugin_id'        => 0, // no corresponding value in addon settings
+			'plugin_slug'      => $addon_settings['plugin_slug'] ?? '',
+			'version'          => $addon_settings['version'] ?? '',
+		];
+		EventEspresso\core\services\licensing\AddonLicense::register($addon_name, $license_data);
+	}
+
+
+	/**
+	 * 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);
+				LoaderFactory::getLoader()->remove($class_name);
+			} catch (OutOfBoundsException $addon_not_yet_registered_exception) {
+				// the add-on was not yet registered in the registry,
+				// so RegistryContainer::__get() throws this exception.
+				// also no need to worry about this or log it,
+				// it's ok to deregister an add-on before its registered in the registry
+			} catch (Exception $e) {
+				new ExceptionLogger($e);
+			}
+			unset(self::$_settings[ $addon_name ]);
+			do_action('AHEE__EE_Register_Addon__deregister__after', $addon_name);
+		}
+	}
+
+
+	public static function reset(): void
+	{
+		EE_Register_Addon::$_settings = [];
+	}
+
+
+	public static function resetAll(): void
+	{
+		// EE_Register_Addon::reset();
+		EE_Register_Admin_Page::reset();
+		EE_Register_Capabilities::reset();
+		EE_Register_Config::reset();
+		EE_Register_CPT::reset();
+		EE_Register_Data_Migration_Scripts::reset();
+		EE_Register_Message_Type::reset();
+		EE_Register_Messages_Shortcode_Library::reset();
+		EE_Register_Messages_Template_Pack::reset();
+		EE_Register_Messages_Template_Variations::reset();
+		EE_Register_Model::reset();
+		EE_Register_Model_Extensions::reset();
+		EE_Register_Module::reset();
+		EE_Register_Payment_Method::reset();
+		EE_Register_Personal_Data_Eraser::reset();
+		EE_Register_Personal_Data_Exporter::reset();
+		EE_Register_Privacy_Policy::reset();
+		EE_Register_Shortcode::reset();
+		EE_Register_Widget::reset();
+	}
 }

Spacing +114 added lines, -114 removed lines

@@ -76,15 +76,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);
@@ -261,7 +261,7 @@ 
     public static function register(string $addon_name = '', array $setup_args = []): bool
     {
         // $addon_name = basename($addon_name);
-        if (! self::$loader instanceof LoaderInterface) {
+        if ( ! self::$loader instanceof LoaderInterface) {
             self::$loader = LoaderFactory::getLoader();
         }
         // make sure this was called in the right place!
@@ -301,7 +301,7 @@ 
         );
         // does this addon work with this version of core or WordPress ?
         // does this addon work with this version of core or WordPress ?
-        if (! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
+        if ( ! EE_Register_Addon::_addon_is_compatible($addon_name, $addon_settings)) {
             return false;
         }
         // register namespaces
@@ -379,7 +379,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__(
@@ -411,7 +411,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;
     }
 
 
@@ -562,14 +562,14 @@ 
 
         // if plugin_action_slug is NOT set...
         if (empty($addon_settings['plugin_action_slug'])) {
-            if (! empty($addon_settings['payment_method_paths'])) {
+            if ( ! empty($addon_settings['payment_method_paths'])) {
                 // but the addon is a payment method
                 $payment_method_path = reset($addon_settings['payment_method_paths']);
                 $plugin_action_slug = basename(strtolower($payment_method_path));
                 $addon_settings['plugin_action_slug'] = $plugin_action_slug;
                 // let's also set the pm_slug to the same value
                 $addon_settings['pm_slug'] = $plugin_action_slug;
-            } elseif (! empty($addon_settings['admin_path'])) {
+            } elseif ( ! empty($addon_settings['admin_path'])) {
                 // or an admin page path IS set
                 $addon_settings['plugin_action_slug'] = basename($addon_settings['admin_path']);
             }
@@ -592,9 +592,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']
             )
         ) {
@@ -605,7 +605,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 />'
             );
@@ -637,7 +637,7 @@ 
                 '</span><br />'
             );
         }
-        if (! empty($incompatibility_message)) {
+        if ( ! empty($incompatibility_message)) {
             // remove 'activate' from the REQUEST
             // so WP doesn't erroneously tell the user the plugin activated fine when it didn't
             /** @var RequestInterface $request */
@@ -648,8 +648,8 @@ 
                 EE_Error::add_error($incompatibility_message, __FILE__, __FUNCTION__, __LINE__);
             }
             unset($_GET['activate'], $_REQUEST['activate']);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename($addon_settings['main_file_path']));
             // BAIL FROM THE ADDON REGISTRATION PROCESS
@@ -699,12 +699,12 @@ 
             // 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).
             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.
@@ -713,10 +713,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;
     }
@@ -729,13 +729,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);
             }
         }
@@ -753,27 +753,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'],
                 ]
             );
         }
@@ -788,10 +788,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']]
             );
         }
     }
@@ -805,12 +805,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'],
                 ]
             );
         }
@@ -824,10 +824,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']]
             );
         }
     }
@@ -840,10 +840,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']]
             );
         }
     }
@@ -857,14 +857,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'] ?? [],
                 ]
             );
         }
@@ -878,10 +878,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']]
             );
         }
     }
@@ -894,12 +894,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'],
                 ]
             );
         }
@@ -912,7 +912,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']
@@ -929,15 +929,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'],
                 ]
             );
         }
@@ -955,10 +955,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']]
             );
         }
     }
@@ -974,10 +974,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']
             );
         }
     }
@@ -989,10 +989,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']
             );
         }
     }
@@ -1004,10 +1004,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']
             );
         }
     }
@@ -1025,14 +1025,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']
                 )
             );
         }
@@ -1044,18 +1044,18 @@ 
         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']);
-        if (! empty(self::$_settings[ $addon_name ]['pm_slug'])) {
-            $addon->setPaymentmethodSlug(self::$_settings[ $addon_name ]['pm_slug']);
+        $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']);
+        if ( ! empty(self::$_settings[$addon_name]['pm_slug'])) {
+            $addon->setPaymentmethodSlug(self::$_settings[$addon_name]['pm_slug']);
         }
         do_action(
             'AHEE__EE_Register_Addon___load_and_init_addon_class',
@@ -1067,10 +1067,10 @@ 
         // because we don't have the plugin's mainfile path upon construction.
         register_deactivation_hook($addon->get_main_plugin_file(), [$addon, 'deactivation']);
         // call any additional admin_callback functions during load_admin_controller hook
-        if (! empty(self::$_settings[ $addon_name ]['admin_callback'])) {
+        if ( ! empty(self::$_settings[$addon_name]['admin_callback'])) {
             add_action(
                 'AHEE__EE_System__load_controllers__load_admin_controllers',
-                [$addon, self::$_settings[ $addon_name ]['admin_callback']]
+                [$addon, self::$_settings[$addon_name]['admin_callback']]
             );
         }
         return $addon;
@@ -1086,19 +1086,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']
                         ),
                     ]
                 );
@@ -1129,7 +1129,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);
                 }
@@ -1148,7 +1148,7 @@ 
         if ($request->isWordPressHeartbeat()) {
             return;
         }
-        $addon_settings = self::$_settings[ $addon_name ] ?? [];
+        $addon_settings = self::$_settings[$addon_name] ?? [];
         if (empty($addon_settings)) {
             return;
         }
@@ -1177,74 +1177,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(
@@ -1268,7 +1268,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/helpers/EEH_Schema.helper.php

Indentation +254 added lines, -254 removed lines

@@ -12,279 +12,279 @@
  */
 class EEH_Schema
 {
-    /**
-     * generates JSON-based linked data for an event
-     *
-     * @param EE_Event $event
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function add_json_linked_data_for_event(EE_Event $event)
-    {
-        // Check we have a valid datetime for the event
-        if (! $event->primary_datetime() instanceof EE_Datetime) {
-            return;
-        }
+	/**
+	 * generates JSON-based linked data for an event
+	 *
+	 * @param EE_Event $event
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function add_json_linked_data_for_event(EE_Event $event)
+	{
+		// Check we have a valid datetime for the event
+		if (! $event->primary_datetime() instanceof EE_Datetime) {
+			return;
+		}
 
-        $template_args                      = [
-            'event_tickets'  => [],
-            'venue_name'     => '',
-            'venue_url'      => '',
-            'venue_locality' => '',
-            'venue_region'   => '',
-            'venue_address'  => '',
-        ];
-        $template_args['event_permalink']   = $event->get_permalink();
-        $template_args['event_name']        = $event->name();
-        $template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
-        // clone datetime so that date formats don't override those for the original datetime
-        $primary_datetime             = clone $event->primary_datetime();
-        $template_args['event_start'] = $primary_datetime->start_date(DateTimeInterface::ATOM);
-        $template_args['event_end']   = $primary_datetime->end_date(DateTimeInterface::ATOM);
-        unset($primary_datetime);
-        switch ($event->status()) {
-            case EEM_Event::cancelled:
-                $event_status = 'EventCancelled';
-                break;
-            case EEM_Event::postponed:
-                $event_status = 'EventPostponed';
-                break;
-            default:
-                $event_status = 'EventScheduled';
-        }
-        $template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
-        $template_args['event_status']          = 'https://schema.org/' . $event_status;
-        $template_args['currency']              = EE_Registry::instance()->CFG->currency->code;
-        foreach ($event->tickets() as $original_ticket) {
-            // clone tickets so that date formats don't override those for the original ticket
-            $ticket                                              = clone $original_ticket;
-            $ID                                                  = $ticket->ID();
-            $template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTimeInterface::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['end_date']   = $ticket->end_date(DateTimeInterface::ATOM, null);
-            $template_args['event_tickets'][ $ID ]['price']      = number_format(
-                $ticket->price(),
-                EE_Registry::instance()->CFG->currency->dec_plc,
-                EE_Registry::instance()->CFG->currency->dec_mrk,
-                ''
-            );
-            switch ($ticket->ticket_status()) {
-                case 'TKO':
-                    $availability = 'InStock';
-                    break;
-                case 'TKS':
-                    $availability = 'SoldOut';
-                    break;
-                default:
-                    $availability = null;
-                    break;
-            }
-            $template_args['event_tickets'][ $ID ]['availability'] = $availability;
-            unset($ticket);
-        }
-        $VNU_ID = espresso_venue_id();
-        if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
-            $venue                           = EEH_Venue_View::get_venue($VNU_ID);
-            $template_args['venue_name']     = get_the_title($VNU_ID);
-            $template_args['venue_url']      = get_permalink($VNU_ID);
-            $template_args['venue_locality'] = $venue->city();
-            $template_args['venue_region']   = $venue->state_name();
-            $template_args['venue_address']  = $venue->address();
-            if ($venue->virtual_url() !== '') {
-                $template_args['event_attendance_mode'] = 'OnlineEventAttendanceMode';
-            }
-            if ($venue->virtual_url() !== '' && $venue->address() !== '') {
-                $template_args['event_attendance_mode'] = 'MixedEventAttendanceMode';
-            }
-        }
-        $template_args['event_image'] = $event->feature_image_url();
-        $template_args                = apply_filters(
-            'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
-            $template_args,
-            $event,
-            $VNU_ID
-        );
-        extract($template_args);
-        include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
-    }
+		$template_args                      = [
+			'event_tickets'  => [],
+			'venue_name'     => '',
+			'venue_url'      => '',
+			'venue_locality' => '',
+			'venue_region'   => '',
+			'venue_address'  => '',
+		];
+		$template_args['event_permalink']   = $event->get_permalink();
+		$template_args['event_name']        = $event->name();
+		$template_args['event_description'] = wp_strip_all_tags($event->short_description(200));
+		// clone datetime so that date formats don't override those for the original datetime
+		$primary_datetime             = clone $event->primary_datetime();
+		$template_args['event_start'] = $primary_datetime->start_date(DateTimeInterface::ATOM);
+		$template_args['event_end']   = $primary_datetime->end_date(DateTimeInterface::ATOM);
+		unset($primary_datetime);
+		switch ($event->status()) {
+			case EEM_Event::cancelled:
+				$event_status = 'EventCancelled';
+				break;
+			case EEM_Event::postponed:
+				$event_status = 'EventPostponed';
+				break;
+			default:
+				$event_status = 'EventScheduled';
+		}
+		$template_args['event_attendance_mode'] = 'OfflineEventAttendanceMode';
+		$template_args['event_status']          = 'https://schema.org/' . $event_status;
+		$template_args['currency']              = EE_Registry::instance()->CFG->currency->code;
+		foreach ($event->tickets() as $original_ticket) {
+			// clone tickets so that date formats don't override those for the original ticket
+			$ticket                                              = clone $original_ticket;
+			$ID                                                  = $ticket->ID();
+			$template_args['event_tickets'][ $ID ]['start_date'] = $ticket->start_date(DateTimeInterface::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['end_date']   = $ticket->end_date(DateTimeInterface::ATOM, null);
+			$template_args['event_tickets'][ $ID ]['price']      = number_format(
+				$ticket->price(),
+				EE_Registry::instance()->CFG->currency->dec_plc,
+				EE_Registry::instance()->CFG->currency->dec_mrk,
+				''
+			);
+			switch ($ticket->ticket_status()) {
+				case 'TKO':
+					$availability = 'InStock';
+					break;
+				case 'TKS':
+					$availability = 'SoldOut';
+					break;
+				default:
+					$availability = null;
+					break;
+			}
+			$template_args['event_tickets'][ $ID ]['availability'] = $availability;
+			unset($ticket);
+		}
+		$VNU_ID = espresso_venue_id();
+		if (! empty($VNU_ID) && ! espresso_is_venue_private($VNU_ID)) {
+			$venue                           = EEH_Venue_View::get_venue($VNU_ID);
+			$template_args['venue_name']     = get_the_title($VNU_ID);
+			$template_args['venue_url']      = get_permalink($VNU_ID);
+			$template_args['venue_locality'] = $venue->city();
+			$template_args['venue_region']   = $venue->state_name();
+			$template_args['venue_address']  = $venue->address();
+			if ($venue->virtual_url() !== '') {
+				$template_args['event_attendance_mode'] = 'OnlineEventAttendanceMode';
+			}
+			if ($venue->virtual_url() !== '' && $venue->address() !== '') {
+				$template_args['event_attendance_mode'] = 'MixedEventAttendanceMode';
+			}
+		}
+		$template_args['event_image'] = $event->feature_image_url();
+		$template_args                = apply_filters(
+			'FHEE__EEH_Schema__add_json_linked_data_for_event__template_args',
+			$template_args,
+			$event,
+			$VNU_ID
+		);
+		extract($template_args);
+		include EE_TEMPLATES . 'json_linked_data_for_event.template.php';
+	}
 
 
-    /**
-     *    location
-     *    The location of the event, organization or action.
-     *    Should include the Venue name AND schema formatted address info
-     *
-     * @param string|null $location
-     * @return string
-     */
-    public static function location(?string $location = ''): string
-    {
-        return ! empty($location)
-            ? "<div itemprop='location' itemscope itemtype='https://schema.org/Place'>$location</div>"
-            : '';
-    }
+	/**
+	 *    location
+	 *    The location of the event, organization or action.
+	 *    Should include the Venue name AND schema formatted address info
+	 *
+	 * @param string|null $location
+	 * @return string
+	 */
+	public static function location(?string $location = ''): string
+	{
+		return ! empty($location)
+			? "<div itemprop='location' itemscope itemtype='https://schema.org/Place'>$location</div>"
+			: '';
+	}
 
 
-    /**
-     *    name
-     *    The name of the Event or Venue.
-     *
-     * @param string|null $name
-     * @return string
-     */
-    public static function name(?string $name = ''): string
-    {
-        return ! empty($name)
-            ? "<span itemprop='name'>$name</span>"
-            : '';
-    }
+	/**
+	 *    name
+	 *    The name of the Event or Venue.
+	 *
+	 * @param string|null $name
+	 * @return string
+	 */
+	public static function name(?string $name = ''): string
+	{
+		return ! empty($name)
+			? "<span itemprop='name'>$name</span>"
+			: '';
+	}
 
 
-    /**
-     *    streetAddress
-     *    The street address. For example, 1600 Amphitheatre Pkwy.
-     *
-     * @param AddressInterface|null $obj_with_address
-     * @return string
-     */
-    public static function streetAddress(?AddressInterface $obj_with_address = null): string
-    {
-        $address = $obj_with_address->address();
-        return ! empty($address)
-            ? "<span itemprop='streetAddress'>$address</span>"
-            : '';
-    }
+	/**
+	 *    streetAddress
+	 *    The street address. For example, 1600 Amphitheatre Pkwy.
+	 *
+	 * @param AddressInterface|null $obj_with_address
+	 * @return string
+	 */
+	public static function streetAddress(?AddressInterface $obj_with_address = null): string
+	{
+		$address = $obj_with_address->address();
+		return ! empty($address)
+			? "<span itemprop='streetAddress'>$address</span>"
+			: '';
+	}
 
 
-    /**
-     *    postOfficeBoxNumber
-     *    The post office box number for PO box addresses.
-     *
-     * @param AddressInterface|null $obj_with_address
-     * @return string
-     */
-    public static function postOfficeBoxNumber(?AddressInterface $obj_with_address = null): string
-    {
-        $address2 = $obj_with_address->address2();
-        // regex check for some form of PO Box or P.O. Box, etc, etc, etc
-        if (
-            preg_match(
-                "/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
-                $address2
-            )
-        ) {
-            return ! empty($address2)
-                ? "<span itemprop='postOfficeBoxNumber'>$address2</span>"
-                : '';
-        }
-        return $address2;
-    }
+	/**
+	 *    postOfficeBoxNumber
+	 *    The post office box number for PO box addresses.
+	 *
+	 * @param AddressInterface|null $obj_with_address
+	 * @return string
+	 */
+	public static function postOfficeBoxNumber(?AddressInterface $obj_with_address = null): string
+	{
+		$address2 = $obj_with_address->address2();
+		// regex check for some form of PO Box or P.O. Box, etc, etc, etc
+		if (
+			preg_match(
+				"/^\s*((P(OST)?.?\s*(O(FF(ICE)?)?)?.?\s+(B(IN|OX))?)|B(IN|OX))/i",
+				$address2
+			)
+		) {
+			return ! empty($address2)
+				? "<span itemprop='postOfficeBoxNumber'>$address2</span>"
+				: '';
+		}
+		return $address2;
+	}
 
 
-    /**
-     *    addressLocality
-     *    The locality (city, town, etc). For example, Mountain View.
-     *
-     * @param AddressInterface|null $obj_with_address
-     * @return string
-     */
-    public static function addressLocality(?AddressInterface $obj_with_address = null): string
-    {
-        $city = $obj_with_address->city();
-        return ! empty($city)
-            ? "<span itemprop='addressLocality'>$city</span>"
-            : '';
-    }
+	/**
+	 *    addressLocality
+	 *    The locality (city, town, etc). For example, Mountain View.
+	 *
+	 * @param AddressInterface|null $obj_with_address
+	 * @return string
+	 */
+	public static function addressLocality(?AddressInterface $obj_with_address = null): string
+	{
+		$city = $obj_with_address->city();
+		return ! empty($city)
+			? "<span itemprop='addressLocality'>$city</span>"
+			: '';
+	}
 
 
-    /**
-     *    addressRegion
-     *    The region (state, province, etc). For example, CA.
-     *
-     * @param AddressInterface|null $obj_with_address
-     * @return string
-     */
-    public static function addressRegion(?AddressInterface $obj_with_address = null): string
-    {
-        $state = $obj_with_address->state_name();
-        return ! empty($state)
-            ? "<span itemprop='addressRegion'>$state</span>"
-            : '';
-    }
+	/**
+	 *    addressRegion
+	 *    The region (state, province, etc). For example, CA.
+	 *
+	 * @param AddressInterface|null $obj_with_address
+	 * @return string
+	 */
+	public static function addressRegion(?AddressInterface $obj_with_address = null): string
+	{
+		$state = $obj_with_address->state_name();
+		return ! empty($state)
+			? "<span itemprop='addressRegion'>$state</span>"
+			: '';
+	}
 
 
-    /**
-     *    addressCountry
-     *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
-     *
-     * @param AddressInterface|null $obj_with_address
-     * @return string
-     */
-    public static function addressCountry(?AddressInterface $obj_with_address = null): string
-    {
-        $country = $obj_with_address->country_name();
-        return ! empty($country)
-            ? "<span itemprop='addressCountry'>$country</span>"
-            : '';
-    }
+	/**
+	 *    addressCountry
+	 *    The country. For example, USA. You can also provide the two-letter ISO 3166-1 alpha-2 country code.
+	 *
+	 * @param AddressInterface|null $obj_with_address
+	 * @return string
+	 */
+	public static function addressCountry(?AddressInterface $obj_with_address = null): string
+	{
+		$country = $obj_with_address->country_name();
+		return ! empty($country)
+			? "<span itemprop='addressCountry'>$country</span>"
+			: '';
+	}
 
 
-    /**
-     *    postalCode
-     *    The postal code. For example, 94043.
-     *
-     * @param AddressInterface|null $obj_with_address
-     * @return string
-     */
-    public static function postalCode(?AddressInterface $obj_with_address = null): string
-    {
-        $postal_code = $obj_with_address->zip();
-        return ! empty($postal_code)
-            ? "<span itemprop='postalCode'>$postal_code</span>"
-            : '';
-    }
+	/**
+	 *    postalCode
+	 *    The postal code. For example, 94043.
+	 *
+	 * @param AddressInterface|null $obj_with_address
+	 * @return string
+	 */
+	public static function postalCode(?AddressInterface $obj_with_address = null): string
+	{
+		$postal_code = $obj_with_address->zip();
+		return ! empty($postal_code)
+			? "<span itemprop='postalCode'>$postal_code</span>"
+			: '';
+	}
 
 
-    /**
-     *    telephone
-     *    The telephone number.
-     *
-     * @param string|null $phone_nmbr
-     * @return string
-     */
-    public static function telephone(?string $phone_nmbr = ''): string
-    {
-        return ! empty($phone_nmbr)
-            ? "<span itemprop='telephone'>$phone_nmbr</span>"
-            : '';
-    }
+	/**
+	 *    telephone
+	 *    The telephone number.
+	 *
+	 * @param string|null $phone_nmbr
+	 * @return string
+	 */
+	public static function telephone(?string $phone_nmbr = ''): string
+	{
+		return ! empty($phone_nmbr)
+			? "<span itemprop='telephone'>$phone_nmbr</span>"
+			: '';
+	}
 
 
-    /**
-     *  URL of the item as a clickable link
-     *
-     * @param string|null $url        - the URL that the link will resolve to
-     * @param string|null $text       - the text that will be used for the visible link
-     * @param array       $attributes - array of additional link attributes in  attribute_name => value pairs. ie:
-     *                                array(
-     *                                'title' => 'click here', 'class' => 'link-class' )
-     * @return string (link)
-     */
-    public static function url(?string $url = '', ?string $text = '', array $attributes = []): string
-    {
-        // Check the URL includes a scheme
-        $parsed_url = parse_url($url);
-        if (empty($parsed_url['scheme'])) {
-            $url = 'https://' . ltrim($url, '/');
-        }
-        $atts = '';
-        foreach ($attributes as $attribute => $value) {
-            $atts .= ' ' . $attribute . '="' . $value . '"';
-        }
-        $text = $text !== null && $text !== ''
-            ? $text
-            : esc_url($url);
-        return ! empty($url)
-            ? '<a itemprop="url" href="' . esc_url_raw($url) . '"' . $atts . '>' . $text . '</a>'
-            : '';
-    }
+	/**
+	 *  URL of the item as a clickable link
+	 *
+	 * @param string|null $url        - the URL that the link will resolve to
+	 * @param string|null $text       - the text that will be used for the visible link
+	 * @param array       $attributes - array of additional link attributes in  attribute_name => value pairs. ie:
+	 *                                array(
+	 *                                'title' => 'click here', 'class' => 'link-class' )
+	 * @return string (link)
+	 */
+	public static function url(?string $url = '', ?string $text = '', array $attributes = []): string
+	{
+		// Check the URL includes a scheme
+		$parsed_url = parse_url($url);
+		if (empty($parsed_url['scheme'])) {
+			$url = 'https://' . ltrim($url, '/');
+		}
+		$atts = '';
+		foreach ($attributes as $attribute => $value) {
+			$atts .= ' ' . $attribute . '="' . $value . '"';
+		}
+		$text = $text !== null && $text !== ''
+			? $text
+			: esc_url($url);
+		return ! empty($url)
+			? '<a itemprop="url" href="' . esc_url_raw($url) . '"' . $atts . '>' . $text . '</a>'
+			: '';
+	}
 }

core/helpers/EEH_Sideloader.helper.php

Indentation +446 added lines, -446 removed lines

@@ -14,450 +14,450 @@
 class EEH_Sideloader extends EEH_Base
 {
 
-    /**
-     * @since   4.10.5.p
-     * @var     string
-     */
-    private string $download_url = '';
-
-    /**
-     * @since   4.1.0
-     * @var     string
-     */
-    private string $upload_path = '';
-
-    /**
-     * @since   4.1.0
-     * @var     int
-     */
-    private int $permissions = 0644;
-
-    /**
-     * @since   4.1.0
-     * @var     string
-     */
-    private string $new_file_name = '';
-
-
-    /**
-     * constructor allows the user to set the properties on the side loader on construction.
-     * However, there are also setters for doing so.
-     *
-     * @param array $props array fo initializing the side loader if keys match the properties.
-     * @since 4.1.0
-     */
-    public function __construct(array $props = [])
-    {
-        // make sure we include the required wp file for necessary functions
-        require_once(ABSPATH . 'wp-admin/includes/file.php');
-        if (! empty($props)) {
-            $this->initialize($props);
-        }
-    }
-
-
-    /**
-     * sets the properties for class either to defaults or using incoming initialization array
-     *
-     * @param array $props values passed to setters
-     * @return void
-     * @since 4.1.0
-     */
-    public function initialize(array $props)
-    {
-        $props = $this->convertOldProps($props);
-        // set defaults
-        $props += [
-            'download_url'  => '',
-            'upload_path'   => EVENT_ESPRESSO_UPLOAD_DIR,
-            'new_file_name' => 'EE_Sideloader_' . uniqid() . '.default',
-            'permissions'   => 0644,
-        ];
-
-        $this->setUploadPath($props['upload_path']);
-        $this->setDownloadUrl($props['download_url']);
-        $this->setPermissions($props['permissions']);
-        $this->setNewFileName($props['new_file_name']);
-    }
-
-
-    private function convertOldProps(array $props): array
-    {
-        // keys are old property names, values are new property names
-        $prop_mapping = [
-            '_upload_to'     => 'upload_path',
-            '_download_from' => 'download_url',
-            '_permissions'   => 'permissions',
-            '_new_file_name' => 'new_file_name',
-        ];
-        foreach ($prop_mapping as $old_key => $new_key) {
-            if (isset($props[ $old_key ])) {
-                $props[ $new_key ] = $props[ $old_key ];
-                unset($props[ $old_key ]);
-            }
-        }
-        return $props;
-    }
-
-
-    // utilities
-
-
-    /**
-     * @return string
-     * @since 4.1.0
-     * @depecated 5.0.42
-     */
-    private function getWpUploadsDir(): string
-    {
-        $uploads = wp_upload_dir();
-        return $uploads['basedir'];
-    }
-
-    // setters
-
-
-    /**
-     * sets the _upload_to property to the directory to upload to.
-     *
-     * @param string $upload_folder
-     * @return void
-     * @since 4.1.0
-     */
-    public function setUploadPath(string $upload_folder): void
-    {
-        $this->upload_path = trailingslashit($upload_folder);
-    }
-
-
-    /**
-     * sets the download_url property to the location we should download the file from.
-     *
-     * @param string $download_url The full path to the file we should side-load.
-     * @return void
-     * @since 4.10.5.p
-     */
-    public function setDownloadUrl(string $download_url): void
-    {
-        $this->download_url = $download_url;
-    }
-
-
-    /**
-     * sets the _permissions property used on the side-loaded file.
-     *
-     * @param int|string $permissions
-     * @return void
-     * @since 4.1.0
-     */
-    public function setPermissions($permissions = 0644): void
-    {
-        $this->permissions = intval($permissions, 8);
-    }
-
-
-    /**
-     * sets the _new_file_name property used on the side-loaded file.
-     *
-     * @param string $new_file_name
-     * @return void
-     * @since 4.1.0
-     */
-    public function setNewFileName(string $new_file_name): void
-    {
-        $this->new_file_name = $new_file_name;
-    }
-
-    // getters
-
-
-    /**
-     * @return string
-     * @since 4.1.0
-     */
-    public function uploadPath(): string
-    {
-        return $this->upload_path;
-    }
-
-
-    /**
-     * @return string
-     * @since 4.10.5.p
-     */
-    public function downloadUrl(): string
-    {
-        return $this->download_url;
-    }
-
-
-    /**
-     * @return int
-     * @since 4.1.0
-     */
-    public function permissions(): int
-    {
-        return $this->permissions;
-    }
-
-
-    /**
-     * @return string
-     * @since 4.1.0
-     */
-    public function newFileName(): string
-    {
-        return $this->new_file_name;
-    }
-
-
-    // upload methods
-
-
-    /**
-     * Downloads the file using the WordPress HTTP API.
-     *
-     * @return bool
-     * @since 4.1.0
-     */
-    public function sideload(): bool
-    {
-        try {
-            // setup temp dir
-            $temp_file = wp_tempnam($this->download_url);
-
-            if (! $temp_file) {
-                throw new RuntimeException(
-                    esc_html__(
-                        'Something went wrong with the upload.  Unable to create a tmp file for the uploaded file on the server',
-                        'event_espresso'
-                    )
-                );
-            }
-
-            do_action('AHEE__EEH_Sideloader__sideload__before', $this, $temp_file);
-
-            $wp_remote_args = apply_filters(
-                'FHEE__EEH_Sideloader__sideload__wp_remote_args',
-                ['timeout' => 500, 'stream' => true, 'filename' => $temp_file],
-                $this,
-                $temp_file
-            );
-
-            $response = wp_safe_remote_get($this->download_url, $wp_remote_args);
-
-            if ($this->isResponseError($response) || $this->isDownloadError($response)) {
-                EEH_File::delete($temp_file);
-                return false;
-            }
-
-            // possible md5 check
-            $content_md5 = wp_remote_retrieve_header($response, 'content-md5');
-            if ($content_md5) {
-                $md5_check = verify_file_md5($temp_file, $content_md5);
-                if ($this->isResponseError($md5_check)) {
-                    EEH_File::delete($temp_file);
-                    return false;
-                }
-            }
-
-            // now we have the file, let's get it in the right directory with the right name.
-            $path = apply_filters(
-                'FHEE__EEH_Sideloader__sideload__new_path',
-                $this->upload_path . $this->new_file_name,
-                $this
-            );
-            if (! EEH_File::move($temp_file, $path, true)) {
-                return false;
-            }
-
-            // set permissions
-            $permissions = apply_filters(
-                'FHEE__EEH_Sideloader__sideload__permissions_applied',
-                $this->permissions,
-                $this
-            );
-            $permissions = intval($permissions, 8);
-            // verify permissions are an integer but don't actually modify the value
-            if (! absint($permissions)) {
-                EE_Error::add_error(
-                    esc_html__('Supplied permissions are invalid', 'event_espresso'),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-                return false;
-            }
-            EEH_File::chmod($path, $permissions);
-
-            // that's it.  let's allow for actions after file uploaded.
-            do_action('AHEE__EE_Sideloader__sideload_after', $this, $path);
-            return true;
-        } catch (Exception $exception) {
-            EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-    }
-
-
-    /**
-     * returns TRUE if there IS an error, FALSE if there is NO ERROR
-     *
-     * @param array|WP_Error $response
-     * @return bool
-     * @throws RuntimeException
-     */
-    private function isResponseError($response): bool
-    {
-        if (! is_wp_error($response)) {
-            return false;
-        }
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The following error occurred while attempting to download the file from "%1$s":',
-                        'event_espresso'
-                    ),
-                    $this->download_url,
-                    $response->get_error_message()
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return true;
-    }
-
-
-    /**
-     * returns TRUE if there IS an error, FALSE if there is NO ERROR
-     *
-     * @param array $response
-     * @return bool
-     * @throws RuntimeException
-     */
-    private function isDownloadError(array $response): bool
-    {
-        $response_code = wp_remote_retrieve_response_code($response);
-        if ($response_code === 200) {
-            return false;
-        }
-        if (defined('WP_DEBUG') && WP_DEBUG && ! defined('EE_TESTS_DIR')) {
-            if ($response_code === 404) {
-                EE_Error::add_attention(
-                    sprintf(
-                        esc_html__(
-                            'Attempted to download a file from "%1$s" but encountered a "404 File Not Found" error.',
-                            'event_espresso'
-                        ),
-                        $this->download_url
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            } else {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'Unable to download the file. Either the path given is incorrect, or something else happened. Here is the path given: %s',
-                            'event_espresso'
-                        ),
-                        $this->download_url
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * @depecated 5.0.42
-     * @return string
-     */
-    public function get_download_from(): string
-    {
-        return $this->downloadUrl();
-    }
-
-
-    /**
-     *
-     * @param string $download_url The full path to the file we should side-load.
-     * @return void
-     * @depecated 5.0.42
-     */
-    public function set_download_from(string $download_url): void
-    {
-        $this->setDownloadUrl($download_url);
-    }
-
-
-    /**
-     * @return string
-     * @depecated 5.0.42
-     */
-    public function get_upload_to(): string
-    {
-        return $this->uploadPath();
-    }
-
-
-    /**
-     * @param string $upload_folder
-     * @return void
-     * @depecated 5.0.42
-     */
-    public function set_upload_to(string $upload_folder): void
-    {
-        $this->setUploadPath($upload_folder);
-    }
-
-
-    /**
-     * @return int
-     * @depecated 5.0.42
-     */
-    public function get_permissions(): int
-    {
-        return $this->permissions();
-    }
-
-
-    /**
-     * @param int|string $permissions
-     * @return void
-     * @depecated 5.0.42
-     */
-    public function set_permissions($permissions): void
-    {
-        $this->setPermissions($permissions);
-    }
-
-
-    /**
-     * @return string
-     * @depecated 5.0.42
-     */
-    public function get_new_file_name(): string
-    {
-        return $this->newFileName();
-    }
-
-
-    /**
-     * @param string $new_file_name
-     * @return void
-     * @depecated 5.0.42
-     */
-    public function set_new_file_name(string $new_file_name): void
-    {
-        $this->setNewFileName($new_file_name);
-    }
+	/**
+	 * @since   4.10.5.p
+	 * @var     string
+	 */
+	private string $download_url = '';
+
+	/**
+	 * @since   4.1.0
+	 * @var     string
+	 */
+	private string $upload_path = '';
+
+	/**
+	 * @since   4.1.0
+	 * @var     int
+	 */
+	private int $permissions = 0644;
+
+	/**
+	 * @since   4.1.0
+	 * @var     string
+	 */
+	private string $new_file_name = '';
+
+
+	/**
+	 * constructor allows the user to set the properties on the side loader on construction.
+	 * However, there are also setters for doing so.
+	 *
+	 * @param array $props array fo initializing the side loader if keys match the properties.
+	 * @since 4.1.0
+	 */
+	public function __construct(array $props = [])
+	{
+		// make sure we include the required wp file for necessary functions
+		require_once(ABSPATH . 'wp-admin/includes/file.php');
+		if (! empty($props)) {
+			$this->initialize($props);
+		}
+	}
+
+
+	/**
+	 * sets the properties for class either to defaults or using incoming initialization array
+	 *
+	 * @param array $props values passed to setters
+	 * @return void
+	 * @since 4.1.0
+	 */
+	public function initialize(array $props)
+	{
+		$props = $this->convertOldProps($props);
+		// set defaults
+		$props += [
+			'download_url'  => '',
+			'upload_path'   => EVENT_ESPRESSO_UPLOAD_DIR,
+			'new_file_name' => 'EE_Sideloader_' . uniqid() . '.default',
+			'permissions'   => 0644,
+		];
+
+		$this->setUploadPath($props['upload_path']);
+		$this->setDownloadUrl($props['download_url']);
+		$this->setPermissions($props['permissions']);
+		$this->setNewFileName($props['new_file_name']);
+	}
+
+
+	private function convertOldProps(array $props): array
+	{
+		// keys are old property names, values are new property names
+		$prop_mapping = [
+			'_upload_to'     => 'upload_path',
+			'_download_from' => 'download_url',
+			'_permissions'   => 'permissions',
+			'_new_file_name' => 'new_file_name',
+		];
+		foreach ($prop_mapping as $old_key => $new_key) {
+			if (isset($props[ $old_key ])) {
+				$props[ $new_key ] = $props[ $old_key ];
+				unset($props[ $old_key ]);
+			}
+		}
+		return $props;
+	}
+
+
+	// utilities
+
+
+	/**
+	 * @return string
+	 * @since 4.1.0
+	 * @depecated 5.0.42
+	 */
+	private function getWpUploadsDir(): string
+	{
+		$uploads = wp_upload_dir();
+		return $uploads['basedir'];
+	}
+
+	// setters
+
+
+	/**
+	 * sets the _upload_to property to the directory to upload to.
+	 *
+	 * @param string $upload_folder
+	 * @return void
+	 * @since 4.1.0
+	 */
+	public function setUploadPath(string $upload_folder): void
+	{
+		$this->upload_path = trailingslashit($upload_folder);
+	}
+
+
+	/**
+	 * sets the download_url property to the location we should download the file from.
+	 *
+	 * @param string $download_url The full path to the file we should side-load.
+	 * @return void
+	 * @since 4.10.5.p
+	 */
+	public function setDownloadUrl(string $download_url): void
+	{
+		$this->download_url = $download_url;
+	}
+
+
+	/**
+	 * sets the _permissions property used on the side-loaded file.
+	 *
+	 * @param int|string $permissions
+	 * @return void
+	 * @since 4.1.0
+	 */
+	public function setPermissions($permissions = 0644): void
+	{
+		$this->permissions = intval($permissions, 8);
+	}
+
+
+	/**
+	 * sets the _new_file_name property used on the side-loaded file.
+	 *
+	 * @param string $new_file_name
+	 * @return void
+	 * @since 4.1.0
+	 */
+	public function setNewFileName(string $new_file_name): void
+	{
+		$this->new_file_name = $new_file_name;
+	}
+
+	// getters
+
+
+	/**
+	 * @return string
+	 * @since 4.1.0
+	 */
+	public function uploadPath(): string
+	{
+		return $this->upload_path;
+	}
+
+
+	/**
+	 * @return string
+	 * @since 4.10.5.p
+	 */
+	public function downloadUrl(): string
+	{
+		return $this->download_url;
+	}
+
+
+	/**
+	 * @return int
+	 * @since 4.1.0
+	 */
+	public function permissions(): int
+	{
+		return $this->permissions;
+	}
+
+
+	/**
+	 * @return string
+	 * @since 4.1.0
+	 */
+	public function newFileName(): string
+	{
+		return $this->new_file_name;
+	}
+
+
+	// upload methods
+
+
+	/**
+	 * Downloads the file using the WordPress HTTP API.
+	 *
+	 * @return bool
+	 * @since 4.1.0
+	 */
+	public function sideload(): bool
+	{
+		try {
+			// setup temp dir
+			$temp_file = wp_tempnam($this->download_url);
+
+			if (! $temp_file) {
+				throw new RuntimeException(
+					esc_html__(
+						'Something went wrong with the upload.  Unable to create a tmp file for the uploaded file on the server',
+						'event_espresso'
+					)
+				);
+			}
+
+			do_action('AHEE__EEH_Sideloader__sideload__before', $this, $temp_file);
+
+			$wp_remote_args = apply_filters(
+				'FHEE__EEH_Sideloader__sideload__wp_remote_args',
+				['timeout' => 500, 'stream' => true, 'filename' => $temp_file],
+				$this,
+				$temp_file
+			);
+
+			$response = wp_safe_remote_get($this->download_url, $wp_remote_args);
+
+			if ($this->isResponseError($response) || $this->isDownloadError($response)) {
+				EEH_File::delete($temp_file);
+				return false;
+			}
+
+			// possible md5 check
+			$content_md5 = wp_remote_retrieve_header($response, 'content-md5');
+			if ($content_md5) {
+				$md5_check = verify_file_md5($temp_file, $content_md5);
+				if ($this->isResponseError($md5_check)) {
+					EEH_File::delete($temp_file);
+					return false;
+				}
+			}
+
+			// now we have the file, let's get it in the right directory with the right name.
+			$path = apply_filters(
+				'FHEE__EEH_Sideloader__sideload__new_path',
+				$this->upload_path . $this->new_file_name,
+				$this
+			);
+			if (! EEH_File::move($temp_file, $path, true)) {
+				return false;
+			}
+
+			// set permissions
+			$permissions = apply_filters(
+				'FHEE__EEH_Sideloader__sideload__permissions_applied',
+				$this->permissions,
+				$this
+			);
+			$permissions = intval($permissions, 8);
+			// verify permissions are an integer but don't actually modify the value
+			if (! absint($permissions)) {
+				EE_Error::add_error(
+					esc_html__('Supplied permissions are invalid', 'event_espresso'),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+				return false;
+			}
+			EEH_File::chmod($path, $permissions);
+
+			// that's it.  let's allow for actions after file uploaded.
+			do_action('AHEE__EE_Sideloader__sideload_after', $this, $path);
+			return true;
+		} catch (Exception $exception) {
+			EE_Error::add_error($exception->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+	}
+
+
+	/**
+	 * returns TRUE if there IS an error, FALSE if there is NO ERROR
+	 *
+	 * @param array|WP_Error $response
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	private function isResponseError($response): bool
+	{
+		if (! is_wp_error($response)) {
+			return false;
+		}
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The following error occurred while attempting to download the file from "%1$s":',
+						'event_espresso'
+					),
+					$this->download_url,
+					$response->get_error_message()
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return true;
+	}
+
+
+	/**
+	 * returns TRUE if there IS an error, FALSE if there is NO ERROR
+	 *
+	 * @param array $response
+	 * @return bool
+	 * @throws RuntimeException
+	 */
+	private function isDownloadError(array $response): bool
+	{
+		$response_code = wp_remote_retrieve_response_code($response);
+		if ($response_code === 200) {
+			return false;
+		}
+		if (defined('WP_DEBUG') && WP_DEBUG && ! defined('EE_TESTS_DIR')) {
+			if ($response_code === 404) {
+				EE_Error::add_attention(
+					sprintf(
+						esc_html__(
+							'Attempted to download a file from "%1$s" but encountered a "404 File Not Found" error.',
+							'event_espresso'
+						),
+						$this->download_url
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			} else {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'Unable to download the file. Either the path given is incorrect, or something else happened. Here is the path given: %s',
+							'event_espresso'
+						),
+						$this->download_url
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * @depecated 5.0.42
+	 * @return string
+	 */
+	public function get_download_from(): string
+	{
+		return $this->downloadUrl();
+	}
+
+
+	/**
+	 *
+	 * @param string $download_url The full path to the file we should side-load.
+	 * @return void
+	 * @depecated 5.0.42
+	 */
+	public function set_download_from(string $download_url): void
+	{
+		$this->setDownloadUrl($download_url);
+	}
+
+
+	/**
+	 * @return string
+	 * @depecated 5.0.42
+	 */
+	public function get_upload_to(): string
+	{
+		return $this->uploadPath();
+	}
+
+
+	/**
+	 * @param string $upload_folder
+	 * @return void
+	 * @depecated 5.0.42
+	 */
+	public function set_upload_to(string $upload_folder): void
+	{
+		$this->setUploadPath($upload_folder);
+	}
+
+
+	/**
+	 * @return int
+	 * @depecated 5.0.42
+	 */
+	public function get_permissions(): int
+	{
+		return $this->permissions();
+	}
+
+
+	/**
+	 * @param int|string $permissions
+	 * @return void
+	 * @depecated 5.0.42
+	 */
+	public function set_permissions($permissions): void
+	{
+		$this->setPermissions($permissions);
+	}
+
+
+	/**
+	 * @return string
+	 * @depecated 5.0.42
+	 */
+	public function get_new_file_name(): string
+	{
+		return $this->newFileName();
+	}
+
+
+	/**
+	 * @param string $new_file_name
+	 * @return void
+	 * @depecated 5.0.42
+	 */
+	public function set_new_file_name(string $new_file_name): void
+	{
+		$this->setNewFileName($new_file_name);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -49,8 +49,8 @@ 
     public function __construct(array $props = [])
     {
         // make sure we include the required wp file for necessary functions
-        require_once(ABSPATH . 'wp-admin/includes/file.php');
-        if (! empty($props)) {
+        require_once(ABSPATH.'wp-admin/includes/file.php');
+        if ( ! empty($props)) {
             $this->initialize($props);
         }
     }
@@ -70,7 +70,7 @@ 
         $props += [
             'download_url'  => '',
             'upload_path'   => EVENT_ESPRESSO_UPLOAD_DIR,
-            'new_file_name' => 'EE_Sideloader_' . uniqid() . '.default',
+            'new_file_name' => 'EE_Sideloader_'.uniqid().'.default',
             'permissions'   => 0644,
         ];
 
@@ -91,9 +91,9 @@ 
             '_new_file_name' => 'new_file_name',
         ];
         foreach ($prop_mapping as $old_key => $new_key) {
-            if (isset($props[ $old_key ])) {
-                $props[ $new_key ] = $props[ $old_key ];
-                unset($props[ $old_key ]);
+            if (isset($props[$old_key])) {
+                $props[$new_key] = $props[$old_key];
+                unset($props[$old_key]);
             }
         }
         return $props;
@@ -226,7 +226,7 @@ 
             // setup temp dir
             $temp_file = wp_tempnam($this->download_url);
 
-            if (! $temp_file) {
+            if ( ! $temp_file) {
                 throw new RuntimeException(
                     esc_html__(
                         'Something went wrong with the upload.  Unable to create a tmp file for the uploaded file on the server',
@@ -264,10 +264,10 @@ 
             // now we have the file, let's get it in the right directory with the right name.
             $path = apply_filters(
                 'FHEE__EEH_Sideloader__sideload__new_path',
-                $this->upload_path . $this->new_file_name,
+                $this->upload_path.$this->new_file_name,
                 $this
             );
-            if (! EEH_File::move($temp_file, $path, true)) {
+            if ( ! EEH_File::move($temp_file, $path, true)) {
                 return false;
             }
 
@@ -279,7 +279,7 @@ 
             );
             $permissions = intval($permissions, 8);
             // verify permissions are an integer but don't actually modify the value
-            if (! absint($permissions)) {
+            if ( ! absint($permissions)) {
                 EE_Error::add_error(
                     esc_html__('Supplied permissions are invalid', 'event_espresso'),
                     __FILE__,
@@ -309,7 +309,7 @@ 
      */
     private function isResponseError($response): bool
     {
-        if (! is_wp_error($response)) {
+        if ( ! is_wp_error($response)) {
             return false;
         }
         if (defined('WP_DEBUG') && WP_DEBUG) {