eventespresso / event-espresso-core

core/services/request/DataType.php

Indentation +94 added lines, -94 removed lines

@@ -12,98 +12,98 @@
  */
 class DataType
 {
-    const ARRAY   = 'array';
-
-    const BOOL    = 'bool';
-
-    const BOOLEAN = 'bool';
-
-    const DOUBLE  = 'float';
-
-    const FLOAT   = 'float';
-
-    const EDITOR  = 'editor';
-
-    const EMAIL   = 'email';
-
-    const FQCN    = 'fqcn';
-
-    const HTML    = 'html';
-
-    const INT     = 'int';
-
-    const INTEGER = 'int';
-
-    const KEY     = 'key';
-
-    const OBJECT  = 'object';
-
-    const NULL    = 'null';
-
-    const TITLE   = 'title';
-
-    const URL     = 'url';
-
-    const STRING  = 'string';
-
-
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return mixed
-     */
-    public static function setDataType($param, string $type)
-    {
-        switch ($type) {
-            case DataType::NULL:
-                return null;
-            case DataType::OBJECT:
-                return $param;
-            case DataType::EDITOR:
-            case DataType::EMAIL:
-            case DataType::FQCN:
-            case DataType::HTML:
-            case DataType::KEY:
-            case DataType::STRING:
-            case DataType::TITLE:
-            case DataType::URL:
-                settype($param, DataType::STRING);
-                break;
-            default:
-                settype($param, $type);
-        }
-        return $param;
-    }
-
-
-    public static function convertModelFieldSchemaType($schema_type): ?string
-    {
-        if (is_array($schema_type)) {
-            foreach ($schema_type as $type) {
-                $data_type = self::convertModelFieldSchemaType($type);
-                if ($data_type) {
-                    return $data_type;
-                }
-            }
-            $schema_type = reset($schema_type);
-        }
-        switch ($schema_type) {
-            case 'array':
-                return DataType::ARRAY;
-            case 'boolean':
-                return DataType::BOOL;
-            case 'integer':
-                return DataType::INT;
-            case 'null':
-                return DataType::NULL;
-            case 'number':
-                return DataType::FLOAT;
-            case 'object':
-                return DataType::OBJECT;
-            case 'string':
-                return DataType::STRING;
-            default:
-                return null;
-        }
-    }
+	const ARRAY   = 'array';
+
+	const BOOL    = 'bool';
+
+	const BOOLEAN = 'bool';
+
+	const DOUBLE  = 'float';
+
+	const FLOAT   = 'float';
+
+	const EDITOR  = 'editor';
+
+	const EMAIL   = 'email';
+
+	const FQCN    = 'fqcn';
+
+	const HTML    = 'html';
+
+	const INT     = 'int';
+
+	const INTEGER = 'int';
+
+	const KEY     = 'key';
+
+	const OBJECT  = 'object';
+
+	const NULL    = 'null';
+
+	const TITLE   = 'title';
+
+	const URL     = 'url';
+
+	const STRING  = 'string';
+
+
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return mixed
+	 */
+	public static function setDataType($param, string $type)
+	{
+		switch ($type) {
+			case DataType::NULL:
+				return null;
+			case DataType::OBJECT:
+				return $param;
+			case DataType::EDITOR:
+			case DataType::EMAIL:
+			case DataType::FQCN:
+			case DataType::HTML:
+			case DataType::KEY:
+			case DataType::STRING:
+			case DataType::TITLE:
+			case DataType::URL:
+				settype($param, DataType::STRING);
+				break;
+			default:
+				settype($param, $type);
+		}
+		return $param;
+	}
+
+
+	public static function convertModelFieldSchemaType($schema_type): ?string
+	{
+		if (is_array($schema_type)) {
+			foreach ($schema_type as $type) {
+				$data_type = self::convertModelFieldSchemaType($type);
+				if ($data_type) {
+					return $data_type;
+				}
+			}
+			$schema_type = reset($schema_type);
+		}
+		switch ($schema_type) {
+			case 'array':
+				return DataType::ARRAY;
+			case 'boolean':
+				return DataType::BOOL;
+			case 'integer':
+				return DataType::INT;
+			case 'null':
+				return DataType::NULL;
+			case 'number':
+				return DataType::FLOAT;
+			case 'object':
+				return DataType::OBJECT;
+			case 'string':
+				return DataType::STRING;
+			default:
+				return null;
+		}
+	}
 }

core/services/request/Request.php

Indentation +540 added lines, -540 removed lines

