eventespresso / event-espresso-core

core/helpers/EEH_URL.helper.php

Doc Comments +1 added lines, -1 removed lines

@@ -241,7 +241,7 @@
     /**
      * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
      *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
+     * @param string[] $query_parameters An array of query_parameters to remove from the current url.
      * @return string
      * @since 4.9.46.rc.029
      */

Indentation +252 added lines, -252 removed lines

@@ -12,278 +12,278 @@
 class EEH_URL
 {
 
-    /**
-     * _add_query_arg
-     * adds nonce to array of arguments then calls WP add_query_arg function
-     *
-     * @param array  $args
-     * @param string $url
-     * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
-     * @return string
-     */
-    public static function add_query_args_and_nonce(
-        array $args = [],
-        string $url = '',
-        bool $exclude_nonce = false
-    ): string {
-        // check that an action exists and add nonce
-        if (! $exclude_nonce) {
-            if (isset($args['action']) && ! empty($args['action'])) {
-                $args = array_merge(
-                    $args,
-                    [
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
-                    ]
-                );
-            } else {
-                $args = array_merge(
-                    $args,
-                    [
-                        'action'        => 'default',
-                        'default_nonce' => wp_create_nonce('default_nonce'),
-                    ]
-                );
-            }
-        }
+	/**
+	 * _add_query_arg
+	 * adds nonce to array of arguments then calls WP add_query_arg function
+	 *
+	 * @param array  $args
+	 * @param string $url
+	 * @param bool   $exclude_nonce If true then the nonce will be excluded from the generated url.
+	 * @return string
+	 */
+	public static function add_query_args_and_nonce(
+		array $args = [],
+		string $url = '',
+		bool $exclude_nonce = false
+	): string {
+		// check that an action exists and add nonce
+		if (! $exclude_nonce) {
+			if (isset($args['action']) && ! empty($args['action'])) {
+				$args = array_merge(
+					$args,
+					[
+						$args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
+					]
+				);
+			} else {
+				$args = array_merge(
+					$args,
+					[
+						'action'        => 'default',
+						'default_nonce' => wp_create_nonce('default_nonce'),
+					]
+				);
+			}
+		}
 
-        // finally, let's always add a return address (if present) :)
-        $args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
-            ? array_merge($args, ['return' => $_REQUEST['action']])
-            : $args;
+		// finally, let's always add a return address (if present) :)
+		$args = ! empty($_REQUEST['action']) && ! isset($_REQUEST['return'])
+			? array_merge($args, ['return' => $_REQUEST['action']])
+			: $args;
 
-        return add_query_arg($args, $url);
-    }
+		return add_query_arg($args, $url);
+	}
 
 
-    /**
-     * Returns whether not the remote file exists.
-     * Checking via GET because HEAD requests are blocked on some server configurations.
-     *
-     * @param string $url
-     * @param array  $args the arguments that should be passed through to the wp_remote_request call.
-     * @return boolean
-     */
-    public static function remote_file_exists(string $url, array $args = []): bool
-    {
-        $results = wp_remote_request(
-            $url,
-            array_merge(
-                [
-                    'method'      => 'GET',
-                    'redirection' => 1,
-                ],
-                $args
-            )
-        );
-        if (! $results instanceof WP_Error
-            && isset($results['response'])
-            && isset($results['response']['code'])
-            && $results['response']['code'] == '200'
-        ) {
-            return true;
-        } else {
-            return false;
-        }
-    }
+	/**
+	 * Returns whether not the remote file exists.
+	 * Checking via GET because HEAD requests are blocked on some server configurations.
+	 *
+	 * @param string $url
+	 * @param array  $args the arguments that should be passed through to the wp_remote_request call.
+	 * @return boolean
+	 */
+	public static function remote_file_exists(string $url, array $args = []): bool
+	{
+		$results = wp_remote_request(
+			$url,
+			array_merge(
+				[
+					'method'      => 'GET',
+					'redirection' => 1,
+				],
+				$args
+			)
+		);
+		if (! $results instanceof WP_Error
+			&& isset($results['response'])
+			&& isset($results['response']['code'])
+			&& $results['response']['code'] == '200'
+		) {
+			return true;
+		} else {
+			return false;
+		}
+	}
 
 
-    /**
-     * refactor_url
-     * primarily used for removing the query string from a URL
-     *
-     * @param string $url
-     * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
-     * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
-     * @return string
-     */
-    public static function refactor_url(
-        string $url = '',
-        bool $remove_query = true,
-        bool $base_url_only = false
-    ): string {
-        // break apart incoming URL
-        $url_bits = parse_url($url);
-        // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
-        // domain
-        $host = isset($url_bits['host']) ? $url_bits['host'] : '';
-        // if only the base URL is requested, then return that now
-        if ($base_url_only) {
-            return $scheme . $host;
-        }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
-        $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
-        $path = isset($url_bits['path']) ? $url_bits['path'] : '';
-        // if the query string is not required, then return what we have so far
-        if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
-        }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
-    }
+	/**
+	 * refactor_url
+	 * primarily used for removing the query string from a URL
+	 *
+	 * @param string $url
+	 * @param bool   $remove_query  - TRUE (default) will strip off any URL params, ie: ?this=1&that=2
+	 * @param bool   $base_url_only - TRUE will only return the scheme and host with no other parameters
+	 * @return string
+	 */
+	public static function refactor_url(
+		string $url = '',
+		bool $remove_query = true,
+		bool $base_url_only = false
+	): string {
+		// break apart incoming URL
+		$url_bits = parse_url($url);
+		// HTTP or HTTPS ?
+		$scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
+		// domain
+		$host = isset($url_bits['host']) ? $url_bits['host'] : '';
+		// if only the base URL is requested, then return that now
+		if ($base_url_only) {
+			return $scheme . $host;
+		}
+		$port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+		$user = isset($url_bits['user']) ? $url_bits['user'] : '';
+		$pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
+		$pass = ($user || $pass) ? $pass . '@' : '';
+		$path = isset($url_bits['path']) ? $url_bits['path'] : '';
+		// if the query string is not required, then return what we have so far
+		if ($remove_query) {
+			return $scheme . $user . $pass . $host . $port . $path;
+		}
+		$query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
+		$fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
+		return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+	}
 
 
-    /**
-     * get_query_string
-     * returns just the query string from a URL, formatted by default into an array of key value pairs
-     *
-     * @param string $url
-     * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
-     *                         simply return the query string
-     * @return string|array
-     */
-    public static function get_query_string(string $url = '', bool $as_array = true)
-    {
-        // decode, then break apart incoming URL
-        $url_bits = parse_url(html_entity_decode($url));
-        // grab query string from URL
-        $query = isset($url_bits['query']) ? $url_bits['query'] : '';
-        // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
-            return $query;
-        }
-        // if no query string exists then just return an empty array now
-        if (empty($query)) {
-            return [];
-        }
-        // empty array to hold results
-        $query_params = [];
-        // now break apart the query string into separate params
-        $query = explode('&', $query);
-        // loop thru our query params
-        foreach ($query as $query_args) {
-            // break apart the key value pairs
-            $query_args = explode('=', $query_args);
-            // and add to our results array
-            $query_params[ $query_args[0] ] = $query_args[1];
-        }
-        return $query_params;
-    }
+	/**
+	 * get_query_string
+	 * returns just the query string from a URL, formatted by default into an array of key value pairs
+	 *
+	 * @param string $url
+	 * @param bool   $as_array TRUE (default) will return query params as an array of key value pairs, FALSE will
+	 *                         simply return the query string
+	 * @return string|array
+	 */
+	public static function get_query_string(string $url = '', bool $as_array = true)
+	{
+		// decode, then break apart incoming URL
+		$url_bits = parse_url(html_entity_decode($url));
+		// grab query string from URL
+		$query = isset($url_bits['query']) ? $url_bits['query'] : '';
+		// if we don't want the query string formatted into an array of key => value pairs, then just return it as is
+		if (! $as_array) {
+			return $query;
+		}
+		// if no query string exists then just return an empty array now
+		if (empty($query)) {
+			return [];
+		}
+		// empty array to hold results
+		$query_params = [];
+		// now break apart the query string into separate params
+		$query = explode('&', $query);
+		// loop thru our query params
+		foreach ($query as $query_args) {
+			// break apart the key value pairs
+			$query_args = explode('=', $query_args);
+			// and add to our results array
+			$query_params[ $query_args[0] ] = $query_args[1];
+		}
+		return $query_params;
+	}
 
 
-    /**
-     * prevent_prefetching
-     *
-     * @return void
-     */
-    public static function prevent_prefetching()
-    {
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
-        // with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
+	/**
+	 * prevent_prefetching
+	 *
+	 * @return void
+	 */
+	public static function prevent_prefetching()
+	{
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes
+		// with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
 
 
-    /**
-     * This generates a unique site-specific string.
-     * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
-     * urls.
-     *
-     * @param string $prefix Use this to prefix the string with something.
-     * @return string
-     */
-    public static function generate_unique_token(string $prefix = ''): string
-    {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
-    }
+	/**
+	 * This generates a unique site-specific string.
+	 * An example usage for this string would be to save as a unique identifier for a record in the db for usage in
+	 * urls.
+	 *
+	 * @param string $prefix Use this to prefix the string with something.
+	 * @return string
+	 */
+	public static function generate_unique_token(string $prefix = ''): string
+	{
+		$token = md5(uniqid() . mt_rand());
+		return $prefix ? $prefix . '_' . $token : $token;
+	}
 
 
-    /**
-     * filter_input_server_url
-     * uses filter_input() to sanitize one of the INPUT_SERVER URL values
-     * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
-     *
-     * @param string $server_variable
-     * @return string
-     */
-    public static function filter_input_server_url(string $server_variable = 'REQUEST_URI'): string
-    {
-        $URL              = '';
-        $server_variables = [
-            'REQUEST_URI' => 1,
-            'HTTP_HOST'   => 1,
-            'PHP_SELF'    => 1,
-        ];
-        $server_variable  = strtoupper($server_variable);
-        // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
-            $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
-            if (empty($URL)) {
-                // fallback sanitization if the above fails
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
-            }
-        }
-        return $URL;
-    }
+	/**
+	 * filter_input_server_url
+	 * uses filter_input() to sanitize one of the INPUT_SERVER URL values
+	 * but adds a backup in case filter_input() returns nothing, which can erringly happen on some servers
+	 *
+	 * @param string $server_variable
+	 * @return string
+	 */
+	public static function filter_input_server_url(string $server_variable = 'REQUEST_URI'): string
+	{
+		$URL              = '';
+		$server_variables = [
+			'REQUEST_URI' => 1,
+			'HTTP_HOST'   => 1,
+			'PHP_SELF'    => 1,
+		];
+		$server_variable  = strtoupper($server_variable);
+		// whitelist INPUT_SERVER var
+		if (isset($server_variables[ $server_variable ])) {
+			$URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
+			if (empty($URL)) {
+				// fallback sanitization if the above fails
+				$URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+			}
+		}
+		return $URL;
+	}
 
 
-    /**
-     * Gets the current page's full URL.
-     *
-     * @return string
-     */
-    public static function current_url(): string
-    {
-        $url = '';
-        if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
-            $url = is_ssl() ? 'https://' : 'http://';
-            $url .= EEH_URL::filter_input_server_url('HTTP_HOST');
-            $url .= EEH_URL::filter_input_server_url('REQUEST_URI');
-        }
-        return $url;
-    }
+	/**
+	 * Gets the current page's full URL.
+	 *
+	 * @return string
+	 */
+	public static function current_url(): string
+	{
+		$url = '';
+		if (isset($_SERVER['HTTP_HOST'], $_SERVER['REQUEST_URI'])) {
+			$url = is_ssl() ? 'https://' : 'http://';
+			$url .= EEH_URL::filter_input_server_url('HTTP_HOST');
+			$url .= EEH_URL::filter_input_server_url('REQUEST_URI');
+		}
+		return $url;
+	}
 
 
-    /**
-     * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
-     *
-     * @param array $query_parameters An array of query_parameters to remove from the current url.
-     * @return string
-     * @since 4.9.46.rc.029
-     */
-    public static function current_url_without_query_paramaters(array $query_parameters): string
-    {
-        return remove_query_arg($query_parameters, EEH_URL::current_url());
-    }
+	/**
+	 * Identical in functionality to EEH_current_url except it removes any provided query_parameters from it.
+	 *
+	 * @param array $query_parameters An array of query_parameters to remove from the current url.
+	 * @return string
+	 * @since 4.9.46.rc.029
+	 */
+	public static function current_url_without_query_paramaters(array $query_parameters): string
+	{
+		return remove_query_arg($query_parameters, EEH_URL::current_url());
+	}
 
 
-    /**
-     * @param string $location
-     * @param int    $status
-     * @param string $exit_notice
-     */
-    public static function safeRedirectAndExit(string $location, int $status = 302, string $exit_notice = '')
-    {
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect($location, $status);
-        exit($exit_notice);
-    }
+	/**
+	 * @param string $location
+	 * @param int    $status
+	 * @param string $exit_notice
+	 */
+	public static function safeRedirectAndExit(string $location, int $status = 302, string $exit_notice = '')
+	{
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect($location, $status);
+		exit($exit_notice);
+	}
 
 
-    /**
-     * Slugifies text for usage in a URL.
-     *
-     * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
-     * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
-     *
-     * @param string $text
-     * @param string $fallback
-     * @return string which can be used in a URL
-     * @since 4.9.66.p
-     */
-    public static function slugify(string $text, string $fallback): string
-    {
-        // url decode after sanitizing title to restore unicode characters,
-        // see https://github.com/eventespresso/event-espresso-core/issues/575
-        return urldecode(
-            sanitize_title(
-                $text,
-                $fallback
-            )
-        );
-    }
+	/**
+	 * Slugifies text for usage in a URL.
+	 *
+	 * Currently, this isn't just calling `sanitize_title()` on it, because that percent-encodes unicode characters,
+	 * and WordPress chokes on them when used as CPT and custom taxonomy slugs.
+	 *
+	 * @param string $text
+	 * @param string $fallback
+	 * @return string which can be used in a URL
+	 * @since 4.9.66.p
+	 */
+	public static function slugify(string $text, string $fallback): string
+	{
+		// url decode after sanitizing title to restore unicode characters,
+		// see https://github.com/eventespresso/event-espresso-core/issues/575
+		return urldecode(
+			sanitize_title(
+				$text,
+				$fallback
+			)
+		);
+	}
 }

Spacing +19 added lines, -19 removed lines