@@ -16,544 +16,544 @@
  */
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array|null
-     */
-    protected ?array $cookies;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array|null
-     */
-    protected ?array $files;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool
-     */
-    protected bool $is_bot;
-
-    protected RequestParams $request_params;
-
-    protected ?RequestTypeContextCheckerInterface $request_type = null;
-
-    protected ServerParams $server_params;
-
-
-    public function __construct(
-        RequestParams $request_params,
-        ServerParams $server_params,
-        array $cookies = [],
-        array $files = []
-    ) {
-        $this->cookies        = ! empty($cookies)
-            ? $cookies
-            : filter_input_array(INPUT_COOKIE, FILTER_UNSAFE_RAW);
-        $this->files          = ! empty($files) ? $files : $_FILES;
-        $this->request_params = $request_params;
-        $this->server_params  = $server_params;
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->request_params->getParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->request_params->postParams();
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookies;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server_params->getAllServerParams();
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null)
-    {
-        return $this->server_params->getServerParam($key, $default);
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @param bool                   $set_global_too
-     * @return void
-     */
-    public function setServerParam(string $key, $value, bool $set_global_too = false)
-    {
-        $this->server_params->setServerParam($key, $value, $set_global_too);
-    }
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return $this->server_params->serverParamIsSet($key);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filesParams()
-    {
-        return $this->files;
-    }
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request_params->requestParams();
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        $this->request_params->setRequestParam($key, $value, $override_ee);
-    }
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return void
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params)
-    {
-        $this->request_params->mergeRequestParams($request_params);
-    }
-
-
-    /**
-     * returns sanitized value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->request_params->requestParamIsSet($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the sanitized value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
-    {
-        return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return bool
-     */
-    public function matches($pattern)
-    {
-        return $this->request_params->matches($pattern);
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        $this->request_params->unSetRequestParams($keys, $unset_from_global_too);
-    }
-
-
-    /**
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     * @return void
-     */
-    public function unSetServerParam(string $key, bool $unset_from_global_too = false)
-    {
-        $this->server_params->unSetServerParam($key, $unset_from_global_too);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->server_params->ipAddress();
-    }
-
-
-    /**
-     * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
-     *
-     * @param boolean $relativeToWpRoot    If home_url() is "http://mysite.com/wp/", and a request comes to
-     *                                     "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
-     *                                     "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
-     * @param boolean $remove_query_params whether to return the uri with all query params removed.
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false, $remove_query_params = false)
-    {
-        return $this->server_params->requestUri($relativeToWpRoot);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->server_params->userAgent();
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->server_params->setUserAgent($user_agent);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isGQL()
-    {
-        return $this->request_type->isGQL();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isUnitTesting()
-    {
-        return $this->request_type->isUnitTesting();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressApi()
-    {
-        return $this->request_type->isWordPressApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressHeartbeat()
-    {
-        return $this->request_type->isWordPressHeartbeat();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isWordPressScrape()
-    {
-        return $this->request_type->isWordPressScrape();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
-
-
-    /**
-     * returns the path portion of the current request URI with both the WP Root (home_url()) and query params removed
-     *
-     * @return string
-     * @since   5.0.0.p
-     */
-    public function requestPath()
-    {
-        return $this->requestUri(true, true);
-    }
-
-
-    /**
-     * returns true if the last segment of the current request path (without params) matches the provided string
-     *
-     * @param string $uri_segment
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function currentPageIs($uri_segment)
-    {
-        $request_path = $this->requestPath();
-        $current_page = explode('/', $request_path);
-        return end($current_page) === $uri_segment;
-    }
-
-
-    /**
-     * @return RequestTypeContextCheckerInterface
-     */
-    public function getRequestType(): RequestTypeContextCheckerInterface
-    {
-        return $this->request_type;
-    }
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array|null
+	 */
+	protected ?array $cookies;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array|null
+	 */
+	protected ?array $files;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool
+	 */
+	protected bool $is_bot;
+
+	protected RequestParams $request_params;
+
+	protected ?RequestTypeContextCheckerInterface $request_type = null;
+
+	protected ServerParams $server_params;
+
+
+	public function __construct(
+		RequestParams $request_params,
+		ServerParams $server_params,
+		array $cookies = [],
+		array $files = []
+	) {
+		$this->cookies        = ! empty($cookies)
+			? $cookies
+			: filter_input_array(INPUT_COOKIE, FILTER_UNSAFE_RAW);
+		$this->files          = ! empty($files) ? $files : $_FILES;
+		$this->request_params = $request_params;
+		$this->server_params  = $server_params;
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->request_params->getParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->request_params->postParams();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookies;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server_params->getAllServerParams();
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null)
+	{
+		return $this->server_params->getServerParam($key, $default);
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @param bool                   $set_global_too
+	 * @return void
+	 */
+	public function setServerParam(string $key, $value, bool $set_global_too = false)
+	{
+		$this->server_params->setServerParam($key, $value, $set_global_too);
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return $this->server_params->serverParamIsSet($key);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams()
+	{
+		return $this->files;
+	}
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request_params->requestParams();
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		$this->request_params->setRequestParam($key, $value, $override_ee);
+	}
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return void
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params)
+	{
+		$this->request_params->mergeRequestParams($request_params);
+	}
+
+
+	/**
+	 * returns sanitized value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getRequestParam($key, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->request_params->requestParamIsSet($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the sanitized value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '')
+	{
+		return $this->request_params->getMatch($pattern, $default, $type, $is_array, $delimiter);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return bool
+	 */
+	public function matches($pattern)
+	{
+		return $this->request_params->matches($pattern);
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		$this->request_params->unSetRequestParams($keys, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 * @return void
+	 */
+	public function unSetServerParam(string $key, bool $unset_from_global_too = false)
+	{
+		$this->server_params->unSetServerParam($key, $unset_from_global_too);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->server_params->ipAddress();
+	}
+
+
+	/**
+	 * Gets the request's literal URI. Related to `requestUriAfterSiteHomeUri`, see its description for a comparison.
+	 *
+	 * @param boolean $relativeToWpRoot    If home_url() is "http://mysite.com/wp/", and a request comes to
+	 *                                     "http://mysite.com/wp/wp-json", setting $relativeToWpRoot=true will return
+	 *                                     "/wp-json", whereas $relativeToWpRoot=false will return "/wp/wp-json/".
+	 * @param boolean $remove_query_params whether to return the uri with all query params removed.
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false, $remove_query_params = false)
+	{
+		return $this->server_params->requestUri($relativeToWpRoot);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->server_params->userAgent();
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->server_params->setUserAgent($user_agent);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isGQL()
+	{
+		return $this->request_type->isGQL();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isUnitTesting()
+	{
+		return $this->request_type->isUnitTesting();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressApi()
+	{
+		return $this->request_type->isWordPressApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressHeartbeat()
+	{
+		return $this->request_type->isWordPressHeartbeat();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isWordPressScrape()
+	{
+		return $this->request_type->isWordPressScrape();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
+
+
+	/**
+	 * returns the path portion of the current request URI with both the WP Root (home_url()) and query params removed
+	 *
+	 * @return string
+	 * @since   5.0.0.p
+	 */
+	public function requestPath()
+	{
+		return $this->requestUri(true, true);
+	}
+
+
+	/**
+	 * returns true if the last segment of the current request path (without params) matches the provided string
+	 *
+	 * @param string $uri_segment
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function currentPageIs($uri_segment)
+	{
+		$request_path = $this->requestPath();
+		$current_page = explode('/', $request_path);
+		return end($current_page) === $uri_segment;
+	}
+
+
+	/**
+	 * @return RequestTypeContextCheckerInterface
+	 */
+	public function getRequestType(): RequestTypeContextCheckerInterface
+	{
+		return $this->request_type;
+	}
 }

core/services/loaders/Loader.php

Indentation +115 added lines, -115 removed lines

@@ -14,119 +14,119 @@
  */
 class Loader implements LoaderInterface
 {
-    private LoaderDecoratorInterface $new_loader;
-
-    private LoaderDecoratorInterface $shared_loader;
-
-    private ClassInterfaceCache $class_cache;
-
-    /**
-     * Loader constructor.
-     *
-     * @param LoaderDecoratorInterface        $new_loader
-     * @param CachingLoaderDecoratorInterface $shared_loader
-     * @param ClassInterfaceCache             $class_cache
-     */
-    public function __construct(
-        LoaderDecoratorInterface $new_loader,
-        CachingLoaderDecoratorInterface $shared_loader,
-        ClassInterfaceCache $class_cache
-    ) {
-        $this->new_loader    = $new_loader;
-        $this->shared_loader = $shared_loader;
-        $this->class_cache   = $class_cache;
-    }
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    public function getNewLoader()
-    {
-        return $this->new_loader;
-    }
-
-
-    /**
-     * @return CachingLoaderDecoratorInterface
-     */
-    public function getSharedLoader()
-    {
-        return $this->shared_loader;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = array(), $shared = true)
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) {
-            $shared = true;
-        }
-        return $shared
-            ? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
-            : $this->getNewLoader()->load($fqcn, $arguments, $shared);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, array $arguments = array())
-    {
-        return $this->load($fqcn, $arguments, false);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, array $arguments = array())
-    {
-        return $this->load($fqcn, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = [])
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->share($fqcn, $object, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn, array $arguments = [])
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->remove($fqcn, $arguments);
-    }
-
-
-    /**
-     * calls reset() on loaders if that method exists
-     */
-    public function reset()
-    {
-        $this->shared_loader->reset();
-    }
+	private LoaderDecoratorInterface $new_loader;
+
+	private LoaderDecoratorInterface $shared_loader;
+
+	private ClassInterfaceCache $class_cache;
+
+	/**
+	 * Loader constructor.
+	 *
+	 * @param LoaderDecoratorInterface        $new_loader
+	 * @param CachingLoaderDecoratorInterface $shared_loader
+	 * @param ClassInterfaceCache             $class_cache
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $new_loader,
+		CachingLoaderDecoratorInterface $shared_loader,
+		ClassInterfaceCache $class_cache
+	) {
+		$this->new_loader    = $new_loader;
+		$this->shared_loader = $shared_loader;
+		$this->class_cache   = $class_cache;
+	}
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	public function getNewLoader()
+	{
+		return $this->new_loader;
+	}
+
+
+	/**
+	 * @return CachingLoaderDecoratorInterface
+	 */
+	public function getSharedLoader()
+	{
+		return $this->shared_loader;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = array(), $shared = true)
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) {
+			$shared = true;
+		}
+		return $shared
+			? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
+			: $this->getNewLoader()->load($fqcn, $arguments, $shared);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, array $arguments = array())
+	{
+		return $this->load($fqcn, $arguments, false);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, array $arguments = array())
+	{
+		return $this->load($fqcn, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = [])
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->share($fqcn, $object, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn, array $arguments = [])
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->remove($fqcn, $arguments);
+	}
+
+
+	/**
+	 * calls reset() on loaders if that method exists
+	 */
+	public function reset()
+	{
+		$this->shared_loader->reset();
+	}
 }