@@ -27,12 +27,12 @@ 
         bool $exclude_nonce = false
     ): string {
         // check that an action exists and add nonce
-        if (! $exclude_nonce) {
+        if ( ! $exclude_nonce) {
             if (isset($args['action']) && ! empty($args['action'])) {
                 $args = array_merge(
                     $args,
                     [
-                        $args['action'] . '_nonce' => wp_create_nonce($args['action'] . '_nonce'),
+                        $args['action'].'_nonce' => wp_create_nonce($args['action'].'_nonce'),
                     ]
                 );
             } else {
@@ -75,7 +75,7 @@ 
                 $args
             )
         );
-        if (! $results instanceof WP_Error
+        if ( ! $results instanceof WP_Error
             && isset($results['response'])
             && isset($results['response']['code'])
             && $results['response']['code'] == '200'
@@ -104,25 +104,25 @@ 
         // break apart incoming URL
         $url_bits = parse_url($url);
         // HTTP or HTTPS ?
-        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'] . '://' : 'http://';
+        $scheme = isset($url_bits['scheme']) ? $url_bits['scheme'].'://' : 'http://';
         // domain
         $host = isset($url_bits['host']) ? $url_bits['host'] : '';
         // if only the base URL is requested, then return that now
         if ($base_url_only) {
-            return $scheme . $host;
+            return $scheme.$host;
         }
-        $port = isset($url_bits['port']) ? ':' . $url_bits['port'] : '';
+        $port = isset($url_bits['port']) ? ':'.$url_bits['port'] : '';
         $user = isset($url_bits['user']) ? $url_bits['user'] : '';
-        $pass = isset($url_bits['pass']) ? ':' . $url_bits['pass'] : '';
-        $pass = ($user || $pass) ? $pass . '@' : '';
+        $pass = isset($url_bits['pass']) ? ':'.$url_bits['pass'] : '';
+        $pass = ($user || $pass) ? $pass.'@' : '';
         $path = isset($url_bits['path']) ? $url_bits['path'] : '';
         // if the query string is not required, then return what we have so far
         if ($remove_query) {
-            return $scheme . $user . $pass . $host . $port . $path;
+            return $scheme.$user.$pass.$host.$port.$path;
         }
-        $query    = isset($url_bits['query']) ? '?' . $url_bits['query'] : '';
-        $fragment = isset($url_bits['fragment']) ? '#' . $url_bits['fragment'] : '';
-        return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
+        $query    = isset($url_bits['query']) ? '?'.$url_bits['query'] : '';
+        $fragment = isset($url_bits['fragment']) ? '#'.$url_bits['fragment'] : '';
+        return $scheme.$user.$pass.$host.$port.$path.$query.$fragment;
     }
 
 
@@ -142,7 +142,7 @@ 
         // grab query string from URL
         $query = isset($url_bits['query']) ? $url_bits['query'] : '';
         // if we don't want the query string formatted into an array of key => value pairs, then just return it as is
-        if (! $as_array) {
+        if ( ! $as_array) {
             return $query;
         }
         // if no query string exists then just return an empty array now
@@ -158,7 +158,7 @@ 
             // break apart the key value pairs
             $query_args = explode('=', $query_args);
             // and add to our results array
-            $query_params[ $query_args[0] ] = $query_args[1];
+            $query_params[$query_args[0]] = $query_args[1];
         }
         return $query_params;
     }
@@ -187,8 +187,8 @@ 
      */
     public static function generate_unique_token(string $prefix = ''): string
     {
-        $token = md5(uniqid() . mt_rand());
-        return $prefix ? $prefix . '_' . $token : $token;
+        $token = md5(uniqid().mt_rand());
+        return $prefix ? $prefix.'_'.$token : $token;
     }
 
 
@@ -208,13 +208,13 @@ 
             'HTTP_HOST'   => 1,
             'PHP_SELF'    => 1,
         ];
-        $server_variable  = strtoupper($server_variable);
+        $server_variable = strtoupper($server_variable);
         // whitelist INPUT_SERVER var
-        if (isset($server_variables[ $server_variable ])) {
+        if (isset($server_variables[$server_variable])) {
             $URL = filter_input(INPUT_SERVER, $server_variable, FILTER_SANITIZE_URL, FILTER_NULL_ON_FAILURE);
             if (empty($URL)) {
                 // fallback sanitization if the above fails
-                $URL = wp_sanitize_redirect($_SERVER[ $server_variable ]);
+                $URL = wp_sanitize_redirect($_SERVER[$server_variable]);
             }
         }
         return $URL;

core/libraries/plugin_api/EE_Register_CPT.lib.php

Doc Comments +1 added lines, -1 removed lines

@@ -31,7 +31,7 @@
      *                                        An array of required values for registering the cpts and taxonomies
      * @type array   $cpts                    {
      *                                        An array of cpts and their arguments.(short example below)
-     * @return void
+     * @return boolean
      * @throws  EE_Error
      * @see CustomPostTypeDefinitions::setDefinitions for a more complete example.
      *                                        'people' => array(

Indentation +229 added lines, -229 removed lines

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

Spacing +10 added lines, -10 removed lines

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

core/Psr4Autoloader.php

Doc Comments +1 added lines, -1 removed lines

@@ -152,7 +152,7 @@
      *
      * @param string $prefix            The namespace prefix.
      * @param string $relative_class    The relative class name.
-     * @return mixed                    Boolean false if no mapped file can be loaded,
+     * @return string|false                    Boolean false if no mapped file can be loaded,
      *                                  or the name of the mapped file that was loaded.
      */
     protected function loadMappedFile(string $prefix, string $relative_class)

Indentation +143 added lines, -143 removed lines

@@ -47,147 +47,147 @@
 class Psr4Autoloader
 {
 
-    /**
-     * namespace separator
-     */
-    const NS = '\\';
-
-    /**
-     * An associative array where the key is a namespace prefix and the value
-     * is an array of base directories for classes in that namespace.
-     *
-     * @var array
-     */
-    protected $prefixes = [];
-
-
-    /**
-     * returns an array of registered namespace prefixes
-     *
-     * @param string $prefix
-     * @return array
-     */
-    public function prefixes(string $prefix = ''): array
-    {
-        if (! empty($prefix)) {
-            // are there any base directories for this namespace prefix?
-            return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : [];
-        }
-        return $this->prefixes;
-    }
-
-
-    /**
-     * Register loader with SPL autoloader stack.
-     *
-     * @return void
-     */
-    public function register()
-    {
-        spl_autoload_register([$this, 'loadClass']);
-    }
-
-
-    /**
-     * Adds a base directory for a namespace prefix.
-     *
-     * @param string $prefix    The namespace prefix.
-     * @param string $base_dir  A base directory for class files in the namespace.
-     * @param bool $prepend     If true, prepend the base directory to the stack instead of appending it;
-     *                          this causes it to be searched first rather than last.
-     * @return bool             returns TRUE if the namespace was successfully added
-     */
-    public function addNamespace(string $prefix, string $base_dir, bool $prepend = false): bool
-    {
-        // normalize namespace prefix
-        $prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
-        // normalize the base directory with a trailing separator
-        $base_dir = EEH_File::standardise_and_end_with_directory_separator($base_dir);
-        // initialize the namespace prefix array
-        if (! isset($this->prefixes[ $prefix ])) {
-            $this->prefixes[ $prefix ] = [];
-        }
-        // retain the base directory for the namespace prefix
-        if ($prepend) {
-            array_unshift($this->prefixes[ $prefix ], $base_dir);
-        } else {
-            $this->prefixes[ $prefix ][] = $base_dir;
-        }
-        return isset($this->prefixes[ $prefix ]);
-    }
-
-
-    /**
-     * Loads the class file for a given class name.
-     *
-     * @param string $class The fully-qualified class name.
-     * @return string        The mapped file name on success, or boolean false on failure.
-     */
-    public function loadClass(string $class): string
-    {
-        // the current namespace prefix
-        $prefix = $class;
-        // work backwards through the namespace names of the fully-qualified
-        // class name to find a mapped file name
-        while (false !== $pos = strrpos($prefix, Psr4Autoloader::NS)) {
-            // retain the trailing namespace separator in the prefix
-            $prefix = substr($class, 0, $pos + 1);
-            // the rest is the relative class name
-            $relative_class = substr($class, $pos + 1);
-            // try to load a mapped file for the prefix and relative class
-            $mapped_file = $this->loadMappedFile($prefix, $relative_class);
-            if ($mapped_file) {
-                return $mapped_file;
-            }
-            // remove the trailing namespace separator for the next iteration of strrpos()
-            $prefix = rtrim($prefix, Psr4Autoloader::NS);
-        }
-        // never found a mapped file
-        return '';
-    }
-
-
-    /**
-     * Load the mapped file for a namespace prefix and relative class.
-     *
-     * @param string $prefix            The namespace prefix.
-     * @param string $relative_class    The relative class name.
-     * @return mixed                    Boolean false if no mapped file can be loaded,
-     *                                  or the name of the mapped file that was loaded.
-     */
-    protected function loadMappedFile(string $prefix, string $relative_class)
-    {
-        // look through base directories for this namespace prefix
-        foreach ($this->prefixes($prefix) as $base_dir) {
-            // replace the namespace prefix with the base directory,
-            // replace namespace separators with directory separators
-            // in the relative class name, append with .php
-            $file = $base_dir
-                    . str_replace(Psr4Autoloader::NS, '/', $relative_class)
-                    . '.php';
-            // if the mapped file exists, require it
-            if ($this->requireFile($file)) {
-                // yes, we're done
-                return $file;
-            }
-        }
-        // never found it
-        return false;
-    }
-
-
-    /**
-     * If a file exists, require it from the file system.
-     *
-     * @param string $file  The file to require.
-     * @return bool         True if the file exists, false if not.
-     */
-    protected function requireFile(string $file): bool
-    {
-        if (file_exists($file)) {
-            require $file;
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * namespace separator
+	 */
+	const NS = '\\';
+
+	/**
+	 * An associative array where the key is a namespace prefix and the value
+	 * is an array of base directories for classes in that namespace.
+	 *
+	 * @var array
+	 */
+	protected $prefixes = [];
+
+
+	/**
+	 * returns an array of registered namespace prefixes
+	 *
+	 * @param string $prefix
+	 * @return array
+	 */
+	public function prefixes(string $prefix = ''): array
+	{
+		if (! empty($prefix)) {
+			// are there any base directories for this namespace prefix?
+			return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : [];
+		}
+		return $this->prefixes;
+	}
+
+
+	/**
+	 * Register loader with SPL autoloader stack.
+	 *
+	 * @return void
+	 */
+	public function register()
+	{
+		spl_autoload_register([$this, 'loadClass']);
+	}
+
+
+	/**
+	 * Adds a base directory for a namespace prefix.
+	 *
+	 * @param string $prefix    The namespace prefix.
+	 * @param string $base_dir  A base directory for class files in the namespace.
+	 * @param bool $prepend     If true, prepend the base directory to the stack instead of appending it;
+	 *                          this causes it to be searched first rather than last.
+	 * @return bool             returns TRUE if the namespace was successfully added
+	 */
+	public function addNamespace(string $prefix, string $base_dir, bool $prepend = false): bool
+	{
+		// normalize namespace prefix
+		$prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
+		// normalize the base directory with a trailing separator
+		$base_dir = EEH_File::standardise_and_end_with_directory_separator($base_dir);
+		// initialize the namespace prefix array
+		if (! isset($this->prefixes[ $prefix ])) {
+			$this->prefixes[ $prefix ] = [];
+		}
+		// retain the base directory for the namespace prefix
+		if ($prepend) {
+			array_unshift($this->prefixes[ $prefix ], $base_dir);
+		} else {
+			$this->prefixes[ $prefix ][] = $base_dir;
+		}
+		return isset($this->prefixes[ $prefix ]);
+	}
+
+
+	/**
+	 * Loads the class file for a given class name.
+	 *
+	 * @param string $class The fully-qualified class name.
+	 * @return string        The mapped file name on success, or boolean false on failure.
+	 */
+	public function loadClass(string $class): string
+	{
+		// the current namespace prefix
+		$prefix = $class;
+		// work backwards through the namespace names of the fully-qualified
+		// class name to find a mapped file name
+		while (false !== $pos = strrpos($prefix, Psr4Autoloader::NS)) {
+			// retain the trailing namespace separator in the prefix
+			$prefix = substr($class, 0, $pos + 1);
+			// the rest is the relative class name
+			$relative_class = substr($class, $pos + 1);
+			// try to load a mapped file for the prefix and relative class
+			$mapped_file = $this->loadMappedFile($prefix, $relative_class);
+			if ($mapped_file) {
+				return $mapped_file;
+			}
+			// remove the trailing namespace separator for the next iteration of strrpos()
+			$prefix = rtrim($prefix, Psr4Autoloader::NS);
+		}
+		// never found a mapped file
+		return '';
+	}
+
+
+	/**
+	 * Load the mapped file for a namespace prefix and relative class.
+	 *
+	 * @param string $prefix            The namespace prefix.
+	 * @param string $relative_class    The relative class name.
+	 * @return mixed                    Boolean false if no mapped file can be loaded,
+	 *                                  or the name of the mapped file that was loaded.
+	 */
+	protected function loadMappedFile(string $prefix, string $relative_class)
+	{
+		// look through base directories for this namespace prefix
+		foreach ($this->prefixes($prefix) as $base_dir) {
+			// replace the namespace prefix with the base directory,
+			// replace namespace separators with directory separators
+			// in the relative class name, append with .php
+			$file = $base_dir
+					. str_replace(Psr4Autoloader::NS, '/', $relative_class)
+					. '.php';
+			// if the mapped file exists, require it
+			if ($this->requireFile($file)) {
+				// yes, we're done
+				return $file;
+			}
+		}
+		// never found it
+		return false;
+	}
+
+
+	/**
+	 * If a file exists, require it from the file system.
+	 *
+	 * @param string $file  The file to require.
+	 * @return bool         True if the file exists, false if not.
+	 */
+	protected function requireFile(string $file): bool
+	{
+		if (file_exists($file)) {
+			require $file;
+			return true;
+		}
+		return false;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -69,9 +69,9 @@ 
      */
     public function prefixes(string $prefix = ''): array
     {
-        if (! empty($prefix)) {
+        if ( ! empty($prefix)) {
             // are there any base directories for this namespace prefix?
-            return isset($this->prefixes[ $prefix ]) ? $this->prefixes[ $prefix ] : [];
+            return isset($this->prefixes[$prefix]) ? $this->prefixes[$prefix] : [];
         }
         return $this->prefixes;
     }
@@ -100,20 +100,20 @@ 
     public function addNamespace(string $prefix, string $base_dir, bool $prepend = false): bool
     {
         // normalize namespace prefix
-        $prefix = trim($prefix, Psr4Autoloader::NS) . Psr4Autoloader::NS;
+        $prefix = trim($prefix, Psr4Autoloader::NS).Psr4Autoloader::NS;
         // normalize the base directory with a trailing separator
         $base_dir = EEH_File::standardise_and_end_with_directory_separator($base_dir);
         // initialize the namespace prefix array
-        if (! isset($this->prefixes[ $prefix ])) {
-            $this->prefixes[ $prefix ] = [];
+        if ( ! isset($this->prefixes[$prefix])) {
+            $this->prefixes[$prefix] = [];
         }
         // retain the base directory for the namespace prefix
         if ($prepend) {
-            array_unshift($this->prefixes[ $prefix ], $base_dir);
+            array_unshift($this->prefixes[$prefix], $base_dir);
         } else {
-            $this->prefixes[ $prefix ][] = $base_dir;
+            $this->prefixes[$prefix][] = $base_dir;
         }
-        return isset($this->prefixes[ $prefix ]);
+        return isset($this->prefixes[$prefix]);
     }
 
 

core/helpers/EEH_Autoloader.helper.php

Indentation +271 added lines, -271 removed lines

@@ -15,275 +15,275 @@
 {
 
 
-    /**
-     *    instance of the EE_System object
-     *
-     * @var    $_instance
-     */
-    private static $_instance = null;
-
-    /**
-     *   $_autoloaders
-     * @var array $_autoloaders
-     */
-    private static $_autoloaders;
-
-    /**
-     * set to "paths" to display autoloader class => path mappings
-     * set to "times" to display autoloader loading times
-     * set to "all" to display both
-     *
-     * @var string $debug
-     */
-    public static $debug = false;
-
-
-    /**
-     * @throws EE_Error
-     */
-    private function __construct()
-    {
-        if (EEH_Autoloader::$_autoloaders === null) {
-            EEH_Autoloader::$_autoloaders = [];
-            $this->_register_custom_autoloaders();
-            spl_autoload_register([$this, 'espresso_autoloader']);
-        }
-    }
-
-
-    /**
-     * @return EEH_Autoloader
-     */
-    public static function instance(): EEH_Autoloader
-    {
-        // check if class object is instantiated
-        if (! EEH_Autoloader::$_instance instanceof EEH_Autoloader) {
-            EEH_Autoloader::$_instance = new EEH_Autoloader();
-        }
-        return EEH_Autoloader::$_instance;
-    }
-
-
-    /**
-     * @param   $class_name
-     * @return  void
-     * @internal  param string $class_name - simple class name ie: session
-     * @internal  param $className
-     */
-    public static function espresso_autoloader($class_name)
-    {
-        if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
-            require_once(EEH_Autoloader::$_autoloaders[ $class_name ]);
-        }
-    }
-
-
-    /**
-     * @param array | string $class_paths - array of key => value pairings between class names and paths
-     * @param bool           $read_check  true if we need to check whether the file is readable or not.
-     * @param bool           $debug       **deprecated**
-     * @throws EE_Error
-     */
-    public static function register_autoloader($class_paths, $read_check = true, $debug = false)
-    {
-        $class_paths = is_array($class_paths) ? $class_paths : [$class_paths];
-        foreach ($class_paths as $class => $path) {
-            // skip all files that are not PHP
-            if (substr($path, strlen($path) - 3) !== 'php') {
-                continue;
-            }
-            // don't give up! you gotta...
-            // get some class
-            if (empty($class)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'No Class name was specified while registering an autoloader for the following path: %s.',
-                            'event_espresso'
-                        ),
-                        $path
-                    )
-                );
-            }
-            // one day you will find the path young grasshopper
-            if (empty($path)) {
-                throw new EE_Error(
-                    sprintf(
-                        __('No path was specified while registering an autoloader for the %s class.', 'event_espresso'),
-                        $class
-                    )
-                );
-            }
-            // is file readable ?
-            if ($read_check && ! is_readable($path)) {
-                throw new EE_Error(
-                    sprintf(
-                        __(
-                            'The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
-                            'event_espresso'
-                        ),
-                        $class,
-                        $path
-                    )
-                );
-            }
-            if (! isset(EEH_Autoloader::$_autoloaders[ $class ])) {
-                EEH_Autoloader::$_autoloaders[ $class ] = str_replace(['/', '\\'], '/', $path);
-                if (EE_DEBUG && (EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug)) {
-                    EEH_Debug_Tools::printr(EEH_Autoloader::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @return array
-     */
-    public static function get_autoloaders(): array
-    {
-        return EEH_Autoloader::$_autoloaders;
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    private function _register_custom_autoloaders()
-    {
-        EEH_Autoloader::$debug = '';
-        EEH_Autoloader::register_helpers_autoloaders();
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
-            Benchmark::displayResults();
-        }
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public static function register_helpers_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function register_form_sections_autoloaders()
-    {
-        // EEH_Autoloader::register_autoloaders_for_each_file_in_folder( EE_FORM_SECTIONS, true );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_line_item_display_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_line_item_filter_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_template_part_autoloaders()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public static function register_business_classes()
-    {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
-    }
-
-
-    /**
-     * Assumes all the files in this folder have the normal naming scheme (namely that their classname
-     * is the file's name, plus ".whatever.php".) and adds each of them to the autoloader list.
-     * If that's not the case, you'll need to improve this function or just use
-     * EEH_File::get_classname_from_filepath_with_standard_filename() directly. Yes this has to scan the directory for
-     * files, but it only does it once -- not on EACH time the autoloader is used
-     *
-     * @param string $folder name, with or without trailing /, doesn't matter
-     * @param bool   $recursive
-     * @param bool   $debug  **deprecated**
-     * @throws EE_Error
-     */
-    public static function register_autoloaders_for_each_file_in_folder(
-        string $folder,
-        bool $recursive = false,
-        bool $debug = false
-    ) {
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all' || $debug) {
-            Benchmark::startTimer(basename($folder));
-        }
-        // make sure last char is a /
-        $folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
-        $class_to_filepath_map = [];
-        $exclude = ['index'];
-        // get all the files in that folder that end in php
-        $filepaths = glob($folder . '*');
-
-        if (empty($filepaths)) {
-            return;
-        }
-
-        foreach ($filepaths as $filepath) {
-            if (substr($filepath, -4, 4) === '.php') {
-                $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
-                if (! in_array($class_name, $exclude)) {
-                    $class_to_filepath_map [ $class_name ] = $filepath;
-                }
-            } elseif ($recursive) {
-                EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
-            }
-        }
-        // we remove the necessity to do a is_readable() check via the $read_check flag because glob by nature will not return non_readable files/directories.
-        EEH_Autoloader::register_autoloader($class_to_filepath_map, false, $debug);
-        if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
-            Benchmark::stopTimer(basename($folder));
-        }
-    }
-
-
-    /**
-     * register additional autoloader based on variation of the classname for an existing autoloader
-     *
-     * @param string $class_name - simple class name ie: EE_Session
-     * @param string $alias      - variation on class name ie: EE_session, session, etc
-     */
-    public static function add_alias(string $class_name, string $alias)
-    {
-        if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
-            EEH_Autoloader::$_autoloaders[ $alias ] = EEH_Autoloader::$_autoloaders[ $class_name ];
-        }
-    }
+	/**
+	 *    instance of the EE_System object
+	 *
+	 * @var    $_instance
+	 */
+	private static $_instance = null;
+
+	/**
+	 *   $_autoloaders
+	 * @var array $_autoloaders
+	 */
+	private static $_autoloaders;
+
+	/**
+	 * set to "paths" to display autoloader class => path mappings
+	 * set to "times" to display autoloader loading times
+	 * set to "all" to display both
+	 *
+	 * @var string $debug
+	 */
+	public static $debug = false;
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	private function __construct()
+	{
+		if (EEH_Autoloader::$_autoloaders === null) {
+			EEH_Autoloader::$_autoloaders = [];
+			$this->_register_custom_autoloaders();
+			spl_autoload_register([$this, 'espresso_autoloader']);
+		}
+	}
+
+
+	/**
+	 * @return EEH_Autoloader
+	 */
+	public static function instance(): EEH_Autoloader
+	{
+		// check if class object is instantiated
+		if (! EEH_Autoloader::$_instance instanceof EEH_Autoloader) {
+			EEH_Autoloader::$_instance = new EEH_Autoloader();
+		}
+		return EEH_Autoloader::$_instance;
+	}
+
+
+	/**
+	 * @param   $class_name
+	 * @return  void
+	 * @internal  param string $class_name - simple class name ie: session
+	 * @internal  param $className
+	 */
+	public static function espresso_autoloader($class_name)
+	{
+		if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
+			require_once(EEH_Autoloader::$_autoloaders[ $class_name ]);
+		}
+	}
+
+
+	/**
+	 * @param array | string $class_paths - array of key => value pairings between class names and paths
+	 * @param bool           $read_check  true if we need to check whether the file is readable or not.
+	 * @param bool           $debug       **deprecated**
+	 * @throws EE_Error
+	 */
+	public static function register_autoloader($class_paths, $read_check = true, $debug = false)
+	{
+		$class_paths = is_array($class_paths) ? $class_paths : [$class_paths];
+		foreach ($class_paths as $class => $path) {
+			// skip all files that are not PHP
+			if (substr($path, strlen($path) - 3) !== 'php') {
+				continue;
+			}
+			// don't give up! you gotta...
+			// get some class
+			if (empty($class)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'No Class name was specified while registering an autoloader for the following path: %s.',
+							'event_espresso'
+						),
+						$path
+					)
+				);
+			}
+			// one day you will find the path young grasshopper
+			if (empty($path)) {
+				throw new EE_Error(
+					sprintf(
+						__('No path was specified while registering an autoloader for the %s class.', 'event_espresso'),
+						$class
+					)
+				);
+			}
+			// is file readable ?
+			if ($read_check && ! is_readable($path)) {
+				throw new EE_Error(
+					sprintf(
+						__(
+							'The file for the %s class could not be found or is not readable due to file permissions. Please ensure the following path is correct: %s',
+							'event_espresso'
+						),
+						$class,
+						$path
+					)
+				);
+			}
+			if (! isset(EEH_Autoloader::$_autoloaders[ $class ])) {
+				EEH_Autoloader::$_autoloaders[ $class ] = str_replace(['/', '\\'], '/', $path);
+				if (EE_DEBUG && (EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug)) {
+					EEH_Debug_Tools::printr(EEH_Autoloader::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public static function get_autoloaders(): array
+	{
+		return EEH_Autoloader::$_autoloaders;
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	private function _register_custom_autoloaders()
+	{
+		EEH_Autoloader::$debug = '';
+		EEH_Autoloader::register_helpers_autoloaders();
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
+			Benchmark::displayResults();
+		}
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public static function register_helpers_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_HELPERS);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function register_form_sections_autoloaders()
+	{
+		// EEH_Autoloader::register_autoloaders_for_each_file_in_folder( EE_FORM_SECTIONS, true );
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_line_item_display_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_line_item_filter_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_template_part_autoloaders()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public static function register_business_classes()
+	{
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
+	}
+
+
+	/**
+	 * Assumes all the files in this folder have the normal naming scheme (namely that their classname
+	 * is the file's name, plus ".whatever.php".) and adds each of them to the autoloader list.
+	 * If that's not the case, you'll need to improve this function or just use
+	 * EEH_File::get_classname_from_filepath_with_standard_filename() directly. Yes this has to scan the directory for
+	 * files, but it only does it once -- not on EACH time the autoloader is used
+	 *
+	 * @param string $folder name, with or without trailing /, doesn't matter
+	 * @param bool   $recursive
+	 * @param bool   $debug  **deprecated**
+	 * @throws EE_Error
+	 */
+	public static function register_autoloaders_for_each_file_in_folder(
+		string $folder,
+		bool $recursive = false,
+		bool $debug = false
+	) {
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all' || $debug) {
+			Benchmark::startTimer(basename($folder));
+		}
+		// make sure last char is a /
+		$folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
+		$class_to_filepath_map = [];
+		$exclude = ['index'];
+		// get all the files in that folder that end in php
+		$filepaths = glob($folder . '*');
+
+		if (empty($filepaths)) {
+			return;
+		}
+
+		foreach ($filepaths as $filepath) {
+			if (substr($filepath, -4, 4) === '.php') {
+				$class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
+				if (! in_array($class_name, $exclude)) {
+					$class_to_filepath_map [ $class_name ] = $filepath;
+				}
+			} elseif ($recursive) {
+				EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
+			}
+		}
+		// we remove the necessity to do a is_readable() check via the $read_check flag because glob by nature will not return non_readable files/directories.
+		EEH_Autoloader::register_autoloader($class_to_filepath_map, false, $debug);
+		if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
+			Benchmark::stopTimer(basename($folder));
+		}
+	}
+
+
+	/**
+	 * register additional autoloader based on variation of the classname for an existing autoloader
+	 *
+	 * @param string $class_name - simple class name ie: EE_Session
+	 * @param string $alias      - variation on class name ie: EE_session, session, etc
+	 */
+	public static function add_alias(string $class_name, string $alias)
+	{
+		if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
+			EEH_Autoloader::$_autoloaders[ $alias ] = EEH_Autoloader::$_autoloaders[ $class_name ];
+		}
+	}
 }

Spacing +18 added lines, -18 removed lines

@@ -57,7 +57,7 @@ 
     public static function instance(): EEH_Autoloader
     {
         // check if class object is instantiated
-        if (! EEH_Autoloader::$_instance instanceof EEH_Autoloader) {
+        if ( ! EEH_Autoloader::$_instance instanceof EEH_Autoloader) {
             EEH_Autoloader::$_instance = new EEH_Autoloader();
         }
         return EEH_Autoloader::$_instance;
@@ -72,8 +72,8 @@ 
      */
     public static function espresso_autoloader($class_name)
     {
-        if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
-            require_once(EEH_Autoloader::$_autoloaders[ $class_name ]);
+        if (isset(EEH_Autoloader::$_autoloaders[$class_name])) {
+            require_once(EEH_Autoloader::$_autoloaders[$class_name]);
         }
     }
 
@@ -127,10 +127,10 @@ 
                     )
                 );
             }
-            if (! isset(EEH_Autoloader::$_autoloaders[ $class ])) {
-                EEH_Autoloader::$_autoloaders[ $class ] = str_replace(['/', '\\'], '/', $path);
+            if ( ! isset(EEH_Autoloader::$_autoloaders[$class])) {
+                EEH_Autoloader::$_autoloaders[$class] = str_replace(['/', '\\'], '/', $path);
                 if (EE_DEBUG && (EEH_Autoloader::$debug === 'paths' || EEH_Autoloader::$debug === 'all' || $debug)) {
-                    EEH_Debug_Tools::printr(EEH_Autoloader::$_autoloaders[ $class ], $class, __FILE__, __LINE__);
+                    EEH_Debug_Tools::printr(EEH_Autoloader::$_autoloaders[$class], $class, __FILE__, __LINE__);
                 }
             }
         }
@@ -154,13 +154,13 @@ 
     {
         EEH_Autoloader::$debug = '';
         EEH_Autoloader::register_helpers_autoloaders();
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'interfaces');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE.'interfaces');
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_INTERFACES, true);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_MODELS, true);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CLASSES);
         EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_FORM_SECTIONS, true);
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'messages');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'messages');
         if (EEH_Autoloader::$debug === 'times' || EEH_Autoloader::$debug === 'all') {
             Benchmark::displayResults();
         }
@@ -191,7 +191,7 @@ 
      */
     public static function register_line_item_display_autoloaders()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_display', true);
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'line_item_display', true);
     }
 
 