core/services/loaders/CachingLoader.php

Indentation +187 added lines, -187 removed lines

@@ -16,191 +16,191 @@
  */
 class CachingLoader extends CachingLoaderDecorator
 {
-    protected bool $bypass = false;
-
-    protected CollectionInterface $cache;
-
-    protected string $identifier;
-
-    private ObjectIdentifier $object_identifier;
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param ObjectIdentifier         $object_identifier
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        LoaderDecoratorInterface $loader,
-        CollectionInterface $cache,
-        ObjectIdentifier $object_identifier,
-        string $identifier = ''
-    ) {
-        parent::__construct($loader);
-        $this->cache             = $cache;
-        $this->object_identifier = $object_identifier;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__$identifier",
-                [$this, 'reset']
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            [$this, 'reset']
-        );
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        $this->bypass = filter_var(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-                false,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier(): string
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string|null $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier(?string $identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = []): bool
-    {
-        if ($object instanceof $fqcn) {
-            $added = false;
-            if ($arguments) {
-                // first cache the object using the identifier that includes the arguments
-                $added = $this->cache->add($object, $this->object_identifier->getIdentifier($fqcn, $arguments));
-            }
-            // then again using the identifier without the arguments
-            // WHY? because most requests for the object will not include arguments
-            $object_identifier = $this->object_identifier->getIdentifier($fqcn);
-            // but only if the object is not already in the cache
-            if (! $this->cache->has($object_identifier)) {
-                $added = $this->cache->add($object, $object_identifier)
-                    ? true
-                    : $added;
-            }
-            return $added;
-        }
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
-                    'event_espresso'
-                ),
-                $fqcn
-            )
-        );
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @param array                     $interfaces
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = [], $shared = true, array $interfaces = [])
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if ($this->bypass) {
-            // even though $shared might be true, caching could be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        if ($this->cache->has($object_identifier)) {
-            return $this->cache->get($object_identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if ($object instanceof $fqcn) {
-            $this->cache->add($object, $object_identifier);
-        }
-        return $object;
-    }
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->clearCache();
-        $this->loader->reset();
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the cache
-     *
-     * @since 4.9.62.p
-     */
-    public function clearCache()
-    {
-        $cache_class          = get_class($this->cache);
-        $collection_interface = $this->cache->collectionInterface();
-        $this->cache->trashAndDetachAll();
-        $this->cache = new $cache_class($collection_interface);
-        if (! $this->cache instanceof CollectionInterface) {
-            throw new InvalidDataTypeException('CachingLoader::$cache', $this->cache, 'CollectionInterface');
-        }
-    }
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn, array $arguments = []): bool
-    {
-        $fqcn              = ltrim($fqcn, '\\');
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        $object            = $this->cache->has($object_identifier)
-            ? $this->cache->get($object_identifier)
-            : $this->loader->load($fqcn, $arguments);
-        return $this->cache->remove($object);
-    }
+	protected bool $bypass = false;
+
+	protected CollectionInterface $cache;
+
+	protected string $identifier;
+
+	private ObjectIdentifier $object_identifier;
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param ObjectIdentifier         $object_identifier
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $loader,
+		CollectionInterface $cache,
+		ObjectIdentifier $object_identifier,
+		string $identifier = ''
+	) {
+		parent::__construct($loader);
+		$this->cache             = $cache;
+		$this->object_identifier = $object_identifier;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__$identifier",
+				[$this, 'reset']
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			[$this, 'reset']
+		);
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		$this->bypass = filter_var(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+				false,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier(): string
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string|null $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier(?string $identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = []): bool
+	{
+		if ($object instanceof $fqcn) {
+			$added = false;
+			if ($arguments) {
+				// first cache the object using the identifier that includes the arguments
+				$added = $this->cache->add($object, $this->object_identifier->getIdentifier($fqcn, $arguments));
+			}
+			// then again using the identifier without the arguments
+			// WHY? because most requests for the object will not include arguments
+			$object_identifier = $this->object_identifier->getIdentifier($fqcn);
+			// but only if the object is not already in the cache
+			if (! $this->cache->has($object_identifier)) {
+				$added = $this->cache->add($object, $object_identifier)
+					? true
+					: $added;
+			}
+			return $added;
+		}
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The supplied class name "%1$s" must match the class of the supplied object.',
+					'event_espresso'
+				),
+				$fqcn
+			)
+		);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @param array                     $interfaces
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = [], $shared = true, array $interfaces = [])
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if ($this->bypass) {
+			// even though $shared might be true, caching could be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		if ($this->cache->has($object_identifier)) {
+			return $this->cache->get($object_identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if ($object instanceof $fqcn) {
+			$this->cache->add($object, $object_identifier);
+		}
+		return $object;
+	}
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->clearCache();
+		$this->loader->reset();
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the cache
+	 *
+	 * @since 4.9.62.p
+	 */
+	public function clearCache()
+	{
+		$cache_class          = get_class($this->cache);
+		$collection_interface = $this->cache->collectionInterface();
+		$this->cache->trashAndDetachAll();
+		$this->cache = new $cache_class($collection_interface);
+		if (! $this->cache instanceof CollectionInterface) {
+			throw new InvalidDataTypeException('CachingLoader::$cache', $this->cache, 'CollectionInterface');
+		}
+	}
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn, array $arguments = []): bool
+	{
+		$fqcn              = ltrim($fqcn, '\\');
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		$object            = $this->cache->has($object_identifier)
+			? $this->cache->get($object_identifier)
+			: $this->loader->load($fqcn, $arguments);
+		return $this->cache->remove($object);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
      */
     private function setIdentifier(?string $identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;
@@ -113,7 +113,7 @@ 
             // WHY? because most requests for the object will not include arguments
             $object_identifier = $this->object_identifier->getIdentifier($fqcn);
             // but only if the object is not already in the cache
-            if (! $this->cache->has($object_identifier)) {
+            if ( ! $this->cache->has($object_identifier)) {
                 $added = $this->cache->add($object, $object_identifier)
                     ? true
                     : $added;
@@ -182,7 +182,7 @@ 
         $collection_interface = $this->cache->collectionInterface();
         $this->cache->trashAndDetachAll();
         $this->cache = new $cache_class($collection_interface);
-        if (! $this->cache instanceof CollectionInterface) {
+        if ( ! $this->cache instanceof CollectionInterface) {
             throw new InvalidDataTypeException('CachingLoader::$cache', $this->cache, 'CollectionInterface');
         }
     }

core/services/loaders/ObjectIdentifier.php

Indentation +97 added lines, -97 removed lines

@@ -16,112 +16,112 @@
  */
 class ObjectIdentifier
 {
-    /**
-     * used to separate the FQCN from the class's arguments identifier
-     */
-    const DELIMITER = '____';
+	/**
+	 * used to separate the FQCN from the class's arguments identifier
+	 */
+	const DELIMITER = '____';
 
-    private ClassInterfaceCache $class_cache;
+	private ClassInterfaceCache $class_cache;
 
 
-    /**
-     * ObjectIdentifier constructor.
-     *
-     * @param ClassInterfaceCache $class_cache
-     */
-    public function __construct(ClassInterfaceCache $class_cache)
-    {
-        $this->class_cache = $class_cache;
-    }
+	/**
+	 * ObjectIdentifier constructor.
+	 *
+	 * @param ClassInterfaceCache $class_cache
+	 */
+	public function __construct(ClassInterfaceCache $class_cache)
+	{
+		$this->class_cache = $class_cache;
+	}
 
 
-    /**
-     * Returns true if the supplied $object_identifier contains
-     * the delimiter used to separate a fqcn from the arguments hash
-     *
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function hasArguments(string $object_identifier): bool
-    {
-        // not using strpos() !== false
-        // because an object identifier should never begin with the delimiter
-        // therefore the delimiter should NOT be found at position 0
-        return strpos($object_identifier, ObjectIdentifier::DELIMITER) > 0;
-    }
+	/**
+	 * Returns true if the supplied $object_identifier contains
+	 * the delimiter used to separate a fqcn from the arguments hash
+	 *
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function hasArguments(string $object_identifier): bool
+	{
+		// not using strpos() !== false
+		// because an object identifier should never begin with the delimiter
+		// therefore the delimiter should NOT be found at position 0
+		return strpos($object_identifier, ObjectIdentifier::DELIMITER) > 0;
+	}
 
 
-    /**
-     * Returns true if the supplied FQCN equals the supplied $object_identifier
-     * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
-     * AND that $object_identifier is for an object with arguments.
-     * This allows a request for an object using a FQCN to match
-     * a previously instantiated object with arguments
-     * without having to know those arguments.
-     *
-     * @param string $fqcn
-     * @param string $object_identifier
-     * @return bool
-     */
-    public function fqcnMatchesObjectIdentifier(string $fqcn, string $object_identifier): bool
-    {
-        $fqcn = str_replace('\\', '_', $fqcn);
-        return $fqcn === $object_identifier
-            || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
-    }
+	/**
+	 * Returns true if the supplied FQCN equals the supplied $object_identifier
+	 * OR the supplied FQCN matches the FQCN portion of the supplied $object_identifier
+	 * AND that $object_identifier is for an object with arguments.
+	 * This allows a request for an object using a FQCN to match
+	 * a previously instantiated object with arguments
+	 * without having to know those arguments.
+	 *
+	 * @param string $fqcn
+	 * @param string $object_identifier
+	 * @return bool
+	 */
+	public function fqcnMatchesObjectIdentifier(string $fqcn, string $object_identifier): bool
+	{
+		$fqcn = str_replace('\\', '_', $fqcn);
+		return $fqcn === $object_identifier
+			|| strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+	}
 
 
-    /**
-     * build a string representation of an object's FQCN and arguments
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return string
-     */
-    public function getIdentifier(string $fqcn, array $arguments = []): string
-    {
-        // only build identifier from arguments if class is not ReservedInstanceInterface
-        $identifier = ! $this->class_cache->hasInterface($fqcn, ReservedInstanceInterface::class)
-            ? $this->getIdentifierForArguments($arguments)
-            : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
-        }
-        return str_replace('\\', '_', $fqcn);
-    }
+	/**
+	 * build a string representation of an object's FQCN and arguments
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return string
+	 */
+	public function getIdentifier(string $fqcn, array $arguments = []): string
+	{
+		// only build identifier from arguments if class is not ReservedInstanceInterface
+		$identifier = ! $this->class_cache->hasInterface($fqcn, ReservedInstanceInterface::class)
+			? $this->getIdentifierForArguments($arguments)
+			: '';
+		if (! empty($identifier)) {
+			$fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+		}
+		return str_replace('\\', '_', $fqcn);
+	}
 
 
-    /**
-     * build a string representation of an object's arguments
-     * (mostly because Closures can't be serialized)
-     *
-     * @param array $arguments
-     * @return string
-     */
-    protected function getIdentifierForArguments(array $arguments): string
-    {
-        if (empty($arguments)) {
-            return '';
-        }
-        $identifier = '';
-        foreach ($arguments as $key => $argument) {
-            // don't include arguments used to assist with loading legacy classes
-            if (is_string($key) && strpos($key, 'EE_Registry::create') === 0) {
-                continue;
-            }
-            switch (true) {
-                case is_object($argument):
-                case $argument instanceof Closure:
-                    $identifier .= spl_object_hash($argument);
-                    break;
-                case is_array($argument):
-                    $identifier .= $this->getIdentifierForArguments($argument);
-                    break;
-                default:
-                    $identifier .= sanitize_key($argument);
-                    break;
-            }
-        }
-        return $identifier;
-    }
+	/**
+	 * build a string representation of an object's arguments
+	 * (mostly because Closures can't be serialized)
+	 *
+	 * @param array $arguments
+	 * @return string
+	 */
+	protected function getIdentifierForArguments(array $arguments): string
+	{
+		if (empty($arguments)) {
+			return '';
+		}
+		$identifier = '';
+		foreach ($arguments as $key => $argument) {
+			// don't include arguments used to assist with loading legacy classes
+			if (is_string($key) && strpos($key, 'EE_Registry::create') === 0) {
+				continue;
+			}
+			switch (true) {
+				case is_object($argument):
+				case $argument instanceof Closure:
+					$identifier .= spl_object_hash($argument);
+					break;
+				case is_array($argument):
+					$identifier .= $this->getIdentifierForArguments($argument);
+					break;
+				default:
+					$identifier .= sanitize_key($argument);
+					break;
+			}
+		}
+		return $identifier;
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -67,7 +67,7 @@ 
     {
         $fqcn = str_replace('\\', '_', $fqcn);
         return $fqcn === $object_identifier
-            || strpos($object_identifier, $fqcn . ObjectIdentifier::DELIMITER) === 0;
+            || strpos($object_identifier, $fqcn.ObjectIdentifier::DELIMITER) === 0;
     }
 
 
@@ -84,8 +84,8 @@ 
         $identifier = ! $this->class_cache->hasInterface($fqcn, ReservedInstanceInterface::class)
             ? $this->getIdentifierForArguments($arguments)
             : '';
-        if (! empty($identifier)) {
-            $fqcn .= ObjectIdentifier::DELIMITER . md5($identifier);
+        if ( ! empty($identifier)) {
+            $fqcn .= ObjectIdentifier::DELIMITER.md5($identifier);
         }
         return str_replace('\\', '_', $fqcn);
     }

core/services/addon/AddonManager.php

Indentation +90 added lines, -90 removed lines

@@ -24,106 +24,106 @@
  */
 class AddonManager
 {
-    private AddonCollection $addons;
+	private AddonCollection $addons;
 
-    private EE_Dependency_Map $dependency_map;
+	private EE_Dependency_Map $dependency_map;
 
-    private IncompatibleAddonHandler $incompatible_addon_handler;
+	private IncompatibleAddonHandler $incompatible_addon_handler;
 
-    private RegisterV1Addon $register_v1_addon;
+	private RegisterV1Addon $register_v1_addon;
 
-    private ThirdPartyPluginHandler $third_party_plugin_handler;
+	private ThirdPartyPluginHandler $third_party_plugin_handler;
 
 
-    /**
-     * AddonManager constructor.
-     *
-     * @param AddonCollection          $addons
-     * @param EE_Dependency_Map        $dependency_map
-     * @param IncompatibleAddonHandler $incompatible_addon_handler
-     * @param RegisterV1Addon          $register_v1_addon
-     * @param ThirdPartyPluginHandler  $third_party_plugin_handler
-     */
-    public function __construct(
-        AddonCollection $addons,
-        EE_Dependency_Map $dependency_map,
-        IncompatibleAddonHandler $incompatible_addon_handler,
-        RegisterV1Addon $register_v1_addon,
-        ThirdPartyPluginHandler $third_party_plugin_handler
-    ) {
-        $this->addons                     = $addons;
-        $this->dependency_map             = $dependency_map;
-        $this->incompatible_addon_handler = $incompatible_addon_handler;
-        $this->register_v1_addon          = $register_v1_addon;
-        $this->third_party_plugin_handler = $third_party_plugin_handler;
-    }
+	/**
+	 * AddonManager constructor.
+	 *
+	 * @param AddonCollection          $addons
+	 * @param EE_Dependency_Map        $dependency_map
+	 * @param IncompatibleAddonHandler $incompatible_addon_handler
+	 * @param RegisterV1Addon          $register_v1_addon
+	 * @param ThirdPartyPluginHandler  $third_party_plugin_handler
+	 */
+	public function __construct(
+		AddonCollection $addons,
+		EE_Dependency_Map $dependency_map,
+		IncompatibleAddonHandler $incompatible_addon_handler,
+		RegisterV1Addon $register_v1_addon,
+		ThirdPartyPluginHandler $third_party_plugin_handler
+	) {
+		$this->addons                     = $addons;
+		$this->dependency_map             = $dependency_map;
+		$this->incompatible_addon_handler = $incompatible_addon_handler;
+		$this->register_v1_addon          = $register_v1_addon;
+		$this->third_party_plugin_handler = $third_party_plugin_handler;
+	}
 
 
-    /**
-     * @throws Exception
-     */
-    public function initialize()
-    {
-        // set autoloaders for all the classes implementing the legacy EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-        $this->dependency_map->registerDependencies(
-            AddonApiVersion::class,
-            [
-                'EventEspresso\core\services\addon\api\AddonRoutes'        => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\DependencyHandlers' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\Psr4Autoloader'                        => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\services\addon\api\v1\AddonApi',
-            [
-                'EventEspresso\core\services\addon\api\AddonRoutes'         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\DependencyHandlers'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\Psr4Autoloader'                         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\v1\DataMigrationApi' => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\addon\api\v1\LegacyModelApi'   => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-    }
+	/**
+	 * @throws Exception
+	 */
+	public function initialize()
+	{
+		// set autoloaders for all the classes implementing the legacy EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+		$this->dependency_map->registerDependencies(
+			AddonApiVersion::class,
+			[
+				'EventEspresso\core\services\addon\api\AddonRoutes'        => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\DependencyHandlers' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\Psr4Autoloader'                        => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\services\addon\api\v1\AddonApi',
+			[
+				'EventEspresso\core\services\addon\api\AddonRoutes'         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\DependencyHandlers'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\Psr4Autoloader'                         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\v1\DataMigrationApi' => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\addon\api\v1\LegacyModelApi'   => EE_Dependency_Map::load_from_cache,
+			]
+		);
+	}
 
 
-    /**
-     * @throws Exception
-     * @throws Throwable
-     */
-    public function loadAddons()
-    {
-        try {
-            $this->incompatible_addon_handler->deactivateIncompatibleAddons();
-            // legacy add-on API
-            do_action('AHEE__EE_System__load_espresso_addons');
-            // new add-on API that uses versioning
-            do_action('AHEE__EventEspresso_core_services_addon_AddonManager__loadAddons');
-            // addons are responsible for loading their AddonApiVersion into the AddonCollection
-            foreach ($this->addons as $addon) {
-                if ($addon instanceof AddonApiVersion) {
-                    $this->registerAddon($addon);
-                }
-            }
-            $this->third_party_plugin_handler->loadPlugins();
-            do_action('AHEE__EE_System__load_espresso_addons__complete');
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-    }
+	/**
+	 * @throws Exception
+	 * @throws Throwable
+	 */
+	public function loadAddons()
+	{
+		try {
+			$this->incompatible_addon_handler->deactivateIncompatibleAddons();
+			// legacy add-on API
+			do_action('AHEE__EE_System__load_espresso_addons');
+			// new add-on API that uses versioning
+			do_action('AHEE__EventEspresso_core_services_addon_AddonManager__loadAddons');
+			// addons are responsible for loading their AddonApiVersion into the AddonCollection
+			foreach ($this->addons as $addon) {
+				if ($addon instanceof AddonApiVersion) {
+					$this->registerAddon($addon);
+				}
+			}
+			$this->third_party_plugin_handler->loadPlugins();
+			do_action('AHEE__EE_System__load_espresso_addons__complete');
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+	}
 
 
-    /**
-     * @param AddonApiVersion $addon
-     * @throws EE_Error
-     */
-    private function registerAddon(AddonApiVersion $addon)
-    {
-        $addon->initialize();
-        // now register each addon based on it's API version
-        if ($addon instanceof AddonApiV1) {
-            $this->register_v1_addon->register($addon);
-        }
-    }
+	/**
+	 * @param AddonApiVersion $addon
+	 * @throws EE_Error
+	 */
+	private function registerAddon(AddonApiVersion $addon)
+	{
+		$addon->initialize();
+		// now register each addon based on it's API version
+		if ($addon instanceof AddonApiV1) {
+			$this->register_v1_addon->register($addon);
+		}
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -66,7 +66,7 @@
     {
         // set autoloaders for all the classes implementing the legacy EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
         $this->dependency_map->registerDependencies(
             AddonApiVersion::class,
             [

core/services/addon/api/DependencyHandlers.php

Indentation +42 added lines, -42 removed lines

@@ -17,46 +17,46 @@
  */
 class DependencyHandlers
 {
-    private EE_Dependency_Map $dependency_map;
-
-    /**
-     * array of fully qualified class names for dependency handlers where keys are add-on slugs
-     * @var string[][]
-     */
-    private array $dependency_handlers = [];
-
-
-    public function __construct(EE_Dependency_Map $dependency_map)
-    {
-        $this->dependency_map = $dependency_map;
-    }
-
-
-    public function addDependencyHandlerFor(string $dependency_handler_fqcn, string $addon_slug)
-    {
-        if (! isset($this->dependency_handlers[ $addon_slug ])) {
-            $this->dependency_handlers[ $addon_slug ] = [];
-        }
-        $this->dependency_handlers[ $addon_slug ][] = $dependency_handler_fqcn;
-    }
-
-
-    public function registerDependenciesFor(string $addon_slug)
-    {
-        if (isset($this->dependency_handlers[ $addon_slug ])) {
-            foreach ($this->dependency_handlers[ $addon_slug ] as $dependency_handler_fqcn) {
-                $dependency_handler = LoaderFactory::getNew($dependency_handler_fqcn, [$this->dependency_map]);
-                if (! $dependency_handler instanceof DependencyHandlerInterface) {
-                    throw new DomainException(
-                        sprintf(
-                            esc_html__('The dependency handler class %1$s must implement %2$s', 'event_espresso'),
-                            $dependency_handler_fqcn,
-                            DependencyHandlerInterface::class
-                        )
-                    );
-                }
-                $dependency_handler->registerDependencies();
-            }
-        }
-    }
+	private EE_Dependency_Map $dependency_map;
+
+	/**
+	 * array of fully qualified class names for dependency handlers where keys are add-on slugs
+	 * @var string[][]
+	 */
+	private array $dependency_handlers = [];
+
+
+	public function __construct(EE_Dependency_Map $dependency_map)
+	{
+		$this->dependency_map = $dependency_map;
+	}
+
+
+	public function addDependencyHandlerFor(string $dependency_handler_fqcn, string $addon_slug)
+	{
+		if (! isset($this->dependency_handlers[ $addon_slug ])) {
+			$this->dependency_handlers[ $addon_slug ] = [];
+		}
+		$this->dependency_handlers[ $addon_slug ][] = $dependency_handler_fqcn;
+	}
+
+
+	public function registerDependenciesFor(string $addon_slug)
+	{
+		if (isset($this->dependency_handlers[ $addon_slug ])) {
+			foreach ($this->dependency_handlers[ $addon_slug ] as $dependency_handler_fqcn) {
+				$dependency_handler = LoaderFactory::getNew($dependency_handler_fqcn, [$this->dependency_map]);
+				if (! $dependency_handler instanceof DependencyHandlerInterface) {
+					throw new DomainException(
+						sprintf(
+							esc_html__('The dependency handler class %1$s must implement %2$s', 'event_espresso'),
+							$dependency_handler_fqcn,
+							DependencyHandlerInterface::class
+						)
+					);
+				}
+				$dependency_handler->registerDependencies();
+			}
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -34,19 +34,19 @@
 
     public function addDependencyHandlerFor(string $dependency_handler_fqcn, string $addon_slug)
     {
-        if (! isset($this->dependency_handlers[ $addon_slug ])) {
-            $this->dependency_handlers[ $addon_slug ] = [];
+        if ( ! isset($this->dependency_handlers[$addon_slug])) {
+            $this->dependency_handlers[$addon_slug] = [];
         }
-        $this->dependency_handlers[ $addon_slug ][] = $dependency_handler_fqcn;
+        $this->dependency_handlers[$addon_slug][] = $dependency_handler_fqcn;
     }
 
 
     public function registerDependenciesFor(string $addon_slug)
     {
-        if (isset($this->dependency_handlers[ $addon_slug ])) {
-            foreach ($this->dependency_handlers[ $addon_slug ] as $dependency_handler_fqcn) {
+        if (isset($this->dependency_handlers[$addon_slug])) {
+            foreach ($this->dependency_handlers[$addon_slug] as $dependency_handler_fqcn) {
                 $dependency_handler = LoaderFactory::getNew($dependency_handler_fqcn, [$this->dependency_map]);
-                if (! $dependency_handler instanceof DependencyHandlerInterface) {
+                if ( ! $dependency_handler instanceof DependencyHandlerInterface) {
                     throw new DomainException(
                         sprintf(
                             esc_html__('The dependency handler class %1$s must implement %2$s', 'event_espresso'),

core/services/addon/api/AddonApiVersion.php

Indentation +334 added lines, -334 removed lines

@@ -23,344 +23,344 @@
  */
 abstract class AddonApiVersion
 {
-    const V1 = 1;
-
-    /**
-     * @var int one of the V# API version constants from above
-     */
-    private int $api_version;
-
-    private DomainInterface $domain;
-
-    /**
-     * @var Version|null minimum version of EE core that the add-on will work with
-     */
-    private ?Version $min_core_version = null;
-
-    /**
-     * @var Version|null minimum version of WP core that the add-on will work with
-     */
-    private ?Version $min_wp_version = null;
+	const V1 = 1;
+
+	/**
+	 * @var int one of the V# API version constants from above
+	 */
+	private int $api_version;
+
+	private DomainInterface $domain;
+
+	/**
+	 * @var Version|null minimum version of EE core that the add-on will work with
+	 */
+	private ?Version $min_core_version = null;
+
+	/**
+	 * @var Version|null minimum version of WP core that the add-on will work with
+	 */
+	private ?Version $min_wp_version = null;
 
-    private int $id;
+	private int $id;
 
-    /**
-     * @var string  PascalCase identifier for the add-on.
-     *              IMPORTANT! there must be a class of the same name in the root of the add-ons /src/domain/ folder
-     */
-    private string $name;
+	/**
+	 * @var string  PascalCase identifier for the add-on.
+	 *              IMPORTANT! there must be a class of the same name in the root of the add-ons /src/domain/ folder
+	 */
+	private string $name;
 
-    private string $display_name;
+	private string $display_name;
 
-    private string $addon_namespace;
+	private string $addon_namespace;
 
-    private FilePath $main_file;
-
-    private string $slug;
-
-    /**
-     * @var Version the current add-on version
-     */
-    private Version $version;
-
-    private AddonRoutes $addon_routes;
-
-    private DependencyHandlers $dependency_handlers;
-
-    private Psr4Autoloader $psr4_loader;
+	private FilePath $main_file;
+
+	private string $slug;
+
+	/**
+	 * @var Version the current add-on version
+	 */
+	private Version $version;
+
+	private AddonRoutes $addon_routes;
+
+	private DependencyHandlers $dependency_handlers;
+
+	private Psr4Autoloader $psr4_loader;
 
-    private bool $dependencies_registered = false;
-
-
-    /**
-     * Bootstrap constructor.
-     *
-     * @param AddonRoutes $addon_routes
-     * @param DependencyHandlers $dependency_handlers
-     * @param Psr4Autoloader $psr4_loader
-     * @param int            $api_version
-     */
-    protected function __construct(AddonRoutes $addon_routes, DependencyHandlers $dependency_handlers, Psr4Autoloader $psr4_loader, int $api_version) {
-        $this->addon_routes = LoaderFactory::getShared(AddonRoutes::class);
-        $this->dependency_handlers = LoaderFactory::getShared(DependencyHandlers::class);
-        $this->psr4_loader = LoaderFactory::getShared(Psr4Autoloader::class);
-        $this->setApiVersion($api_version);
-    }
-
-
-    /**
-     * @return void
-     */
-    public function initialize(): void
-    {
-        $this->domain = DomainFactory::create(
-            "$this->addon_namespace\\domain\\Domain",
-            $this->main_file,
-            $this->version
-        );
-    }
-
-
-    /**
-     * @return int[]
-     */
-    private function validApiVersions(): array
-    {
-        return [
-            AddonApiVersion::V1,
-        ];
-    }
-
-
-    /**
-     * @param int $api_version
-     */
-    private function setApiVersion(int $api_version): void
-    {
-        if (! in_array($api_version, $this->validApiVersions())) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Add-on API Version! Please use one of the EventEspresso\core\domain\entities\addon\Bootstrap class constants',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->api_version = $api_version;
-    }
-
-
-    public function setDisplayName(string $display_name): void
-    {
-        $this->display_name = $display_name;
-    }
-
-
-    public function setID(int $id = 0): void
-    {
-        $this->id = $id;
-    }
-
-
-
-    /**
-     * @param string $main_file
-     */
-    public function setMainFile(string $main_file): void
-    {
-        $this->main_file = new FilePath($main_file);
-    }
-
-
-    /**
-     * @param string $min_core_version
-     */
-    public function setMinCoreVersion(string $min_core_version): void
-    {
-        $this->min_core_version = Version::fromString($min_core_version);
-    }
-
-
-    /**
-     * @param string $min_wp_version
-     */
-    public function setMinWpVersion(string $min_wp_version = EE_MIN_WP_VER_REQUIRED): void
-    {
-        $this->min_wp_version = Version::fromString($min_wp_version);
-    }
-
-
-    /**
-     * @param string $name
-     */
-    public function setName(string $name): void
-    {
-        $this->name = $name;
-    }
-
-
-    /**
-     * @param string $namespace
-     */
-    public function setNamespace(string $namespace): void
-    {
-        $this->addon_namespace = $namespace;
-        // register addon namespace immediately so that FQCNs resolve correctly
-        $this->psr4_loader->addNamespace($namespace, dirname($this->main_file) . '/src/');
-    }
-
-
-    /**
-     * @param string $slug
-     */
-    public function setSlug(string $slug): void
-    {
-        $valid_slug = sanitize_key($slug);
-        if ($slug !== $valid_slug) {
-            throw new DomainException(
-                esc_html__(
-                    'Invalid Add-on "slug"! Please ensure that slug only uses lowercase characters and dashes.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->slug = $valid_slug;
-    }
-
-
-    /**
-     * @param string $version
-     */
-    public function setVersion(string $version): void
-    {
-        $this->version = Version::fromString($version);
-    }
-
-
-    /**
-     * @return int
-     */
-    public function apiVersion(): int
-    {
-        return $this->api_version;
-    }
-
-
-    public function displayName(): string
-    {
-        return $this->display_name;
-    }
-
-
-    /**
-     * @return DomainInterface
-     */
-    public function domain(): DomainInterface
-    {
-        return $this->domain;
-    }
-
-
-    public function ID(): int
-    {
-        return $this->id;
-    }
-
-
-
-    /**
-     * @return Version|null
-     */
-    public function minCoreVersion(): ?Version
-    {
-        return $this->min_core_version;
-    }
-
-
-    /**
-     * @return Version|null
-     */
-    public function minWpVersion(): ?Version
-    {
-        return $this->min_wp_version;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function name(): string
-    {
-        return $this->name;
-    }
-
-
-    /**
-     * FQCN for the domain's EE_Addon class
-     *
-     * @return string
-     */
-    public function fqcn(): string
-    {
-        return "$this->addon_namespace\\domain\\$this->name";
-    }
-
-
-    /**
-     * @return string
-     */
-    public function getNamespace(): string
-    {
-        return $this->addon_namespace;
-    }
-
-
-    /**
-     * @return FilePath
-     */
-    public function mainFile(): FilePath
-    {
-        return $this->main_file;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug(): string
-    {
-        return $this->slug;
-    }
-
-
-    /**
-     * @return Version
-     */
-    public function version(): Version
-    {
-        return $this->version;
-    }
-
-
-    /**
-     * @throws Exception
-     */
-    public function addRoute(string $route_fqcn, string $hook_name = 'AHEE__EE_System__core_loaded_and_ready'): void
-    {
-        $this->addon_routes->addRouteFor($route_fqcn, $this->slug());
-        add_action($hook_name, [$this, 'loadRoutes']);
-    }
-
-
-    /**
-     * @throws Exception|Throwable
-     */
-    public function loadRoutes()
-    {
-        $this->addon_routes->loadRoutesFor($this->slug());
-    }
-
-
-    /**
-     * @param string $dependency_handler_fqcn FQCN of a DependencyHandler class
-     * @return void
-     * @since 5.0.30.p
-     */
-    public function addDependencyHandler(string $dependency_handler_fqcn): void
-    {
-        $this->dependency_handlers->addDependencyHandlerFor($dependency_handler_fqcn, $this->slug());
-        if (! $this->dependencies_registered) {
-            add_action('AHEE__EE_System__load_espresso_addons__complete', [$this, 'registerDependencies'], 999);
-            $this->dependencies_registered = true;
-        }
-    }
-
-
-    /**
-     * @return void
-     * @since 5.0.30.p
-     */
-    public function registerDependencies()
-    {
-        $this->dependency_handlers->registerDependenciesFor($this->slug());
-    }
+	private bool $dependencies_registered = false;
+
+
+	/**
+	 * Bootstrap constructor.
+	 *
+	 * @param AddonRoutes $addon_routes
+	 * @param DependencyHandlers $dependency_handlers
+	 * @param Psr4Autoloader $psr4_loader
+	 * @param int            $api_version
+	 */
+	protected function __construct(AddonRoutes $addon_routes, DependencyHandlers $dependency_handlers, Psr4Autoloader $psr4_loader, int $api_version) {
+		$this->addon_routes = LoaderFactory::getShared(AddonRoutes::class);
+		$this->dependency_handlers = LoaderFactory::getShared(DependencyHandlers::class);
+		$this->psr4_loader = LoaderFactory::getShared(Psr4Autoloader::class);
+		$this->setApiVersion($api_version);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function initialize(): void
+	{
+		$this->domain = DomainFactory::create(
+			"$this->addon_namespace\\domain\\Domain",
+			$this->main_file,
+			$this->version
+		);
+	}
+
+
+	/**
+	 * @return int[]
+	 */
+	private function validApiVersions(): array
+	{
+		return [
+			AddonApiVersion::V1,
+		];
+	}
+
+
+	/**
+	 * @param int $api_version
+	 */
+	private function setApiVersion(int $api_version): void
+	{
+		if (! in_array($api_version, $this->validApiVersions())) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Add-on API Version! Please use one of the EventEspresso\core\domain\entities\addon\Bootstrap class constants',
+					'event_espresso'
+				)
+			);
+		}
+		$this->api_version = $api_version;
+	}
+
+
+	public function setDisplayName(string $display_name): void
+	{
+		$this->display_name = $display_name;
+	}
+
+
+	public function setID(int $id = 0): void
+	{
+		$this->id = $id;
+	}
+
+
+
+	/**
+	 * @param string $main_file
+	 */
+	public function setMainFile(string $main_file): void
+	{
+		$this->main_file = new FilePath($main_file);
+	}
+
+
+	/**
+	 * @param string $min_core_version
+	 */
+	public function setMinCoreVersion(string $min_core_version): void
+	{
+		$this->min_core_version = Version::fromString($min_core_version);
+	}
+
+
+	/**
+	 * @param string $min_wp_version
+	 */
+	public function setMinWpVersion(string $min_wp_version = EE_MIN_WP_VER_REQUIRED): void
+	{
+		$this->min_wp_version = Version::fromString($min_wp_version);
+	}
+
+
+	/**
+	 * @param string $name
+	 */
+	public function setName(string $name): void
+	{
+		$this->name = $name;
+	}
+
+
+	/**
+	 * @param string $namespace
+	 */
+	public function setNamespace(string $namespace): void
+	{
+		$this->addon_namespace = $namespace;
+		// register addon namespace immediately so that FQCNs resolve correctly
+		$this->psr4_loader->addNamespace($namespace, dirname($this->main_file) . '/src/');
+	}
+
+
+	/**
+	 * @param string $slug
+	 */
+	public function setSlug(string $slug): void
+	{
+		$valid_slug = sanitize_key($slug);
+		if ($slug !== $valid_slug) {
+			throw new DomainException(
+				esc_html__(
+					'Invalid Add-on "slug"! Please ensure that slug only uses lowercase characters and dashes.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->slug = $valid_slug;
+	}
+
+
+	/**
+	 * @param string $version
+	 */
+	public function setVersion(string $version): void
+	{
+		$this->version = Version::fromString($version);
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function apiVersion(): int
+	{
+		return $this->api_version;
+	}
+
+
+	public function displayName(): string
+	{
+		return $this->display_name;
+	}
+
+
+	/**
+	 * @return DomainInterface
+	 */
+	public function domain(): DomainInterface
+	{
+		return $this->domain;
+	}
+
+
+	public function ID(): int
+	{
+		return $this->id;
+	}
+
+
+
+	/**
+	 * @return Version|null
+	 */
+	public function minCoreVersion(): ?Version
+	{
+		return $this->min_core_version;
+	}
+
+
+	/**
+	 * @return Version|null
+	 */
+	public function minWpVersion(): ?Version
+	{
+		return $this->min_wp_version;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function name(): string
+	{
+		return $this->name;
+	}
+
+
+	/**
+	 * FQCN for the domain's EE_Addon class
+	 *
+	 * @return string
+	 */
+	public function fqcn(): string
+	{
+		return "$this->addon_namespace\\domain\\$this->name";
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function getNamespace(): string
+	{
+		return $this->addon_namespace;
+	}
+
+
+	/**
+	 * @return FilePath
+	 */
+	public function mainFile(): FilePath
+	{
+		return $this->main_file;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug(): string
+	{
+		return $this->slug;
+	}
+
+
+	/**
+	 * @return Version
+	 */
+	public function version(): Version
+	{
+		return $this->version;
+	}
+
+
+	/**
+	 * @throws Exception
+	 */
+	public function addRoute(string $route_fqcn, string $hook_name = 'AHEE__EE_System__core_loaded_and_ready'): void
+	{
+		$this->addon_routes->addRouteFor($route_fqcn, $this->slug());
+		add_action($hook_name, [$this, 'loadRoutes']);
+	}
+
+
+	/**
+	 * @throws Exception|Throwable
+	 */
+	public function loadRoutes()
+	{
+		$this->addon_routes->loadRoutesFor($this->slug());
+	}
+
+
+	/**
+	 * @param string $dependency_handler_fqcn FQCN of a DependencyHandler class
+	 * @return void
+	 * @since 5.0.30.p
+	 */
+	public function addDependencyHandler(string $dependency_handler_fqcn): void
+	{
+		$this->dependency_handlers->addDependencyHandlerFor($dependency_handler_fqcn, $this->slug());
+		if (! $this->dependencies_registered) {
+			add_action('AHEE__EE_System__load_espresso_addons__complete', [$this, 'registerDependencies'], 999);
+			$this->dependencies_registered = true;
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @since 5.0.30.p
+	 */
+	public function registerDependencies()
+	{
+		$this->dependency_handlers->registerDependenciesFor($this->slug());
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -117,7 +117,7 @@ 
      */
     private function setApiVersion(int $api_version): void
     {
-        if (! in_array($api_version, $this->validApiVersions())) {
+        if ( ! in_array($api_version, $this->validApiVersions())) {
             throw new DomainException(
                 esc_html__(
                     'Invalid Add-on API Version! Please use one of the EventEspresso\core\domain\entities\addon\Bootstrap class constants',
@@ -185,7 +185,7 @@ 
     {
         $this->addon_namespace = $namespace;
         // register addon namespace immediately so that FQCNs resolve correctly
-        $this->psr4_loader->addNamespace($namespace, dirname($this->main_file) . '/src/');
+        $this->psr4_loader->addNamespace($namespace, dirname($this->main_file).'/src/');
     }
 
 
@@ -348,7 +348,7 @@ 
     public function addDependencyHandler(string $dependency_handler_fqcn): void
     {
         $this->dependency_handlers->addDependencyHandlerFor($dependency_handler_fqcn, $this->slug());
-        if (! $this->dependencies_registered) {
+        if ( ! $this->dependencies_registered) {
             add_action('AHEE__EE_System__load_espresso_addons__complete', [$this, 'registerDependencies'], 999);
             $this->dependencies_registered = true;
         }

core/services/addon/api/AddonApiFactory.php

Indentation +67 added lines, -67 removed lines

@@ -18,76 +18,76 @@
  */
 class AddonApiFactory
 {
-    public static function addonApiV1(
-        int $ID,
-        string $main_file,
-        string $name,
-        string $display_name,
-        string $namespace,
-        string $min_core_version
-    ): AddonApi {
-        $addon_collection = AddonApiFactory::getAddonCollection();
-        $slug = AddonApiFactory::getSlugFromMainfile($main_file);
-        if ($addon_collection->hasAddon($slug)) {
-            return $addon_collection->getAddon($slug);
-        }
-        $addon = AddonApiFactory::createAddon();
-        $addon->setID($ID);
-        $addon->setSlug($slug);
-        $addon->setName($name);
-        $addon->setDisplayName($display_name);
-        $addon->setMainFile($main_file);
-        $addon->setVersion(AddonApiFactory::getVersionFromMainfile($main_file));
-        $addon->setMinCoreVersion($min_core_version);
-        $addon->setNamespace($namespace);
-        $addon_collection->addAddon($addon);
-        return $addon;
-    }
+	public static function addonApiV1(
+		int $ID,
+		string $main_file,
+		string $name,
+		string $display_name,
+		string $namespace,
+		string $min_core_version
+	): AddonApi {
+		$addon_collection = AddonApiFactory::getAddonCollection();
+		$slug = AddonApiFactory::getSlugFromMainfile($main_file);
+		if ($addon_collection->hasAddon($slug)) {
+			return $addon_collection->getAddon($slug);
+		}
+		$addon = AddonApiFactory::createAddon();
+		$addon->setID($ID);
+		$addon->setSlug($slug);
+		$addon->setName($name);
+		$addon->setDisplayName($display_name);
+		$addon->setMainFile($main_file);
+		$addon->setVersion(AddonApiFactory::getVersionFromMainfile($main_file));
+		$addon->setMinCoreVersion($min_core_version);
+		$addon->setNamespace($namespace);
+		$addon_collection->addAddon($addon);
+		return $addon;
+	}
 
-    private static function createAddon(): AddonApi
-    {
-        return LoaderFactory::getNew(AddonApi::class);
-    }
+	private static function createAddon(): AddonApi
+	{
+		return LoaderFactory::getNew(AddonApi::class);
+	}
 
-    private static function getSlugFromMainfile(string $main_file): string
-    {
-        $plugin_basename = plugin_basename($main_file);
-        return substr($plugin_basename, 0, strpos($plugin_basename, '/'));
-    }
+	private static function getSlugFromMainfile(string $main_file): string
+	{
+		$plugin_basename = plugin_basename($main_file);
+		return substr($plugin_basename, 0, strpos($plugin_basename, '/'));
+	}
 
-    private static function getVersionFromMainfile(string $main_file): string
-    {
-        $version_file = dirname($main_file) . '/.VERSION';
-        if (! is_readable($version_file)) {
-            throw new InvalidFilePathException($version_file);
-        }
-        $file_handle = fopen($version_file, 'r');
-        if ($file_handle === false) {
-            throw new InvalidDataTypeException(
-                '$file_handle',
-                false,
-                esc_html__('file pointer resource', 'event_espresso')
-            );
-        }
-        $version = fgets($file_handle);
-        if ($version === false) {
-            throw new InvalidDataTypeException(
-                '$version',
-                false,
-                esc_html__('add-on version', 'event_espresso')
-            );
-        }
-        if (! fclose($file_handle)) {
-            throw new RuntimeException(
-                esc_html__('Failed to close file handle', 'event_espresso')
-            );
-        }
-        return $version;
-    }
+	private static function getVersionFromMainfile(string $main_file): string
+	{
+		$version_file = dirname($main_file) . '/.VERSION';
+		if (! is_readable($version_file)) {
+			throw new InvalidFilePathException($version_file);
+		}
+		$file_handle = fopen($version_file, 'r');
+		if ($file_handle === false) {
+			throw new InvalidDataTypeException(
+				'$file_handle',
+				false,
+				esc_html__('file pointer resource', 'event_espresso')
+			);
+		}
+		$version = fgets($file_handle);
+		if ($version === false) {
+			throw new InvalidDataTypeException(
+				'$version',
+				false,
+				esc_html__('add-on version', 'event_espresso')
+			);
+		}
+		if (! fclose($file_handle)) {
+			throw new RuntimeException(
+				esc_html__('Failed to close file handle', 'event_espresso')
+			);
+		}
+		return $version;
+	}
 
 
-    public static function getAddonCollection(): AddonCollection
-    {
-        return LoaderFactory::getShared(AddonCollection::class);
-    }
+	public static function getAddonCollection(): AddonCollection
+	{
+		return LoaderFactory::getShared(AddonCollection::class);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -57,8 +57,8 @@ 
 
     private static function getVersionFromMainfile(string $main_file): string
     {
-        $version_file = dirname($main_file) . '/.VERSION';
-        if (! is_readable($version_file)) {
+        $version_file = dirname($main_file).'/.VERSION';
+        if ( ! is_readable($version_file)) {
             throw new InvalidFilePathException($version_file);
         }
         $file_handle = fopen($version_file, 'r');
@@ -77,7 +77,7 @@ 
                 esc_html__('add-on version', 'event_espresso')
             );
         }
-        if (! fclose($file_handle)) {
+        if ( ! fclose($file_handle)) {
             throw new RuntimeException(
                 esc_html__('Failed to close file handle', 'event_espresso')
             );