@@ -201,7 +201,7 @@ 
      */
     public static function register_line_item_filter_autoloaders()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'line_item_filters', true);
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'line_item_filters', true);
     }
 
 
@@ -211,7 +211,7 @@ 
      */
     public static function register_template_part_autoloaders()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'template_parts', true);
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'template_parts', true);
     }
 
 
@@ -221,7 +221,7 @@ 
      */
     public static function register_business_classes()
     {
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE . 'business');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_CORE.'business');
     }
 
 
@@ -246,11 +246,11 @@ 
             Benchmark::startTimer(basename($folder));
         }
         // make sure last char is a /
-        $folder .= $folder[ strlen($folder) - 1 ] !== '/' ? '/' : '';
+        $folder .= $folder[strlen($folder) - 1] !== '/' ? '/' : '';
         $class_to_filepath_map = [];
         $exclude = ['index'];
         // get all the files in that folder that end in php
-        $filepaths = glob($folder . '*');
+        $filepaths = glob($folder.'*');
 
         if (empty($filepaths)) {
             return;
@@ -259,8 +259,8 @@ 
         foreach ($filepaths as $filepath) {
             if (substr($filepath, -4, 4) === '.php') {
                 $class_name = EEH_File::get_classname_from_filepath_with_standard_filename($filepath);
-                if (! in_array($class_name, $exclude)) {
-                    $class_to_filepath_map [ $class_name ] = $filepath;
+                if ( ! in_array($class_name, $exclude)) {
+                    $class_to_filepath_map [$class_name] = $filepath;
                 }
             } elseif ($recursive) {
                 EEH_Autoloader::register_autoloaders_for_each_file_in_folder($filepath, $recursive, $debug);
@@ -282,8 +282,8 @@ 
      */
     public static function add_alias(string $class_name, string $alias)
     {
-        if (isset(EEH_Autoloader::$_autoloaders[ $class_name ])) {
-            EEH_Autoloader::$_autoloaders[ $alias ] = EEH_Autoloader::$_autoloaders[ $class_name ];
+        if (isset(EEH_Autoloader::$_autoloaders[$class_name])) {
+            EEH_Autoloader::$_autoloaders[$alias] = EEH_Autoloader::$_autoloaders[$class_name];
         }
     }
 }

core/helpers/EEH_File.helper.php

Indentation +911 added lines, -911 removed lines

@@ -25,915 +25,915 @@
 class EEH_File extends EEH_Base implements EEHI_File
 {
 
-    /**
-     * @var string $_credentials_form
-     */
-    private static $_credentials_form;
-
-    /**
-     * @var WP_Filesystem_Base $_wp_filesystem
-     */
-    protected static $_wp_filesystem;
-
-
-    /**
-     * @param string $filepath      the filepath we want to work in. If its in the
-     *                              wp uploads directory, we'll want to just use the filesystem directly.
-     *                              If not provided, we have to assume its not in the uploads directory
-     * @return WP_Filesystem_Base
-     */
-    private static function _get_wp_filesystem($filepath = ''): WP_Filesystem_Base
-    {
-        if (apply_filters(
-            'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
-            $filepath && EEH_File::is_in_uploads_folder($filepath),
-            $filepath
-        )
-        ) {
-            return EEH_File::loadAlternateWpFileSystem();
-        }
-        return EEH_File::loadWpFileSystem();
-    }
-
-
-    /**
-     * @return WP_Filesystem_Base
-     */
-    private static function loadAlternateWpFileSystem(): WP_Filesystem_Base
-    {
-        if (! EEH_File::$_wp_filesystem instanceof WP_Filesystem_Base) {
-            require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
-            $method             = 'direct';
-            $wp_filesystem_file =
-                apply_filters(
-                    'filesystem_method_file',
-                    ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php',
-                    $method
-                );
-            // added the following validation logic
-            // because we allow the filesystem filepath to be filtered,
-            // and are loading whatever file the path pointed to,
-            // but we were not validating things in any way :scream_emoji:
-            $valid_wp_filesystem_types = [
-                'direct'     => 'WP_Filesystem_Direct',
-                'ftpext'     => 'WP_Filesystem_FTPext',
-                'ftpsockets' => 'WP_Filesystem_ftpsockets',
-                'ssh2'       => 'WP_Filesystem_SSH2',
-            ];
-            $valid                     = false;
-            $wp_filesystem_class       = '';
-            foreach ($valid_wp_filesystem_types as $method => $filesystem_class) {
-                // if file path matches for one of valid types, then toggle $valid to true
-                if (strpos($wp_filesystem_file, $method) > 0) {
-                    $valid               = true;
-                    $wp_filesystem_class = $filesystem_class;
-                }
-            }
-            if (! $valid || ! file_exists($wp_filesystem_file)) {
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__(
-                            'The supplied WP Filesystem filepath "%1$s" is either missing or invalid.',
-                            'event_espresso'
-                        ),
-                        $wp_filesystem_file
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // check constants defined, just like in the wp-admin/includes/file.php WP_Filesystem()
-            if (! defined('FS_CHMOD_DIR')) {
-                define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0775 | 0755));
-            }
-            if (! defined('FS_CHMOD_FILE')) {
-                define('FS_CHMOD_FILE', (fileperms(ABSPATH . 'index.php') & 0775 | 0644));
-            }
-            require_once($wp_filesystem_file);
-            EEH_File::$_wp_filesystem = new $wp_filesystem_class([]);
-        }
-        return EEH_File::$_wp_filesystem;
-    }
-
-
-    /**
-     * @return WP_Filesystem_Base
-     */
-    private static function loadWpFileSystem(): WP_Filesystem_Base
-    {
-        global $wp_filesystem;
-        // no filesystem setup ???
-        if (! $wp_filesystem instanceof WP_Filesystem_Base) {
-            // if some eager beaver's just trying to get in there too early...
-            // let them do it, because we are one of those eager beavers! :P
-            /**
-             * more explanations are probably merited.
-             * http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
-             * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
-             * is setup to mostly happen on 'init', and refactoring to have it happen on
-             * 'wp_loaded' is too much work on a BETA milestone.
-             * So this fix is expected to work if the WP files are owned by the server user,
-             * but probably not if the user needs to enter their FTP credentials to modify files
-             * and there may be troubles if the WP files are owned by a different user
-             * than the server user. But both of these issues should exist in 4.4 and earlier too
-             */
-            // if (false && ! did_action('wp_loaded')) {
-            //     $msg =
-            //         esc_html__(
-            //             'An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.',
-            //             'event_espresso'
-            //         );
-            //     if (WP_DEBUG) {
-            //         $msg .= '<br />' . esc_html__(
-            //             'The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.',
-            //             'event_espresso'
-            //         );
-            //     }
-            //     EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            // }
-            // should be loaded if we are past the wp_loaded hook...
-            if (! function_exists('WP_Filesystem') || ! function_exists('submit_button')) {
-                require_once(ABSPATH . 'wp-admin/includes/file.php');
-                require_once(ABSPATH . 'wp-admin/includes/template.php');
-            }
-            // turn on output buffering so that we can capture the credentials form
-            ob_start();
-            $credentials = request_filesystem_credentials(false);
-            // store credentials form for the time being
-            EEH_File::$_credentials_form = ob_get_clean();
-            // if credentials do NOT exist
-            if ($credentials === false) {
-                add_action('admin_notices', ['EEH_File', 'display_request_filesystem_credentials_form'], 999);
-                EE_Error::add_error(
-                    esc_html__(
-                        'An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-            // basically check for direct or previously configured access
-            if (! WP_Filesystem($credentials)
-                && is_wp_error($wp_filesystem->errors)
-                && $wp_filesystem->errors->get_error_code()
-            ) {
-                add_action('admin_notices', ['EEH_File', 'display_request_filesystem_credentials_form'], 999);
-                EE_Error::add_error(
-                    sprintf(
-                        esc_html__('WP Filesystem Error: $1%s', 'event_espresso'),
-                        $wp_filesystem->errors->get_error_message()
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-        return $wp_filesystem;
-    }
-
-
-    /**
-     * display_request_filesystem_credentials_form
-     */
-    public static function display_request_filesystem_credentials_form()
-    {
-        if (! empty(EEH_File::$_credentials_form)) {
-            echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
-        }
-    }
-
-
-    /**
-     *    verify_filepath_and_permissions
-     *    checks that a file is readable and has sufficient file permissions set to access
-     *
-     * @access public
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $file_name      - name of file if checking a file
-     * @param string $file_ext       - file extension (ie: "php") if checking a file
-     * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
-     * @return bool
-     */
-    public static function verify_filepath_and_permissions(
-        string $full_file_path = '',
-        string $file_name = '',
-        string $file_ext = '',
-        string $type_of_file = ''
-    ): bool {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem  = EEH_File::_get_wp_filesystem($full_file_path);
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
-            $file_name .= ! empty($file_ext) ? ' file' : ' folder';
-            $msg       = sprintf(
-                esc_html__(
-                    'The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s',
-                    'event_espresso'
-                ),
-                $file_name,
-                '<br />'
-            );
-            if (EEH_File::exists($full_file_path)) {
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
-            } else {
-                // no file permissions means the file was not found
-                $msg .= sprintf(
-                    esc_html__('Please ensure the following path is correct: "%s".', 'event_espresso'),
-                    $full_file_path
-                );
-            }
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a
-     * file or folder
-     *
-     * @access private
-     * @param string $full_file_path - full server path to the folder or file
-     * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
-     * @return string
-     */
-    private static function _permissions_error_for_unreadable_filepath(
-        string $full_file_path = '',
-        string $type_of_file = ''
-    ): string {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        // check file permissions
-        $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-        if ($perms) {
-            // file permissions exist, but way be set incorrectly
-            $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
-            $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
-            return ' ' . sprintf(
-                esc_html__(
-                    'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.',
-                    'event_espresso'
-                ),
-                $type_of_file,
-                $perms
-            );
-        } else {
-            // file exists but file permissions could not be read ?!?!
-            return ' ' . sprintf(
-                esc_html__(
-                    'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".',
-                    'event_espresso'
-                ),
-                $full_file_path
-            );
-        }
-    }
-
-
-    /**
-     * ensure_folder_exists_and_is_writable
-     * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     * Also, if this function creates the folder, adds a .htaccess file and index.html file
-     *
-     * @param string $folder
-     * @return bool false if folder isn't writable; true if it exists and is writeable,
-     */
-    public static function ensure_folder_exists_and_is_writable(string $folder = ''): bool
-    {
-        if (empty($folder)) {
-            return false;
-        }
-        // remove ending /
-        $folder        = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
-        $parent_folder = EEH_File::get_parent_folder($folder);
-        // add / to folder
-        $folder        = EEH_File::end_with_directory_separator($folder);
-        $wp_filesystem = EEH_File::_get_wp_filesystem($folder);
-        $remote_dir    = EEH_File::convert_local_filepath_to_remote_filepath($folder);
-        if (! $wp_filesystem->is_dir($remote_dir)) {
-            // ok so it doesn't exist. Does its parent? Can we write to it?
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! EEH_File::verify_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
-                if (defined('WP_DEBUG') && WP_DEBUG) {
-                    $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
-                    $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-                return false;
-            }
-            EEH_File::add_index_file($folder);
-        } elseif (! EEH_File::verify_is_writable($folder)) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * verify_is_writable - checks if a file or folder is writable
-     *
-     * @param string $full_path      - full server path to file or folder
-     * @param string $file_or_folder - whether checking a file or folder
-     * @return bool
-     */
-    public static function verify_is_writable(string $full_path = '', string $file_or_folder = 'folder'): bool
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
-        $full_path     = EEH_File::standardise_directory_separators($full_path);
-        $remote_path   = EEH_File::convert_local_filepath_to_remote_filepath($full_path);
-        $remote_path   = rtrim($remote_path, '/\\');
-        if (! $wp_filesystem->is_writable($remote_path)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * ensure_file_exists_and_is_writable
-     * ensures that a file exists and is writable, will attempt to create file if it does not exist.
-     * Also ensures all the parent folders exist, and if not tries to create them.
-     *
-     * @param string $full_file_path
-     * @return bool
-     */
-    public static function ensure_file_exists_and_is_writable(string $full_file_path = ''): bool
-    {
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem  = EEH_File::_get_wp_filesystem($full_file_path);
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $parent_folder  = EEH_File::get_parent_folder($full_file_path);
-        if (! EEH_File::exists($full_file_path)) {
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
-                return false;
-            }
-            if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-                if (defined('WP_DEBUG') && WP_DEBUG) {
-                    $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
-                    $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
-                    EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-                }
-                return false;
-            }
-        }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Gets the parent folder. If provided with file, gets the folder that contains it.
-     * If provided a folder, gets its parent folder.
-     *
-     * @param string $file_or_folder_path
-     * @return string parent folder, ENDING with a directory separator
-     */
-    public static function get_parent_folder(string $file_or_folder_path): string
-    {
-        // find the last /, ignoring a / on the very end
-        // eg if given "/var/something/somewhere/", we want to get "somewhere"'s
-        // parent folder, "/var/something/"
-        $ds = strlen($file_or_folder_path) > 1
-            ? strrpos($file_or_folder_path, '/', -2)
-            : strlen($file_or_folder_path);
-        return substr($file_or_folder_path, 0, $ds + 1);
-    }
-
-
-    /**
-     * get_file_contents
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_file_contents(string $full_file_path = ''): string
-    {
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (EEH_File::verify_filepath_and_permissions(
-            $full_file_path,
-            EEH_File::get_filename_from_filepath($full_file_path),
-            EEH_File::get_file_extension($full_file_path)
-        )
-        ) {
-            // load WP_Filesystem and set file permissions
-            $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-            return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-        }
-        return '';
-    }
-
-
-    /**
-     * write_file
-     *
-     * @param string $full_file_path
-     * @param string $file_contents - the content to be written to the file
-     * @param string $file_type
-     * @return bool
-     */
-    public static function write_to_file(
-        string $full_file_path = '',
-        string $file_contents = '',
-        string $file_type = ''
-    ): bool {
-        $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $file_type      = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
-        $folder         = EEH_File::remove_filename_from_filepath($full_file_path);
-        if (! EEH_File::verify_is_writable($folder)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg =
-                    sprintf(
-                        esc_html__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'),
-                        $file_type,
-                        $full_file_path
-                    );
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return false;
-        }
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        // write the file
-        if (! $wp_filesystem->put_contents(
-            EEH_File::convert_local_filepath_to_remote_filepath($full_file_path),
-            $file_contents
-        )
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg =
-                    sprintf(
-                        esc_html__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'),
-                        $file_type,
-                        $full_file_path
-                    );
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Wrapper for WP_Filesystem_Base::delete
-     *
-     * @param string         $filepath
-     * @param boolean        $recursive
-     * @param boolean|string $type 'd' for directory, 'f' for file
-     * @return boolean
-     */
-    public static function delete(string $filepath, bool $recursive = false, $type = false): bool
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem();
-        return $wp_filesystem->delete($filepath, $recursive, $type);
-    }
-
-
-    /**
-     * exists
-     * checks if a file exists using the WP filesystem
-     *
-     * @param string $full_file_path
-     * @return bool
-     */
-    public static function exists(string $full_file_path = ''): bool
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-    }
-
-
-    /**
-     * is_readable
-     * checks if a file is_readable using the WP filesystem
-     *
-     * @param string $full_file_path
-     * @return bool
-     */
-    public static function is_readable(string $full_file_path = ''): bool
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
-        return $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
-    }
-
-
-    /**
-     * remove_filename_from_filepath
-     * given a full path to a file including the filename itself, this removes  the filename and returns the path, up
-     * to, but NOT including the filename OR slash
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function remove_filename_from_filepath(string $full_file_path = ''): string
-    {
-        return pathinfo($full_file_path, PATHINFO_DIRNAME);
-    }
-
-
-    /**
-     * get_filename_from_filepath. Arguably the same as basename()
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_filename_from_filepath(string $full_file_path = ''): string
-    {
-        return pathinfo($full_file_path, PATHINFO_BASENAME);
-    }
-
-
-    /**
-     * get_file_extension
-     *
-     * @param string $full_file_path
-     * @return string
-     */
-    public static function get_file_extension(string $full_file_path = ''): string
-    {
-        return pathinfo($full_file_path, PATHINFO_EXTENSION);
-    }
-
-
-    /**
-     * add_htaccess_deny_from_all so the web server cannot access this folder
-     *
-     * @param string $folder
-     * @return bool
-     */
-    public static function add_htaccess_deny_from_all(string $folder = ''): bool
-    {
-        $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . '.htaccess')) {
-            if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
-                return false;
-            }
-        }
-
-        return true;
-    }
-
-
-    /**
-     * Adds an index file to this folder, so folks can't list all the file's contents
-     *
-     * @param string $folder
-     * @return boolean
-     */
-    public static function add_index_file(string $folder): bool
-    {
-        $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . 'index.php')) {
-            if (! EEH_File::write_to_file(
-                $folder . 'index.php',
-                'You are not permitted to read from this folder',
-                '.php'
-            )
-            ) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
-     * extract that classname.
-     *
-     * @param string $file_path
-     * @return string
-     */
-    public static function get_classname_from_filepath_with_standard_filename(string $file_path): string
-    {
-        // extract file from path
-        $filename = basename($file_path);
-        // now remove the first period and everything after
-        $pos_of_first_period = strpos($filename, '.');
-        return substr($filename, 0, $pos_of_first_period);
-    }
-
-
-    /**
-     * standardise_directory_separators
-     *  convert all directory separators in a file path.
-     *
-     * @param string $file_path
-     * @param bool   $rtrim will remove trailing backslash
-     * @return string
-     */
-    public static function standardise_directory_separators(string $file_path, bool $rtrim = false): string
-    {
-        $file_path = $rtrim ? rtrim($file_path, '/\\') : $file_path;
-        return str_replace(['\\', '/'], '/', $file_path);
-    }
-
-
-    /**
-     * end_with_directory_separator
-     *  ensures that file path ends with '/'
-     *
-     * @param string $file_path
-     * @return string
-     */
-    public static function end_with_directory_separator(string $file_path): string
-    {
-        return rtrim($file_path, '/\\') . '/';
-    }
-
-
-    /**
-     * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
-     *
-     * @param string $file_path
-     * @return string
-     */
-    public static function standardise_and_end_with_directory_separator(string $file_path): string
-    {
-        return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
-    }
-
-
-    /**
-     * takes the folder name (with or without trailing slash) and finds the files it in,
-     * and what the class's name inside of each should be.
-     *
-     * @param array   $folder_paths
-     * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
-     *                                   if FALSE (Default), returned array will be indexed by the filenames minus
-     *                                   extensions. Set it TRUE if you know there are files in the directory with the
-     *                                   same name but different extensions
-     * @return array if $index_numerically == TRUE keys are numeric ,
-     *                                   if $index_numerically == FALSE (Default) keys are what the class names SHOULD
-     *                                   be; and values are their file paths
-     */
-    public static function get_contents_of_folders(array $folder_paths = [], bool $index_numerically = false): array
-    {
-        $class_to_folder_path = [];
-        foreach ($folder_paths as $folder_path) {
-            $folder_path = self::standardise_and_end_with_directory_separator($folder_path);
-            // load WP_Filesystem and set file permissions
-            $files_in_folder      = glob($folder_path . '*.php');
-            $class_to_folder_path = [];
-            if ($files_in_folder) {
-                foreach ($files_in_folder as $file_path) {
-                    // only add files, not folders
-                    if (! is_dir($file_path)) {
-                        if ($index_numerically) {
-                            $class_to_folder_path[] = $file_path;
-                        } else {
-                            $classname                          =
-                                self::get_classname_from_filepath_with_standard_filename($file_path);
-                            $class_to_folder_path[ $classname ] = $file_path;
-                        }
-                    }
-                }
-            }
-        }
-        return $class_to_folder_path;
-    }
-
-
-    /**
-     * Copies a file. Mostly a wrapper of WP_Filesystem::copy
-     *
-     * @param string  $source_file
-     * @param string  $destination_file
-     * @param boolean $overwrite
-     * @return boolean success
-     */
-    public static function copy(string $source_file, string $destination_file, bool $overwrite = false): bool
-    {
-        $source_file      = EEH_File::validateFileForCopyOrMove($source_file);
-        $destination_file = EEH_File::validateFolderForCopyOrMove($destination_file);
-        if (! $source_file || ! $destination_file) {
-            return false;
-        }
-        // load WP_Filesystem and set file permissions
-        $wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
-        // write the file
-        $copied = $wp_filesystem->copy(
-            EEH_File::convert_local_filepath_to_remote_filepath($source_file),
-            EEH_File::convert_local_filepath_to_remote_filepath($destination_file),
-            $overwrite
-        );
-        if (! $copied) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(
-                    esc_html__(
-                        'Attempted writing to file %1$s, but could not, probably because of permissions issues',
-                        'event_espresso'
-                    ),
-                    $source_file
-                );
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($source_file, 'f');
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Reports whether or not the filepath is in the EE uploads folder or not
-     *
-     * @param string $filepath
-     * @return boolean
-     */
-    public static function is_in_uploads_folder(string $filepath): bool
-    {
-        $uploads = wp_upload_dir();
-        return strpos($filepath, $uploads['basedir']) === 0;
-    }
-
-
-    /**
-     * Given a "local" filepath (what you probably thought was the only filepath),
-     * converts it into a "remote" filepath (the filepath the currently-in-use
-     * $wp_filesystem needs to use access the folder or file).
-     * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
-     *
-     * @param string $local_filepath the filepath to the folder/file locally
-     * @return string the remote filepath (eg the filepath the filesystem method, eg
-     *                               ftp or ssh, will use to access the folder
-     */
-    public static function convert_local_filepath_to_remote_filepath(string $local_filepath): string
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
-        return str_replace(WP_CONTENT_DIR . '/', $wp_filesystem->wp_content_dir(), $local_filepath);
-    }
-
-
-    /**
-     * wrapper for WP_Filesystem::chmod()
-     *
-     * @param string    $file      Path to the file.
-     * @param int|false $mode      Optional. The permissions as octal number, usually 0644 for files,
-     *                             0755 for directories. Default false.
-     * @param bool      $recursive Optional. If set to true, changes file permissions recursively.
-     *                             Default false.
-     * @return bool True on success, false on failure.
-     */
-    public static function chmod(string $file, $mode = false, bool $recursive = false): bool
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($file);
-        return $wp_filesystem->chmod($file, $mode, $recursive);
-    }
-
-
-    /**
-     * wrapper for WP_Filesystem::getchmod()
-     *
-     * @param string $file Path to the file.
-     * @return string Mode of the file (the last 3 digits).
-     */
-    public static function permissions(string $file): string
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($file);
-        return $wp_filesystem->getchmod($file);
-    }
-
-
-    /**
-     * wrapper for WP_Filesystem::owner()
-     *
-     * @param string $file Path to the file.
-     * @return string|false Username of the owner on success, false on failure.
-     */
-    public static function owner(string $file)
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($file);
-        return $wp_filesystem->owner($file);
-    }
-
-
-    /**
-     * wrapper for WP_Filesystem::group()
-     *
-     * @param string $file Path to the file.
-     * @return string|false The group on success, false on failure.
-     */
-    public static function group(string $file)
-    {
-        $wp_filesystem = EEH_File::_get_wp_filesystem($file);
-        return $wp_filesystem->group($file);
-    }
-
-
-    /**
-     * wrapper for WP_Filesystem::move()
-     *
-     * @param string $source      Path to the source file.
-     * @param string $destination Path to the destination file.
-     * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.
-     *                            Default false.
-     * @return bool True on success, false on failure.
-     */
-    public static function move(string $source, string $destination, bool $overwrite = false): bool
-    {
-        // throw new RuntimeException("source: {$source} && destination: {$destination}");
-        $source      = EEH_File::validateFileForCopyOrMove($source);
-        $destination = EEH_File::validateFolderForCopyOrMove($destination);
-        if (! $source || ! $destination) {
-            return false;
-        }
-        $wp_filesystem = EEH_File::_get_wp_filesystem($source);
-        if ($wp_filesystem->move($source, $destination, $overwrite)) {
-            return true;
-        }
-        if (defined('WP_DEBUG') && WP_DEBUG) {
-            $file        = EEH_File::convert_local_filepath_to_remote_filepath($source);
-            $owner       = EEH_File::owner($file);
-            $group       = EEH_File::group($file);
-            $permissions = EEH_File::permissions($file);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'Unable to move the file "%1$s" to new location (possible permissions errors). The existing "owner:group permissions" for the file are: "%2$s"',
-                        'event_espresso'
-                    ),
-                    $destination,
-                    "{$owner}:{$group} $permissions"
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        return false;
-    }
-
-
-    /**
-     * @param string $source_file
-     * @return string
-     */
-    private static function validateFileForCopyOrMove(string $source_file): string
-    {
-        $full_source_path = EEH_File::standardise_directory_separators($source_file);
-        if (! EEH_File::exists($full_source_path)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg =
-                    sprintf(
-                        esc_html__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'),
-                        '',
-                        $full_source_path
-                    );
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return '';
-        }
-        return $full_source_path;
-    }
-
-
-    /**
-     * @param string $destination_file
-     * @return string
-     */
-    private static function validateFolderForCopyOrMove(string $destination_file): string
-    {
-        $full_dest_path = EEH_File::standardise_directory_separators($destination_file);
-        $folder         = EEH_File::remove_filename_from_filepath($full_dest_path);
-        EEH_File::ensure_folder_exists_and_is_writable($folder);
-        if (! EEH_File::verify_is_writable($folder)) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg = sprintf(
-                    esc_html__('The file located at "%2$s" is not writable.', 'event_espresso'),
-                    '',
-                    $full_dest_path
-                );
-                $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-            return '';
-        }
-        return $full_dest_path;
-    }
+	/**
+	 * @var string $_credentials_form
+	 */
+	private static $_credentials_form;
+
+	/**
+	 * @var WP_Filesystem_Base $_wp_filesystem
+	 */
+	protected static $_wp_filesystem;
+
+
+	/**
+	 * @param string $filepath      the filepath we want to work in. If its in the
+	 *                              wp uploads directory, we'll want to just use the filesystem directly.
+	 *                              If not provided, we have to assume its not in the uploads directory
+	 * @return WP_Filesystem_Base
+	 */
+	private static function _get_wp_filesystem($filepath = ''): WP_Filesystem_Base
+	{
+		if (apply_filters(
+			'FHEE__EEH_File___get_wp_filesystem__allow_using_filesystem_direct',
+			$filepath && EEH_File::is_in_uploads_folder($filepath),
+			$filepath
+		)
+		) {
+			return EEH_File::loadAlternateWpFileSystem();
+		}
+		return EEH_File::loadWpFileSystem();
+	}
+
+
+	/**
+	 * @return WP_Filesystem_Base
+	 */
+	private static function loadAlternateWpFileSystem(): WP_Filesystem_Base
+	{
+		if (! EEH_File::$_wp_filesystem instanceof WP_Filesystem_Base) {
+			require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+			$method             = 'direct';
+			$wp_filesystem_file =
+				apply_filters(
+					'filesystem_method_file',
+					ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php',
+					$method
+				);
+			// added the following validation logic
+			// because we allow the filesystem filepath to be filtered,
+			// and are loading whatever file the path pointed to,
+			// but we were not validating things in any way :scream_emoji:
+			$valid_wp_filesystem_types = [
+				'direct'     => 'WP_Filesystem_Direct',
+				'ftpext'     => 'WP_Filesystem_FTPext',
+				'ftpsockets' => 'WP_Filesystem_ftpsockets',
+				'ssh2'       => 'WP_Filesystem_SSH2',
+			];
+			$valid                     = false;
+			$wp_filesystem_class       = '';
+			foreach ($valid_wp_filesystem_types as $method => $filesystem_class) {
+				// if file path matches for one of valid types, then toggle $valid to true
+				if (strpos($wp_filesystem_file, $method) > 0) {
+					$valid               = true;
+					$wp_filesystem_class = $filesystem_class;
+				}
+			}
+			if (! $valid || ! file_exists($wp_filesystem_file)) {
+				EE_Error::add_error(
+					sprintf(
+						esc_html__(
+							'The supplied WP Filesystem filepath "%1$s" is either missing or invalid.',
+							'event_espresso'
+						),
+						$wp_filesystem_file
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// check constants defined, just like in the wp-admin/includes/file.php WP_Filesystem()
+			if (! defined('FS_CHMOD_DIR')) {
+				define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0775 | 0755));
+			}
+			if (! defined('FS_CHMOD_FILE')) {
+				define('FS_CHMOD_FILE', (fileperms(ABSPATH . 'index.php') & 0775 | 0644));
+			}
+			require_once($wp_filesystem_file);
+			EEH_File::$_wp_filesystem = new $wp_filesystem_class([]);
+		}
+		return EEH_File::$_wp_filesystem;
+	}
+
+
+	/**
+	 * @return WP_Filesystem_Base
+	 */
+	private static function loadWpFileSystem(): WP_Filesystem_Base
+	{
+		global $wp_filesystem;
+		// no filesystem setup ???
+		if (! $wp_filesystem instanceof WP_Filesystem_Base) {
+			// if some eager beaver's just trying to get in there too early...
+			// let them do it, because we are one of those eager beavers! :P
+			/**
+			 * more explanations are probably merited.
+			 * http://codex.wordpress.org/Filesystem_API#Initializing_WP_Filesystem_Base
+			 * says WP_Filesystem should be used after 'wp_loaded', but currently EE's activation process
+			 * is setup to mostly happen on 'init', and refactoring to have it happen on
+			 * 'wp_loaded' is too much work on a BETA milestone.
+			 * So this fix is expected to work if the WP files are owned by the server user,
+			 * but probably not if the user needs to enter their FTP credentials to modify files
+			 * and there may be troubles if the WP files are owned by a different user
+			 * than the server user. But both of these issues should exist in 4.4 and earlier too
+			 */
+			// if (false && ! did_action('wp_loaded')) {
+			//     $msg =
+			//         esc_html__(
+			//             'An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.',
+			//             'event_espresso'
+			//         );
+			//     if (WP_DEBUG) {
+			//         $msg .= '<br />' . esc_html__(
+			//             'The WP Filesystem can not be accessed until after the "wp_loaded" hook has run, so it\'s best not to attempt access until the "admin_init" hookpoint.',
+			//             'event_espresso'
+			//         );
+			//     }
+			//     EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			// }
+			// should be loaded if we are past the wp_loaded hook...
+			if (! function_exists('WP_Filesystem') || ! function_exists('submit_button')) {
+				require_once(ABSPATH . 'wp-admin/includes/file.php');
+				require_once(ABSPATH . 'wp-admin/includes/template.php');
+			}
+			// turn on output buffering so that we can capture the credentials form
+			ob_start();
+			$credentials = request_filesystem_credentials(false);
+			// store credentials form for the time being
+			EEH_File::$_credentials_form = ob_get_clean();
+			// if credentials do NOT exist
+			if ($credentials === false) {
+				add_action('admin_notices', ['EEH_File', 'display_request_filesystem_credentials_form'], 999);
+				EE_Error::add_error(
+					esc_html__(
+						'An attempt to access and/or write to a file on the server could not be completed due to a lack of sufficient credentials.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+			// basically check for direct or previously configured access
+			if (! WP_Filesystem($credentials)
+				&& is_wp_error($wp_filesystem->errors)
+				&& $wp_filesystem->errors->get_error_code()
+			) {
+				add_action('admin_notices', ['EEH_File', 'display_request_filesystem_credentials_form'], 999);
+				EE_Error::add_error(
+					sprintf(
+						esc_html__('WP Filesystem Error: $1%s', 'event_espresso'),
+						$wp_filesystem->errors->get_error_message()
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+		return $wp_filesystem;
+	}
+
+
+	/**
+	 * display_request_filesystem_credentials_form
+	 */
+	public static function display_request_filesystem_credentials_form()
+	{
+		if (! empty(EEH_File::$_credentials_form)) {
+			echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+		}
+	}
+
+
+	/**
+	 *    verify_filepath_and_permissions
+	 *    checks that a file is readable and has sufficient file permissions set to access
+	 *
+	 * @access public
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $file_name      - name of file if checking a file
+	 * @param string $file_ext       - file extension (ie: "php") if checking a file
+	 * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
+	 * @return bool
+	 */
+	public static function verify_filepath_and_permissions(
+		string $full_file_path = '',
+		string $file_name = '',
+		string $file_ext = '',
+		string $type_of_file = ''
+	): bool {
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem  = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+			$file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
+			$file_name .= ! empty($file_ext) ? ' file' : ' folder';
+			$msg       = sprintf(
+				esc_html__(
+					'The requested %1$s could not be found or is not readable, possibly due to an incorrect filepath, or incorrect file permissions.%2$s',
+					'event_espresso'
+				),
+				$file_name,
+				'<br />'
+			);
+			if (EEH_File::exists($full_file_path)) {
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, $type_of_file);
+			} else {
+				// no file permissions means the file was not found
+				$msg .= sprintf(
+					esc_html__('Please ensure the following path is correct: "%s".', 'event_espresso'),
+					$full_file_path
+				);
+			}
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * _permissions_error_for_unreadable_filepath - attempts to determine why permissions are set incorrectly for a
+	 * file or folder
+	 *
+	 * @access private
+	 * @param string $full_file_path - full server path to the folder or file
+	 * @param string $type_of_file   - general type of file (ie: "module"), this is only used to improve error messages
+	 * @return string
+	 */
+	private static function _permissions_error_for_unreadable_filepath(
+		string $full_file_path = '',
+		string $type_of_file = ''
+	): string {
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		// check file permissions
+		$perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		if ($perms) {
+			// file permissions exist, but way be set incorrectly
+			$type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
+			$type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
+			return ' ' . sprintf(
+				esc_html__(
+					'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.',
+					'event_espresso'
+				),
+				$type_of_file,
+				$perms
+			);
+		} else {
+			// file exists but file permissions could not be read ?!?!
+			return ' ' . sprintf(
+				esc_html__(
+					'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".',
+					'event_espresso'
+				),
+				$full_file_path
+			);
+		}
+	}
+
+
+	/**
+	 * ensure_folder_exists_and_is_writable
+	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 * Also, if this function creates the folder, adds a .htaccess file and index.html file
+	 *
+	 * @param string $folder
+	 * @return bool false if folder isn't writable; true if it exists and is writeable,
+	 */
+	public static function ensure_folder_exists_and_is_writable(string $folder = ''): bool
+	{
+		if (empty($folder)) {
+			return false;
+		}
+		// remove ending /
+		$folder        = EEH_File::standardise_directory_separators(rtrim($folder, '/\\'));
+		$parent_folder = EEH_File::get_parent_folder($folder);
+		// add / to folder
+		$folder        = EEH_File::end_with_directory_separator($folder);
+		$wp_filesystem = EEH_File::_get_wp_filesystem($folder);
+		$remote_dir    = EEH_File::convert_local_filepath_to_remote_filepath($folder);
+		if (! $wp_filesystem->is_dir($remote_dir)) {
+			// ok so it doesn't exist. Does its parent? Can we write to it?
+			if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! EEH_File::verify_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+				if (defined('WP_DEBUG') && WP_DEBUG) {
+					$msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+				return false;
+			}
+			EEH_File::add_index_file($folder);
+		} elseif (! EEH_File::verify_is_writable($folder)) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * verify_is_writable - checks if a file or folder is writable
+	 *
+	 * @param string $full_path      - full server path to file or folder
+	 * @param string $file_or_folder - whether checking a file or folder
+	 * @return bool
+	 */
+	public static function verify_is_writable(string $full_path = '', string $file_or_folder = 'folder'): bool
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_path);
+		$full_path     = EEH_File::standardise_directory_separators($full_path);
+		$remote_path   = EEH_File::convert_local_filepath_to_remote_filepath($full_path);
+		$remote_path   = rtrim($remote_path, '/\\');
+		if (! $wp_filesystem->is_writable($remote_path)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * ensure_file_exists_and_is_writable
+	 * ensures that a file exists and is writable, will attempt to create file if it does not exist.
+	 * Also ensures all the parent folders exist, and if not tries to create them.
+	 *
+	 * @param string $full_file_path
+	 * @return bool
+	 */
+	public static function ensure_file_exists_and_is_writable(string $full_file_path = ''): bool
+	{
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem  = EEH_File::_get_wp_filesystem($full_file_path);
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$parent_folder  = EEH_File::get_parent_folder($full_file_path);
+		if (! EEH_File::exists($full_file_path)) {
+			if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+				return false;
+			}
+			if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+				if (defined('WP_DEBUG') && WP_DEBUG) {
+					$msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
+					$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+					EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+				}
+				return false;
+			}
+		}
+		if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Gets the parent folder. If provided with file, gets the folder that contains it.
+	 * If provided a folder, gets its parent folder.
+	 *
+	 * @param string $file_or_folder_path
+	 * @return string parent folder, ENDING with a directory separator
+	 */
+	public static function get_parent_folder(string $file_or_folder_path): string
+	{
+		// find the last /, ignoring a / on the very end
+		// eg if given "/var/something/somewhere/", we want to get "somewhere"'s
+		// parent folder, "/var/something/"
+		$ds = strlen($file_or_folder_path) > 1
+			? strrpos($file_or_folder_path, '/', -2)
+			: strlen($file_or_folder_path);
+		return substr($file_or_folder_path, 0, $ds + 1);
+	}
+
+
+	/**
+	 * get_file_contents
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_file_contents(string $full_file_path = ''): string
+	{
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		if (EEH_File::verify_filepath_and_permissions(
+			$full_file_path,
+			EEH_File::get_filename_from_filepath($full_file_path),
+			EEH_File::get_file_extension($full_file_path)
+		)
+		) {
+			// load WP_Filesystem and set file permissions
+			$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+			return $wp_filesystem->get_contents(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+		}
+		return '';
+	}
+
+
+	/**
+	 * write_file
+	 *
+	 * @param string $full_file_path
+	 * @param string $file_contents - the content to be written to the file
+	 * @param string $file_type
+	 * @return bool
+	 */
+	public static function write_to_file(
+		string $full_file_path = '',
+		string $file_contents = '',
+		string $file_type = ''
+	): bool {
+		$full_file_path = EEH_File::standardise_directory_separators($full_file_path);
+		$file_type      = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
+		$folder         = EEH_File::remove_filename_from_filepath($full_file_path);
+		if (! EEH_File::verify_is_writable($folder)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg =
+					sprintf(
+						esc_html__('The %1$sfile located at "%2$s" is not writable.', 'event_espresso'),
+						$file_type,
+						$full_file_path
+					);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return false;
+		}
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		// write the file
+		if (! $wp_filesystem->put_contents(
+			EEH_File::convert_local_filepath_to_remote_filepath($full_file_path),
+			$file_contents
+		)
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg =
+					sprintf(
+						esc_html__('The %1$sfile located at "%2$s" could not be written to.', 'event_espresso'),
+						$file_type,
+						$full_file_path
+					);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path, 'f');
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Wrapper for WP_Filesystem_Base::delete
+	 *
+	 * @param string         $filepath
+	 * @param boolean        $recursive
+	 * @param boolean|string $type 'd' for directory, 'f' for file
+	 * @return boolean
+	 */
+	public static function delete(string $filepath, bool $recursive = false, $type = false): bool
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem();
+		return $wp_filesystem->delete($filepath, $recursive, $type);
+	}
+
+
+	/**
+	 * exists
+	 * checks if a file exists using the WP filesystem
+	 *
+	 * @param string $full_file_path
+	 * @return bool
+	 */
+	public static function exists(string $full_file_path = ''): bool
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		return $wp_filesystem->exists(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+	}
+
+
+	/**
+	 * is_readable
+	 * checks if a file is_readable using the WP filesystem
+	 *
+	 * @param string $full_file_path
+	 * @return bool
+	 */
+	public static function is_readable(string $full_file_path = ''): bool
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
+		return $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
+	}
+
+
+	/**
+	 * remove_filename_from_filepath
+	 * given a full path to a file including the filename itself, this removes  the filename and returns the path, up
+	 * to, but NOT including the filename OR slash
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function remove_filename_from_filepath(string $full_file_path = ''): string
+	{
+		return pathinfo($full_file_path, PATHINFO_DIRNAME);
+	}
+
+
+	/**
+	 * get_filename_from_filepath. Arguably the same as basename()
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_filename_from_filepath(string $full_file_path = ''): string
+	{
+		return pathinfo($full_file_path, PATHINFO_BASENAME);
+	}
+
+
+	/**
+	 * get_file_extension
+	 *
+	 * @param string $full_file_path
+	 * @return string
+	 */
+	public static function get_file_extension(string $full_file_path = ''): string
+	{
+		return pathinfo($full_file_path, PATHINFO_EXTENSION);
+	}
+
+
+	/**
+	 * add_htaccess_deny_from_all so the web server cannot access this folder
+	 *
+	 * @param string $folder
+	 * @return bool
+	 */
+	public static function add_htaccess_deny_from_all(string $folder = ''): bool
+	{
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if (! EEH_File::exists($folder . '.htaccess')) {
+			if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
+				return false;
+			}
+		}
+
+		return true;
+	}
+
+
+	/**
+	 * Adds an index file to this folder, so folks can't list all the file's contents
+	 *
+	 * @param string $folder
+	 * @return boolean
+	 */
+	public static function add_index_file(string $folder): bool
+	{
+		$folder = EEH_File::standardise_and_end_with_directory_separator($folder);
+		if (! EEH_File::exists($folder . 'index.php')) {
+			if (! EEH_File::write_to_file(
+				$folder . 'index.php',
+				'You are not permitted to read from this folder',
+				'.php'
+			)
+			) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Given that the file in $file_path has the normal name, (ie, CLASSNAME.whatever.php),
+	 * extract that classname.
+	 *
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function get_classname_from_filepath_with_standard_filename(string $file_path): string
+	{
+		// extract file from path
+		$filename = basename($file_path);
+		// now remove the first period and everything after
+		$pos_of_first_period = strpos($filename, '.');
+		return substr($filename, 0, $pos_of_first_period);
+	}
+
+
+	/**
+	 * standardise_directory_separators
+	 *  convert all directory separators in a file path.
+	 *
+	 * @param string $file_path
+	 * @param bool   $rtrim will remove trailing backslash
+	 * @return string
+	 */
+	public static function standardise_directory_separators(string $file_path, bool $rtrim = false): string
+	{
+		$file_path = $rtrim ? rtrim($file_path, '/\\') : $file_path;
+		return str_replace(['\\', '/'], '/', $file_path);
+	}
+
+
+	/**
+	 * end_with_directory_separator
+	 *  ensures that file path ends with '/'
+	 *
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function end_with_directory_separator(string $file_path): string
+	{
+		return rtrim($file_path, '/\\') . '/';
+	}
+
+
+	/**
+	 * shorthand for both EEH_FIle::end_with_directory_separator AND EEH_File::standardise_directory_separators
+	 *
+	 * @param string $file_path
+	 * @return string
+	 */
+	public static function standardise_and_end_with_directory_separator(string $file_path): string
+	{
+		return self::end_with_directory_separator(self::standardise_directory_separators($file_path));
+	}
+
+
+	/**
+	 * takes the folder name (with or without trailing slash) and finds the files it in,
+	 * and what the class's name inside of each should be.
+	 *
+	 * @param array   $folder_paths
+	 * @param boolean $index_numerically if TRUE, the returned array will be indexed numerically;
+	 *                                   if FALSE (Default), returned array will be indexed by the filenames minus
+	 *                                   extensions. Set it TRUE if you know there are files in the directory with the
+	 *                                   same name but different extensions
+	 * @return array if $index_numerically == TRUE keys are numeric ,
+	 *                                   if $index_numerically == FALSE (Default) keys are what the class names SHOULD
+	 *                                   be; and values are their file paths
+	 */
+	public static function get_contents_of_folders(array $folder_paths = [], bool $index_numerically = false): array
+	{
+		$class_to_folder_path = [];
+		foreach ($folder_paths as $folder_path) {
+			$folder_path = self::standardise_and_end_with_directory_separator($folder_path);
+			// load WP_Filesystem and set file permissions
+			$files_in_folder      = glob($folder_path . '*.php');
+			$class_to_folder_path = [];
+			if ($files_in_folder) {
+				foreach ($files_in_folder as $file_path) {
+					// only add files, not folders
+					if (! is_dir($file_path)) {
+						if ($index_numerically) {
+							$class_to_folder_path[] = $file_path;
+						} else {
+							$classname                          =
+								self::get_classname_from_filepath_with_standard_filename($file_path);
+							$class_to_folder_path[ $classname ] = $file_path;
+						}
+					}
+				}
+			}
+		}
+		return $class_to_folder_path;
+	}
+
+
+	/**
+	 * Copies a file. Mostly a wrapper of WP_Filesystem::copy
+	 *
+	 * @param string  $source_file
+	 * @param string  $destination_file
+	 * @param boolean $overwrite
+	 * @return boolean success
+	 */
+	public static function copy(string $source_file, string $destination_file, bool $overwrite = false): bool
+	{
+		$source_file      = EEH_File::validateFileForCopyOrMove($source_file);
+		$destination_file = EEH_File::validateFolderForCopyOrMove($destination_file);
+		if (! $source_file || ! $destination_file) {
+			return false;
+		}
+		// load WP_Filesystem and set file permissions
+		$wp_filesystem = EEH_File::_get_wp_filesystem($destination_file);
+		// write the file
+		$copied = $wp_filesystem->copy(
+			EEH_File::convert_local_filepath_to_remote_filepath($source_file),
+			EEH_File::convert_local_filepath_to_remote_filepath($destination_file),
+			$overwrite
+		);
+		if (! $copied) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(
+					esc_html__(
+						'Attempted writing to file %1$s, but could not, probably because of permissions issues',
+						'event_espresso'
+					),
+					$source_file
+				);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($source_file, 'f');
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Reports whether or not the filepath is in the EE uploads folder or not
+	 *
+	 * @param string $filepath
+	 * @return boolean
+	 */
+	public static function is_in_uploads_folder(string $filepath): bool
+	{
+		$uploads = wp_upload_dir();
+		return strpos($filepath, $uploads['basedir']) === 0;
+	}
+
+
+	/**
+	 * Given a "local" filepath (what you probably thought was the only filepath),
+	 * converts it into a "remote" filepath (the filepath the currently-in-use
+	 * $wp_filesystem needs to use access the folder or file).
+	 * See http://wordpress.stackexchange.com/questions/124900/using-wp-filesystem-in-plugins
+	 *
+	 * @param string $local_filepath the filepath to the folder/file locally
+	 * @return string the remote filepath (eg the filepath the filesystem method, eg
+	 *                               ftp or ssh, will use to access the folder
+	 */
+	public static function convert_local_filepath_to_remote_filepath(string $local_filepath): string
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
+		return str_replace(WP_CONTENT_DIR . '/', $wp_filesystem->wp_content_dir(), $local_filepath);
+	}
+
+
+	/**
+	 * wrapper for WP_Filesystem::chmod()
+	 *
+	 * @param string    $file      Path to the file.
+	 * @param int|false $mode      Optional. The permissions as octal number, usually 0644 for files,
+	 *                             0755 for directories. Default false.
+	 * @param bool      $recursive Optional. If set to true, changes file permissions recursively.
+	 *                             Default false.
+	 * @return bool True on success, false on failure.
+	 */
+	public static function chmod(string $file, $mode = false, bool $recursive = false): bool
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($file);
+		return $wp_filesystem->chmod($file, $mode, $recursive);
+	}
+
+
+	/**
+	 * wrapper for WP_Filesystem::getchmod()
+	 *
+	 * @param string $file Path to the file.
+	 * @return string Mode of the file (the last 3 digits).
+	 */
+	public static function permissions(string $file): string
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($file);
+		return $wp_filesystem->getchmod($file);
+	}
+
+
+	/**
+	 * wrapper for WP_Filesystem::owner()
+	 *
+	 * @param string $file Path to the file.
+	 * @return string|false Username of the owner on success, false on failure.
+	 */
+	public static function owner(string $file)
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($file);
+		return $wp_filesystem->owner($file);
+	}
+
+
+	/**
+	 * wrapper for WP_Filesystem::group()
+	 *
+	 * @param string $file Path to the file.
+	 * @return string|false The group on success, false on failure.
+	 */
+	public static function group(string $file)
+	{
+		$wp_filesystem = EEH_File::_get_wp_filesystem($file);
+		return $wp_filesystem->group($file);
+	}
+
+
+	/**
+	 * wrapper for WP_Filesystem::move()
+	 *
+	 * @param string $source      Path to the source file.
+	 * @param string $destination Path to the destination file.
+	 * @param bool   $overwrite   Optional. Whether to overwrite the destination file if it exists.
+	 *                            Default false.
+	 * @return bool True on success, false on failure.
+	 */
+	public static function move(string $source, string $destination, bool $overwrite = false): bool
+	{
+		// throw new RuntimeException("source: {$source} && destination: {$destination}");
+		$source      = EEH_File::validateFileForCopyOrMove($source);
+		$destination = EEH_File::validateFolderForCopyOrMove($destination);
+		if (! $source || ! $destination) {
+			return false;
+		}
+		$wp_filesystem = EEH_File::_get_wp_filesystem($source);
+		if ($wp_filesystem->move($source, $destination, $overwrite)) {
+			return true;
+		}
+		if (defined('WP_DEBUG') && WP_DEBUG) {
+			$file        = EEH_File::convert_local_filepath_to_remote_filepath($source);
+			$owner       = EEH_File::owner($file);
+			$group       = EEH_File::group($file);
+			$permissions = EEH_File::permissions($file);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'Unable to move the file "%1$s" to new location (possible permissions errors). The existing "owner:group permissions" for the file are: "%2$s"',
+						'event_espresso'
+					),
+					$destination,
+					"{$owner}:{$group} $permissions"
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		return false;
+	}
+
+
+	/**
+	 * @param string $source_file
+	 * @return string
+	 */
+	private static function validateFileForCopyOrMove(string $source_file): string
+	{
+		$full_source_path = EEH_File::standardise_directory_separators($source_file);
+		if (! EEH_File::exists($full_source_path)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg =
+					sprintf(
+						esc_html__('The file located at "%2$s" is not readable or doesn\'t exist.', 'event_espresso'),
+						'',
+						$full_source_path
+					);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_source_path);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return '';
+		}
+		return $full_source_path;
+	}
+
+
+	/**
+	 * @param string $destination_file
+	 * @return string
+	 */
+	private static function validateFolderForCopyOrMove(string $destination_file): string
+	{
+		$full_dest_path = EEH_File::standardise_directory_separators($destination_file);
+		$folder         = EEH_File::remove_filename_from_filepath($full_dest_path);
+		EEH_File::ensure_folder_exists_and_is_writable($folder);
+		if (! EEH_File::verify_is_writable($folder)) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg = sprintf(
+					esc_html__('The file located at "%2$s" is not writable.', 'event_espresso'),
+					'',
+					$full_dest_path
+				);
+				$msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_dest_path);
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+			return '';
+		}
+		return $full_dest_path;
+	}
 }

Spacing +48 added lines, -48 removed lines

@@ -61,13 +61,13 @@ 
      */
     private static function loadAlternateWpFileSystem(): WP_Filesystem_Base
     {
-        if (! EEH_File::$_wp_filesystem instanceof WP_Filesystem_Base) {
-            require_once(ABSPATH . 'wp-admin/includes/class-wp-filesystem-base.php');
+        if ( ! EEH_File::$_wp_filesystem instanceof WP_Filesystem_Base) {
+            require_once(ABSPATH.'wp-admin/includes/class-wp-filesystem-base.php');
             $method             = 'direct';
             $wp_filesystem_file =
                 apply_filters(
                     'filesystem_method_file',
-                    ABSPATH . 'wp-admin/includes/class-wp-filesystem-' . $method . '.php',
+                    ABSPATH.'wp-admin/includes/class-wp-filesystem-'.$method.'.php',
                     $method
                 );
             // added the following validation logic
@@ -89,7 +89,7 @@ 
                     $wp_filesystem_class = $filesystem_class;
                 }
             }
-            if (! $valid || ! file_exists($wp_filesystem_file)) {
+            if ( ! $valid || ! file_exists($wp_filesystem_file)) {
                 EE_Error::add_error(
                     sprintf(
                         esc_html__(
@@ -104,11 +104,11 @@ 
                 );
             }
             // check constants defined, just like in the wp-admin/includes/file.php WP_Filesystem()
-            if (! defined('FS_CHMOD_DIR')) {
+            if ( ! defined('FS_CHMOD_DIR')) {
                 define('FS_CHMOD_DIR', (fileperms(ABSPATH) & 0775 | 0755));
             }
-            if (! defined('FS_CHMOD_FILE')) {
-                define('FS_CHMOD_FILE', (fileperms(ABSPATH . 'index.php') & 0775 | 0644));
+            if ( ! defined('FS_CHMOD_FILE')) {
+                define('FS_CHMOD_FILE', (fileperms(ABSPATH.'index.php') & 0775 | 0644));
             }
             require_once($wp_filesystem_file);
             EEH_File::$_wp_filesystem = new $wp_filesystem_class([]);
@@ -124,7 +124,7 @@ 
     {
         global $wp_filesystem;
         // no filesystem setup ???
-        if (! $wp_filesystem instanceof WP_Filesystem_Base) {
+        if ( ! $wp_filesystem instanceof WP_Filesystem_Base) {
             // if some eager beaver's just trying to get in there too early...
             // let them do it, because we are one of those eager beavers! :P
             /**
@@ -153,9 +153,9 @@ 
             //     EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
             // }
             // should be loaded if we are past the wp_loaded hook...
-            if (! function_exists('WP_Filesystem') || ! function_exists('submit_button')) {
-                require_once(ABSPATH . 'wp-admin/includes/file.php');
-                require_once(ABSPATH . 'wp-admin/includes/template.php');
+            if ( ! function_exists('WP_Filesystem') || ! function_exists('submit_button')) {
+                require_once(ABSPATH.'wp-admin/includes/file.php');
+                require_once(ABSPATH.'wp-admin/includes/template.php');
             }
             // turn on output buffering so that we can capture the credentials form
             ob_start();
@@ -176,7 +176,7 @@ 
                 );
             }
             // basically check for direct or previously configured access
-            if (! WP_Filesystem($credentials)
+            if ( ! WP_Filesystem($credentials)
                 && is_wp_error($wp_filesystem->errors)
                 && $wp_filesystem->errors->get_error_code()
             ) {
@@ -201,8 +201,8 @@ 
      */
     public static function display_request_filesystem_credentials_form()
     {
-        if (! empty(EEH_File::$_credentials_form)) {
-            echo '<div class="updated espresso-notices-attention"><p>' . EEH_File::$_credentials_form . '</p></div>';
+        if ( ! empty(EEH_File::$_credentials_form)) {
+            echo '<div class="updated espresso-notices-attention"><p>'.EEH_File::$_credentials_form.'</p></div>';
         }
     }
 
@@ -227,8 +227,8 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem  = EEH_File::_get_wp_filesystem($full_file_path);
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        if (! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
-            $file_name = ! empty($type_of_file) ? $file_name . ' ' . $type_of_file : $file_name;
+        if ( ! $wp_filesystem->is_readable(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+            $file_name = ! empty($type_of_file) ? $file_name.' '.$type_of_file : $file_name;
             $file_name .= ! empty($file_ext) ? ' file' : ' folder';
             $msg       = sprintf(
                 esc_html__(
@@ -248,7 +248,7 @@ 
                 );
             }
             if (defined('WP_DEBUG') && WP_DEBUG) {
-                EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+                EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             }
             return false;
         }
@@ -275,9 +275,9 @@ 
         $perms = $wp_filesystem->getchmod(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path));
         if ($perms) {
             // file permissions exist, but way be set incorrectly
-            $type_of_file = ! empty($type_of_file) ? $type_of_file . ' ' : '';
+            $type_of_file = ! empty($type_of_file) ? $type_of_file.' ' : '';
             $type_of_file .= ! empty($type_of_file) ? 'file' : 'folder';
-            return ' ' . sprintf(
+            return ' '.sprintf(
                 esc_html__(
                     'File permissions for the requested %1$s are currently set at "%2$s". The recommended permissions are 644 for files and 755 for folders.',
                     'event_espresso'
@@ -287,7 +287,7 @@ 
             );
         } else {
             // file exists but file permissions could not be read ?!?!
-            return ' ' . sprintf(
+            return ' '.sprintf(
                 esc_html__(
                     'Please ensure that the server and/or PHP configuration allows the current process to access the following file: "%s".',
                     'event_espresso'
@@ -319,15 +319,15 @@ 
         $folder        = EEH_File::end_with_directory_separator($folder);
         $wp_filesystem = EEH_File::_get_wp_filesystem($folder);
         $remote_dir    = EEH_File::convert_local_filepath_to_remote_filepath($folder);
-        if (! $wp_filesystem->is_dir($remote_dir)) {
+        if ( ! $wp_filesystem->is_dir($remote_dir)) {
             // ok so it doesn't exist. Does its parent? Can we write to it?
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+            if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
                 return false;
             }
-            if (! EEH_File::verify_is_writable($parent_folder)) {
+            if ( ! EEH_File::verify_is_writable($parent_folder)) {
                 return false;
             }
-            if (! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
+            if ( ! $wp_filesystem->mkdir(EEH_File::convert_local_filepath_to_remote_filepath($folder))) {
                 if (defined('WP_DEBUG') && WP_DEBUG) {
                     $msg = sprintf(__('"%s" could not be created.', 'event_espresso'), $folder);
                     $msg .= EEH_File::_permissions_error_for_unreadable_filepath($folder);
@@ -336,7 +336,7 @@ 
                 return false;
             }
             EEH_File::add_index_file($folder);
-        } elseif (! EEH_File::verify_is_writable($folder)) {
+        } elseif ( ! EEH_File::verify_is_writable($folder)) {
             return false;
         }
         return true;
@@ -357,7 +357,7 @@ 
         $full_path     = EEH_File::standardise_directory_separators($full_path);
         $remote_path   = EEH_File::convert_local_filepath_to_remote_filepath($full_path);
         $remote_path   = rtrim($remote_path, '/\\');
-        if (! $wp_filesystem->is_writable($remote_path)) {
+        if ( ! $wp_filesystem->is_writable($remote_path)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(__('The "%1$s" %2$s is not writable.', 'event_espresso'), $full_path, $file_or_folder);
                 $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_path);
@@ -383,11 +383,11 @@ 
         $wp_filesystem  = EEH_File::_get_wp_filesystem($full_file_path);
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
         $parent_folder  = EEH_File::get_parent_folder($full_file_path);
-        if (! EEH_File::exists($full_file_path)) {
-            if (! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
+        if ( ! EEH_File::exists($full_file_path)) {
+            if ( ! EEH_File::ensure_folder_exists_and_is_writable($parent_folder)) {
                 return false;
             }
-            if (! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
+            if ( ! $wp_filesystem->touch(EEH_File::convert_local_filepath_to_remote_filepath($full_file_path))) {
                 if (defined('WP_DEBUG') && WP_DEBUG) {
                     $msg = sprintf(__('The "%s" file could not be created.', 'event_espresso'), $full_file_path);
                     $msg .= EEH_File::_permissions_error_for_unreadable_filepath($full_file_path);
@@ -396,7 +396,7 @@ 
                 return false;
             }
         }
-        if (! EEH_File::verify_is_writable($full_file_path, 'file')) {
+        if ( ! EEH_File::verify_is_writable($full_file_path, 'file')) {
             return false;
         }
         return true;
@@ -459,9 +459,9 @@ 
         string $file_type = ''
     ): bool {
         $full_file_path = EEH_File::standardise_directory_separators($full_file_path);
-        $file_type      = ! empty($file_type) ? rtrim($file_type, ' ') . ' ' : '';
+        $file_type      = ! empty($file_type) ? rtrim($file_type, ' ').' ' : '';
         $folder         = EEH_File::remove_filename_from_filepath($full_file_path);
-        if (! EEH_File::verify_is_writable($folder)) {
+        if ( ! EEH_File::verify_is_writable($folder)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg =
                     sprintf(
@@ -477,7 +477,7 @@ 
         // load WP_Filesystem and set file permissions
         $wp_filesystem = EEH_File::_get_wp_filesystem($full_file_path);
         // write the file
-        if (! $wp_filesystem->put_contents(
+        if ( ! $wp_filesystem->put_contents(
             EEH_File::convert_local_filepath_to_remote_filepath($full_file_path),
             $file_contents
         )
@@ -588,8 +588,8 @@ 
     public static function add_htaccess_deny_from_all(string $folder = ''): bool
     {
         $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . '.htaccess')) {
-            if (! EEH_File::write_to_file($folder . '.htaccess', 'deny from all', '.htaccess')) {
+        if ( ! EEH_File::exists($folder.'.htaccess')) {
+            if ( ! EEH_File::write_to_file($folder.'.htaccess', 'deny from all', '.htaccess')) {
                 return false;
             }
         }
@@ -607,9 +607,9 @@ 
     public static function add_index_file(string $folder): bool
     {
         $folder = EEH_File::standardise_and_end_with_directory_separator($folder);
-        if (! EEH_File::exists($folder . 'index.php')) {
-            if (! EEH_File::write_to_file(
-                $folder . 'index.php',
+        if ( ! EEH_File::exists($folder.'index.php')) {
+            if ( ! EEH_File::write_to_file(
+                $folder.'index.php',
                 'You are not permitted to read from this folder',
                 '.php'
             )
@@ -662,7 +662,7 @@ 
      */
     public static function end_with_directory_separator(string $file_path): string
     {
-        return rtrim($file_path, '/\\') . '/';
+        return rtrim($file_path, '/\\').'/';
     }
 
 
@@ -697,18 +697,18 @@ 
         foreach ($folder_paths as $folder_path) {
             $folder_path = self::standardise_and_end_with_directory_separator($folder_path);
             // load WP_Filesystem and set file permissions
-            $files_in_folder      = glob($folder_path . '*.php');
+            $files_in_folder      = glob($folder_path.'*.php');
             $class_to_folder_path = [];
             if ($files_in_folder) {
                 foreach ($files_in_folder as $file_path) {
                     // only add files, not folders
-                    if (! is_dir($file_path)) {
+                    if ( ! is_dir($file_path)) {
                         if ($index_numerically) {
                             $class_to_folder_path[] = $file_path;
                         } else {
                             $classname                          =
                                 self::get_classname_from_filepath_with_standard_filename($file_path);
-                            $class_to_folder_path[ $classname ] = $file_path;
+                            $class_to_folder_path[$classname] = $file_path;
                         }
                     }
                 }
@@ -730,7 +730,7 @@ 
     {
         $source_file      = EEH_File::validateFileForCopyOrMove($source_file);
         $destination_file = EEH_File::validateFolderForCopyOrMove($destination_file);
-        if (! $source_file || ! $destination_file) {
+        if ( ! $source_file || ! $destination_file) {
             return false;
         }
         // load WP_Filesystem and set file permissions
@@ -741,7 +741,7 @@ 
             EEH_File::convert_local_filepath_to_remote_filepath($destination_file),
             $overwrite
         );
-        if (! $copied) {
+        if ( ! $copied) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(
                     esc_html__(
@@ -785,7 +785,7 @@ 
     public static function convert_local_filepath_to_remote_filepath(string $local_filepath): string
     {
         $wp_filesystem = EEH_File::_get_wp_filesystem($local_filepath);
-        return str_replace(WP_CONTENT_DIR . '/', $wp_filesystem->wp_content_dir(), $local_filepath);
+        return str_replace(WP_CONTENT_DIR.'/', $wp_filesystem->wp_content_dir(), $local_filepath);
     }
 
 
@@ -859,7 +859,7 @@ 
         // throw new RuntimeException("source: {$source} && destination: {$destination}");
         $source      = EEH_File::validateFileForCopyOrMove($source);
         $destination = EEH_File::validateFolderForCopyOrMove($destination);
-        if (! $source || ! $destination) {
+        if ( ! $source || ! $destination) {
             return false;
         }
         $wp_filesystem = EEH_File::_get_wp_filesystem($source);
@@ -896,7 +896,7 @@ 
     private static function validateFileForCopyOrMove(string $source_file): string
     {
         $full_source_path = EEH_File::standardise_directory_separators($source_file);
-        if (! EEH_File::exists($full_source_path)) {
+        if ( ! EEH_File::exists($full_source_path)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg =
                     sprintf(
@@ -922,7 +922,7 @@ 
         $full_dest_path = EEH_File::standardise_directory_separators($destination_file);
         $folder         = EEH_File::remove_filename_from_filepath($full_dest_path);
         EEH_File::ensure_folder_exists_and_is_writable($folder);
-        if (! EEH_File::verify_is_writable($folder)) {
+        if ( ! EEH_File::verify_is_writable($folder)) {
             if (defined('WP_DEBUG') && WP_DEBUG) {
                 $msg = sprintf(
                     esc_html__('The file located at "%2$s" is not writable.', 'event_espresso'),

core/EE_Addon.core.php

Indentation +855 added lines, -855 removed lines

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

Spacing +12 added lines, -12 removed lines

@@ -298,7 +298,7 @@ 
     public function set_plugins_page_row(array $plugins_page_row = [])
     {
         // sigh.... check for example content that I stupidly merged to master and remove it if found
-        if (! is_array($plugins_page_row)
+        if ( ! is_array($plugins_page_row)
             && strpos($plugins_page_row, '<h3>Promotions Addon Upsell Info</h3>') !== false
         ) {
             $plugins_page_row = [];
@@ -579,7 +579,7 @@ 
      */
     public function get_activation_indicator_option_name(): string
     {
-        return 'ee_activation_' . $this->name();
+        return 'ee_activation_'.$this->name();
     }
 
 
@@ -601,7 +601,7 @@ 
      */
     public function detect_req_type(): int
     {
-        if (! $this->_req_type) {
+        if ( ! $this->_req_type) {
             $this->detect_activation_or_upgrade();
         }
         return $this->_req_type;
@@ -667,13 +667,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->get_activation_history();
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = $this->version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         return update_option($this->get_activation_history_option_name(), $version_history);
     }
 
@@ -686,7 +686,7 @@ 
      */
     public function get_activation_history_option_name(): string
     {
-        return self::ee_addon_version_history_option_prefix . $this->name();
+        return self::ee_addon_version_history_option_prefix.$this->name();
     }
 
 
@@ -765,7 +765,7 @@ 
         // is admin and not in M-Mode ?
         if (is_admin() && ! EE_Maintenance_Mode::instance()->level()) {
             add_filter('plugin_action_links', [$this, 'plugin_action_links'], 10, 2);
-            add_filter('after_plugin_row_' . $this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
+            add_filter('after_plugin_row_'.$this->_plugin_basename, [$this, 'after_plugin_row'], 10, 3);
         }
     }
 
@@ -784,7 +784,7 @@ 
             // before other links
             array_unshift(
                 $links,
-                '<a href="admin.php?page=' . $this->plugin_action_slug() . '">'
+                '<a href="admin.php?page='.$this->plugin_action_slug().'">'
                 . esc_html__('Settings', 'event_espresso')
                 . '</a>'
             );
@@ -807,15 +807,15 @@ 
     {
         $after_plugin_row = '';
         $plugins_page_row = $this->get_plugins_page_row();
-        if (! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
+        if ( ! empty($plugins_page_row) && $plugin_file === $this->plugin_basename()) {
             $class       = $status ? 'active' : 'inactive';
             $link_text   = isset($plugins_page_row['link_text']) ? $plugins_page_row['link_text'] : '';
             $link_url    = isset($plugins_page_row['link_url']) ? $plugins_page_row['link_url'] : '';
             $description = isset($plugins_page_row['description'])
                 ? $plugins_page_row['description']
                 : '';
-            if (! empty($link_text) && ! empty($link_url) && ! empty($description)) {
-                $after_plugin_row .= '<tr id="' . sanitize_title($plugin_file) . '-ee-addon" class="' . $class . '">';
+            if ( ! empty($link_text) && ! empty($link_url) && ! empty($description)) {
+                $after_plugin_row .= '<tr id="'.sanitize_title($plugin_file).'-ee-addon" class="'.$class.'">';
                 $after_plugin_row .= '<th class="check-column" scope="row"></th>';
                 $after_plugin_row .= '<td class="ee-addon-upsell-info-title-td plugin-title column-primary">';
                 $after_plugin_row .= '<style>
@@ -857,7 +857,7 @@ 
 </style>';
                 $after_plugin_row .= '
 <p class="ee-addon-upsell-info-dv">
-	<a class="ee-button" href="' . $link_url . '">'
+	<a class="ee-button" href="' . $link_url.'">'
                                      . $link_text
                                      . ' &nbsp;<span class="dashicons dashicons-arrow-right-alt2" style="margin:0;"></span>'
                                      . '</a>

core/EE_System.core.php

Indentation +1158 added lines, -1158 removed lines

@@ -25,1162 +25,1162 @@
 final class EE_System implements ResettableInterface
 {
 
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var AddonManager $addon_manager
-     */
-    private $addon_manager;
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * @var Router $router
-     */
-    private $router;
-
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param LoaderInterface|null     $loader
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @param EE_Registry|null         $registry
-     * @param RequestInterface|null    $request
-     * @param Router|null              $router
-     * @return EE_System
-     */
-    public static function instance(
-        LoaderInterface $loader = null,
-        EE_Maintenance_Mode $maintenance_mode = null,
-        EE_Registry $registry = null,
-        RequestInterface $request = null,
-        Router $router = null
-    ): EE_System {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset(): EE_System
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param LoaderInterface     $loader
-     * @param EE_Maintenance_Mode $maintenance_mode
-     * @param EE_Registry         $registry
-     * @param RequestInterface    $request
-     * @param Router              $router
-     */
-    private function __construct(
-        LoaderInterface $loader,
-        EE_Maintenance_Mode $maintenance_mode,
-        EE_Registry $registry,
-        RequestInterface $request,
-        Router $router
-    ) {
-        $this->registry         = $registry;
-        $this->loader           = $loader;
-        $this->request          = $request;
-        $this->router           = $router;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCapabilities'],
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadCommandBus'],
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'loadPluginApi'],
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            [$this, 'load_espresso_addons']
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            [$this, 'detect_activations_or_upgrades'],
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'load_core_configuration'],
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            [$this, 'loadRouteMatchSpecifications']
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            [$this, 'register_shortcodes_modules_and_widgets'],
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            [$this, 'brew_espresso'],
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            [$this, 'remove_pages_from_wp_list_pages'],
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     *
-     * @return void
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            [
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    [
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    ]
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws Exception
-     */
-    public function loadPluginApi()
-    {
-        $this->addon_manager = $this->loader->getShared(AddonManager::class);
-        $this->addon_manager->initialize();
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function load_espresso_addons()
-    {
-        // looking for hooks? they've been moved into the AddonManager to maintain compatibility
-        $this->addon_manager->loadAddons();
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_activation_or_upgrade();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type       = $this->detect_req_type($espresso_db_update);
-        // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change(array $espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            [$this, 'initialize_db_if_no_migrations_required']
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = [];
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = [$espresso_db_update => []];
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = [];
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return ! empty($espresso_db_update) ? $espresso_db_update : [];
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if ($request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param array  $version_history
-     * @param string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null): int
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update          = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type             = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history): bool
-    {
-        $previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts  = explode('.', espresso_version());
-        return isset(
-            $previous_version_parts[0],
-            $previous_version_parts[1],
-            $current_version_parts[0],
-            $current_version_parts[1]
-        ) && (
-            $previous_version_parts[0] !== $current_version_parts[0]
-            || $previous_version_parts[1] !== $current_version_parts[1]
-        );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change(): bool
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array|null $activation_history             the option's value which stores the activation history for
-     *                                                 this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $current_version                  the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public static function detect_req_type_given_activation_history(
-        array $activation_history,
-        string $activation_indicator_option_name,
-        string $current_version
-    ): int {
-        $version_change = self::compareVersionWithPrevious($activation_history, $current_version);
-        $is_activation  = get_option($activation_indicator_option_name, false);
-        $req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
-        if ($is_activation) {
-            // cleanup in aisle 6
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * @param array  $activation_history
-     * @param int    $version_change
-     * @param bool   $is_activation
-     * @return int
-     * @since $VID:$
-     */
-    private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
-    {
-        // if no previous activation history exists, then this is a brand new install
-        if (empty($activation_history)) {
-            return EE_System::req_type_new_activation;
-        }
-        // current version is higher than previous version, so it's an upgrade
-        if ($version_change === 1) {
-            return EE_System::req_type_upgrade;
-        }
-        // current version is lower than previous version, so it's a downgrade
-        if ($version_change === -1) {
-            return EE_System::req_type_downgrade;
-        }
-        // version hasn't changed since last version so check if the activation indicator is set
-        // to determine if it's a reactivation, or just a normal request
-        return $is_activation
-            ? EE_System::req_type_reactivation
-            : EE_System::req_type_normal;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history    array where keys are versions,
-     *                                      values are arrays of times activated (sometimes 'unknown-date')
-     * @param string $current_version
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
-    {
-        // find the most recently-activated version
-        $most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
-        return version_compare($current_version, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function getMostRecentlyActiveVersion(array $activation_history): string
-    {
-        $most_recent_activation_date  = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $activation_dates) {
-                // check there is a record of when this version was activated.
-                // Otherwise, mark it as unknown
-                if (! $activation_dates) {
-                    $activation_dates = ['unknown-date'];
-                }
-                $activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
-                foreach ($activation_dates as $activation_date) {
-                    if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
-                        $most_recently_active_version = $version;
-                        $most_recent_activation_date  = $activation_date;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = ['page' => 'espresso_about'];
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            EEH_URL::safeRedirectAndExit($url);
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
-        $model_names            = [];
-        $non_abstract_db_models = [];
-        foreach ($models as $model) {
-            // get model classname
-            $classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name      = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     */
-    private function _maybe_brew_regular()
-    {
-        /** @var Domain $domain */
-        $domain = DomainFactory::getEventEspressoCoreDomain();
-        if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-    /**
-     * @throws Exception
-     * @since 4.9.71.p
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
-            $this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
-            $this->router->loadPrimaryRoutes();
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        $this->router->registerShortcodesModulesAndWidgets();
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = __(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= __(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     * @throws Exception
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', [$this, 'set_hooks_for_core'], 1);
-        add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
-        add_action('init', [$this, 'load_CPTs_and_session'], 5);
-        add_action('init', [$this, 'load_controllers'], 7);
-        add_action('init', [$this, 'core_loaded_and_ready'], 9);
-        add_action('init', [$this, 'initialize'], 10);
-        add_action('init', [$this, 'initialize_last'], 100);
-        $this->router->brewEspresso();
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', []);
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        unset($_GET['activate']);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
-        $register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $register_custom_taxonomies->registerCustomTaxonomies();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
-        $register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $register_custom_post_types->registerCustomPostTypes();
-        /** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
-        $register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        $register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        $this->router->loadControllers();
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        $this->router->coreLoadedAndReady();
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        $this->router->initializeLast();
-        add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            [$this->registry->CAP]
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers): array
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages(array $exclude_array): array
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we're in maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var AddonManager $addon_manager
+	 */
+	private $addon_manager;
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * @var Router $router
+	 */
+	private $router;
+
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param LoaderInterface|null     $loader
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @param EE_Registry|null         $registry
+	 * @param RequestInterface|null    $request
+	 * @param Router|null              $router
+	 * @return EE_System
+	 */
+	public static function instance(
+		LoaderInterface $loader = null,
+		EE_Maintenance_Mode $maintenance_mode = null,
+		EE_Registry $registry = null,
+		RequestInterface $request = null,
+		Router $router = null
+	): EE_System {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset(): EE_System
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param LoaderInterface     $loader
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 * @param EE_Registry         $registry
+	 * @param RequestInterface    $request
+	 * @param Router              $router
+	 */
+	private function __construct(
+		LoaderInterface $loader,
+		EE_Maintenance_Mode $maintenance_mode,
+		EE_Registry $registry,
+		RequestInterface $request,
+		Router $router
+	) {
+		$this->registry         = $registry;
+		$this->loader           = $loader;
+		$this->request          = $request;
+		$this->router           = $router;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCapabilities'],
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadCommandBus'],
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'loadPluginApi'],
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			[$this, 'load_espresso_addons']
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', [$this, 'load_espresso_addons'], 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			[$this, 'detect_activations_or_upgrades'],
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'load_core_configuration'],
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			[$this, 'loadRouteMatchSpecifications']
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			[$this, 'register_shortcodes_modules_and_widgets'],
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			[$this, 'brew_espresso'],
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			[$this, 'remove_pages_from_wp_list_pages'],
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 *
+	 * @return void
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			[
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					[
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					]
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws Exception
+	 */
+	public function loadPluginApi()
+	{
+		$this->addon_manager = $this->loader->getShared(AddonManager::class);
+		$this->addon_manager->initialize();
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_espresso_addons()
+	{
+		// looking for hooks? they've been moved into the AddonManager to maintain compatibility
+		$this->addon_manager->loadAddons();
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_activation_or_upgrade();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type       = $this->detect_req_type($espresso_db_update);
+		// EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change(array $espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			[$this, 'initialize_db_if_no_migrations_required']
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = [];
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = [$espresso_db_update => []];
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = [];
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string                         = $should_be_array;
+					$corrected_db_update[ $version_string ] = ['unknown-date'];
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return ! empty($espresso_db_update) ? $espresso_db_update : [];
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if ($request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', [$this, 'redirect_to_about_ee'], 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param array  $version_history
+	 * @param string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null): int
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update          = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type             = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history): bool
+	{
+		$previous_version       = EE_System::getMostRecentlyActiveVersion($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts  = explode('.', espresso_version());
+		return isset(
+			$previous_version_parts[0],
+			$previous_version_parts[1],
+			$current_version_parts[0],
+			$current_version_parts[1]
+		) && (
+			$previous_version_parts[0] !== $current_version_parts[0]
+			|| $previous_version_parts[1] !== $current_version_parts[1]
+		);
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change(): bool
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array|null $activation_history             the option's value which stores the activation history for
+	 *                                                 this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $current_version                  the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public static function detect_req_type_given_activation_history(
+		array $activation_history,
+		string $activation_indicator_option_name,
+		string $current_version
+	): int {
+		$version_change = self::compareVersionWithPrevious($activation_history, $current_version);
+		$is_activation  = get_option($activation_indicator_option_name, false);
+		$req_type       = self::getRequestType($activation_history, $version_change, $is_activation);
+		if ($is_activation) {
+			// cleanup in aisle 6
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * @param array  $activation_history
+	 * @param int    $version_change
+	 * @param bool   $is_activation
+	 * @return int
+	 * @since $VID:$
+	 */
+	private static function getRequestType(array $activation_history, int $version_change, bool $is_activation): int
+	{
+		// if no previous activation history exists, then this is a brand new install
+		if (empty($activation_history)) {
+			return EE_System::req_type_new_activation;
+		}
+		// current version is higher than previous version, so it's an upgrade
+		if ($version_change === 1) {
+			return EE_System::req_type_upgrade;
+		}
+		// current version is lower than previous version, so it's a downgrade
+		if ($version_change === -1) {
+			return EE_System::req_type_downgrade;
+		}
+		// version hasn't changed since last version so check if the activation indicator is set
+		// to determine if it's a reactivation, or just a normal request
+		return $is_activation
+			? EE_System::req_type_reactivation
+			: EE_System::req_type_normal;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history    array where keys are versions,
+	 *                                      values are arrays of times activated (sometimes 'unknown-date')
+	 * @param string $current_version
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                      -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                      0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                      1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function compareVersionWithPrevious(array $activation_history, string $current_version): int
+	{
+		// find the most recently-activated version
+		$most_recently_active_version = EE_System::getMostRecentlyActiveVersion($activation_history);
+		return version_compare($current_version, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function getMostRecentlyActiveVersion(array $activation_history): string
+	{
+		$most_recent_activation_date  = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $activation_dates) {
+				// check there is a record of when this version was activated.
+				// Otherwise, mark it as unknown
+				if (! $activation_dates) {
+					$activation_dates = ['unknown-date'];
+				}
+				$activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
+				foreach ($activation_dates as $activation_date) {
+					if ($activation_date !== 'unknown-date' && $activation_date > $most_recent_activation_date) {
+						$most_recently_active_version = $version;
+						$most_recent_activation_date  = $activation_date;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = ['page' => 'espresso_about'];
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			EEH_URL::safeRedirectAndExit($url);
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models                 = glob(EE_MODELS . '*.model.php');
+		$model_names            = [];
+		$non_abstract_db_models = [];
+		foreach ($models as $model) {
+			// get model classname
+			$classname       = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name      = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 */
+	private function _maybe_brew_regular()
+	{
+		/** @var Domain $domain */
+		$domain = DomainFactory::getEventEspressoCoreDomain();
+		if ($domain->isCaffeinated()) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+	/**
+	 * @throws Exception
+	 * @since 4.9.71.p
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteMatchSpecificationManager');
+			$this->loader->getShared('EventEspresso\core\services\routing\RouteCollection');
+			$this->router->loadPrimaryRoutes();
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		$this->router->registerShortcodesModulesAndWidgets();
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = __(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= __(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 * @throws Exception
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', [$this, 'set_hooks_for_core'], 1);
+		add_action('init', [$this, 'perform_activations_upgrades_and_migrations'], 3);
+		add_action('init', [$this, 'load_CPTs_and_session'], 5);
+		add_action('init', [$this, 'load_controllers'], 7);
+		add_action('init', [$this, 'core_loaded_and_ready'], 9);
+		add_action('init', [$this, 'initialize'], 10);
+		add_action('init', [$this, 'initialize_last'], 100);
+		$this->router->brewEspresso();
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', []);
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', []);
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						unset($_GET['activate']);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies $register_custom_taxonomies */
+		$register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$register_custom_taxonomies->registerCustomTaxonomies();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes $register_custom_post_types */
+		$register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$register_custom_post_types->registerCustomPostTypes();
+		/** @var EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms $register_custom_taxonomy_terms */
+		$register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		$register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		$this->router->loadControllers();
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		$this->router->coreLoadedAndReady();
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		$this->router->initializeLast();
+		add_action('admin_bar_init', [$this, 'addEspressoToolbar']);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			[$this->registry->CAP]
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', ['EE_System', 'nocache_headers'], 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', ['EE_System', 'extra_nocache_headers'], 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers): array
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages(array $exclude_array): array
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
 }

Spacing +21 added lines, -21 removed lines

@@ -144,7 +144,7 @@ 
         Router $router = null
     ): EE_System {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($loader, $maintenance_mode, $registry, $request, $router);
         }
         return self::$_instance;
@@ -268,7 +268,7 @@ 
         $this->capabilities = $this->loader->getShared('EE_Capabilities');
         add_action(
             'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
+            function() {
                 LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             }
         );
@@ -426,11 +426,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null): array
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -450,10 +450,10 @@ 
                     // so it must be numerically-indexed, where values are versions installed...
                     // fix it!
                     $version_string                         = $should_be_array;
-                    $corrected_db_update[ $version_string ] = ['unknown-date'];
+                    $corrected_db_update[$version_string] = ['unknown-date'];
                 } else {
                     // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
                 }
             }
             $espresso_db_update = $corrected_db_update;
@@ -536,13 +536,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null): bool
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = espresso_version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // re-save
         return update_option('espresso_db_update', $version_history);
     }
@@ -710,7 +710,7 @@ 
             foreach ($activation_history as $version => $activation_dates) {
                 // check there is a record of when this version was activated.
                 // Otherwise, mark it as unknown
-                if (! $activation_dates) {
+                if ( ! $activation_dates) {
                     $activation_dates = ['unknown-date'];
                 }
                 $activation_dates = is_string($activation_dates) ? [$activation_dates] : $activation_dates;
@@ -735,7 +735,7 @@ 
     {
         $notices = EE_Error::get_notices(false);
         // if current user is an admin and it's not an ajax or rest request
-        if (! isset($notices['errors'])
+        if ( ! isset($notices['errors'])
             && $this->request->isAdmin()
             && apply_filters(
                 'FHEE__EE_System__redirect_to_about_ee__do_redirect',
@@ -804,7 +804,7 @@ 
     private function _parse_model_names()
     {
         // get all the files in the EE_MODELS folder that end in .model.php
-        $models                 = glob(EE_MODELS . '*.model.php');
+        $models                 = glob(EE_MODELS.'*.model.php');
         $model_names            = [];
         $non_abstract_db_models = [];
         foreach ($models as $model) {
@@ -813,9 +813,9 @@ 
             $short_name      = str_replace('EEM_', '', $classname);
             $reflectionClass = new ReflectionClass($classname);
             if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
+                $non_abstract_db_models[$short_name] = $classname;
             }
-            $model_names[ $short_name ] = $classname;
+            $model_names[$short_name] = $classname;
         }
         $this->registry->models                 = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
         $this->registry->non_abstract_db_models = apply_filters(
@@ -842,7 +842,7 @@ 
         /** @var Domain $domain */
         $domain = DomainFactory::getEventEspressoCoreDomain();
         if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -897,7 +897,7 @@ 
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
         );
-        if (! empty($class_names)) {
+        if ( ! empty($class_names)) {
             $msg = __(
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
                 'event_espresso'
@@ -909,7 +909,7 @@ 
                             ['EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'],
                             '',
                             $class_name
-                        ) . '</b></li>';
+                        ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= __(
@@ -975,7 +975,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', []);
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', []);
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1063,7 +1063,7 @@ 
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // always load template tags, because it's faster than checking if it's a front-end request, and many page
         // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
+        require_once EE_PUBLIC.'template_tags.php';
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
     }
 
@@ -1125,13 +1125,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

core/interfaces/EEHI_File.interface.php

Indentation +18 added lines, -18 removed lines

@@ -6,27 +6,27 @@
 interface EEHI_File
 {
 
-    /**
-     * ensure_file_exists_and_is_writable
-     * ensures that a file exists and is writable, will attempt to create file if it does not exist
-     *
-     * @param string $full_file_path
-     * @throws EE_Error
-     * @return bool
-     */
-    public static function ensure_file_exists_and_is_writable(string $full_file_path = ''): bool;
+	/**
+	 * ensure_file_exists_and_is_writable
+	 * ensures that a file exists and is writable, will attempt to create file if it does not exist
+	 *
+	 * @param string $full_file_path
+	 * @throws EE_Error
+	 * @return bool
+	 */
+	public static function ensure_file_exists_and_is_writable(string $full_file_path = ''): bool;
 
 
 
-    /**
-     * ensure_folder_exists_and_is_writable
-     * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
-     *
-     * @param string $folder
-     * @throws EE_Error
-     * @return bool
-     */
-    public static function ensure_folder_exists_and_is_writable(string $folder = ''): bool;
+	/**
+	 * ensure_folder_exists_and_is_writable
+	 * ensures that a folder exists and is writable, will attempt to create folder if it does not exist
+	 *
+	 * @param string $folder
+	 * @throws EE_Error
+	 * @return bool
+	 */
+	public static function ensure_folder_exists_and_is_writable(string $folder = ''): bool;
 }
 // End of file EEHI_File.interface.php
 // Location: core/interfaces/EEHI_File.interface.php

core/EE_Psr4AutoloaderInit.core.php

Indentation +35 added lines, -35 removed lines

@@ -17,39 +17,39 @@
 {
 
 
-    /**
-     * @type Psr4Autoloader
-     */
-    protected static $psr4_loader;
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function initializeAutoloader()
-    {
-        static $initialized = false;
-        if (! $initialized) {
-            // instantiate PSR4 autoloader
-            espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
-            EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
-            // register the autoloader
-            EE_Psr4AutoloaderInit::$psr4_loader->register();
-            // register the base directories for the namespace prefix
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
-            EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
-            $initialized = true;
-        }
-    }
-
-
-    /**
-     * @return Psr4Autoloader
-     */
-    public static function psr4_loader(): Psr4Autoloader
-    {
-        return self::$psr4_loader;
-    }
+	/**
+	 * @type Psr4Autoloader
+	 */
+	protected static $psr4_loader;
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initializeAutoloader()
+	{
+		static $initialized = false;
+		if (! $initialized) {
+			// instantiate PSR4 autoloader
+			espresso_load_required('Psr4Autoloader', EE_CORE . 'Psr4Autoloader.php');
+			EE_Psr4AutoloaderInit::$psr4_loader = new Psr4Autoloader();
+			// register the autoloader
+			EE_Psr4AutoloaderInit::$psr4_loader->register();
+			// register the base directories for the namespace prefix
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspresso', EE_PLUGIN_DIR_PATH);
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoBatchRequest', EE_LIBRARIES . 'batch');
+			EE_Psr4AutoloaderInit::$psr4_loader->addNamespace('EventEspressoVendor', EE_THIRD_PARTY);
+			$initialized = true;
+		}
+	}
+
+
+	/**
+	 * @return Psr4Autoloader
+	 */
+	public static function psr4_loader(): Psr4Autoloader
+	{
+		return self::$psr4_loader;
+	}
 }