eventespresso / event-espresso-core

core/domain/entities/routing/handlers/shared/WordPressHeartbeat.php

Indentation +41 added lines, -41 removed lines

@@ -15,49 +15,49 @@
  */
 class WordPressHeartbeat extends Route
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isWordPressHeartbeat();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isWordPressHeartbeat();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat',
-            [
-                'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat',
-            [
-                'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
-                'EE_Environment_Config'            => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat',
+			[
+				'EventEspresso\core\services\loaders\Loader'  => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\Request' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\domain\services\admin\ajax\EventEditorHeartbeat',
+			[
+				'EventEspresso\core\domain\Domain' => EE_Dependency_Map::load_from_cache,
+				'EE_Environment_Config'            => EE_Dependency_Map::load_from_cache,
+			]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		$this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
+		return true;
+	}
 }

core/domain/entities/routing/handlers/shared/RestApiRequests.php

Indentation +57 added lines, -57 removed lines

@@ -16,65 +16,65 @@
  */
 class RestApiRequests extends Route
 {
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isAdmin() || $this->request->isApi() || $this->request->isWordPressApi();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isAdmin() || $this->request->isApi() || $this->request->isWordPressApi();
+	}
 
 
-    /**
-     * @since 5.0.0.p
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\CalculatedModelFields',
-            ['EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory',
-            ['EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-            ['EventEspresso\core\libraries\rest_api\CalculatedModelFields' => EE_Dependency_Map::load_from_cache]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\Datetime',
-            [
-                'EEM_Datetime'     => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\Event',
-            [
-                'EEM_Event'        => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\Registration',
-            ['EEM_Registration' => EE_Dependency_Map::load_from_cache]
-        );
-    }
+	/**
+	 * @since 5.0.0.p
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\CalculatedModelFields',
+			['EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\CalculatedModelFieldsFactory',
+			['EventEspresso\core\services\loaders\Loader' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+			['EventEspresso\core\libraries\rest_api\CalculatedModelFields' => EE_Dependency_Map::load_from_cache]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\Datetime',
+			[
+				'EEM_Datetime'     => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\Event',
+			[
+				'EEM_Event'        => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\Registration',
+			['EEM_Registration' => EE_Dependency_Map::load_from_cache]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   5.0.0.p
-     */
-    protected function requestHandler(): bool
-    {
-        EED_Core_Rest_Api::set_hooks_both();
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   5.0.0.p
+	 */
+	protected function requestHandler(): bool
+	{
+		EED_Core_Rest_Api::set_hooks_both();
+		return true;
+	}
 }

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +92 added lines, -92 removed lines

@@ -22,104 +22,104 @@
  */
 class EspressoTicketSelector extends EspressoShortcode
 {
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
 
 
-    /**
-     * the time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration()
-    {
-        return 0;
-    }
+	/**
+	 * the time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration()
+	{
+		return 0;
+	}
 
 
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array|string $attributes
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract((array) $attributes);
-        $event_id = $event_id ?? 0;
-        $event = EEM_Event::instance()->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
-            return $this->processInvalidEvent($event_id);
-        }
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();
-    }
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array|string $attributes
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract((array) $attributes);
+		$event_id = $event_id ?? 0;
+		$event = EEM_Event::instance()->get_one_by_ID($event_id);
+		if (! $event instanceof EE_Event) {
+			return $this->processInvalidEvent($event_id);
+		}
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();
+	}
 
 
-    /**
-     * @param string $event_id
-     * @return string
-     * @throws Exception
-     * @since 5.0.0.p
-     */
-    private function processInvalidEvent(string $event_id): string
-    {
-        if (WP_DEBUG === true && current_user_can('edit_pages')) {
-            new ExceptionStackTraceDisplay(
-                new InvalidArgumentException(
-                    sprintf(
-                        esc_html__(
-                            'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that its value corresponds to a valid Event ID.',
-                            'event_espresso'
-                        ),
-                        $this->getTag(),
-                        $event_id,
-                        'event_id',
-                        '<br />'
-                    )
-                )
-            );
-            return '';
-        }
-        return sprintf(
-            esc_html__(
-                'An Event with an ID of "%s" could not be found. Please contact the event administrator for assistance.',
-                'event_espresso'
-            ),
-            $event_id
-        );
-    }
+	/**
+	 * @param string $event_id
+	 * @return string
+	 * @throws Exception
+	 * @since 5.0.0.p
+	 */
+	private function processInvalidEvent(string $event_id): string
+	{
+		if (WP_DEBUG === true && current_user_can('edit_pages')) {
+			new ExceptionStackTraceDisplay(
+				new InvalidArgumentException(
+					sprintf(
+						esc_html__(
+							'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that its value corresponds to a valid Event ID.',
+							'event_espresso'
+						),
+						$this->getTag(),
+						$event_id,
+						'event_id',
+						'<br />'
+					)
+				)
+			);
+			return '';
+		}
+		return sprintf(
+			esc_html__(
+				'An Event with an ID of "%s" could not be found. Please contact the event administrator for assistance.',
+				'event_espresso'
+			),
+			$event_id
+		);
+	}
 }

core/services/request/Response.php

Indentation +135 added lines, -135 removed lines

@@ -14,139 +14,139 @@
  */
 class Response implements ResponseInterface, ReservedInstanceInterface
 {
-    protected bool  $deactivate_plugin = false;
-
-    protected array $notice            = [];
-
-    /**
-     * rendered output to be returned to WP
-     */
-    protected array $output             = [];
-
-    protected array $request_headers    = [];
-
-    protected bool  $request_terminated = false;
-
-
-    /**
-     * EE_Response constructor.
-     */
-    public function __construct()
-    {
-        $this->terminateRequest(false);
-    }
-
-
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value)
-    {
-        $this->notice[ $key ] = $value;
-    }
-
-
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key)
-    {
-        return $this->notice[ $key ] ?? null;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getNotices(): array
-    {
-        return $this->notice;
-    }
-
-
-    /**
-     * @param string $string
-     * @param bool   $append
-     */
-    public function addOutput(string $string, bool $append = true)
-    {
-        if ($append) {
-            $this->output[] = $string;
-            return;
-        }
-        array_unshift($this->output, $string);
-    }
-
-
-    /**
-     * @param bool   $as_string
-     * @param string $separator
-     * @return array|string
-     */
-    public function getOutput(bool $as_string = true, string $separator = PHP_EOL)
-    {
-        return $as_string
-            ? implode($separator, $this->output)
-            : $this->output;
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function requestTerminated(): bool
-    {
-        return $this->request_terminated;
-    }
-
-
-    /**
-     * @param bool|int|string|null $request_terminated
-     */
-    public function terminateRequest($request_terminated = true)
-    {
-        $this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated(): bool
-    {
-        return $this->deactivate_plugin;
-    }
-
-
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin()
-    {
-        $this->deactivate_plugin = true;
-    }
-
-
-    /**
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function requestHeaders(): array
-    {
-        return $this->request_headers;
-    }
-
-
-    /**
-     * @param string $request_header
-     * @return void
-     * @since 5.0.0.p
-     */
-    public function setRequestHeader(string $request_header): void
-    {
-        $this->request_headers[] = $request_header;
-    }
+	protected bool  $deactivate_plugin = false;
+
+	protected array $notice            = [];
+
+	/**
+	 * rendered output to be returned to WP
+	 */
+	protected array $output             = [];
+
+	protected array $request_headers    = [];
+
+	protected bool  $request_terminated = false;
+
+
+	/**
+	 * EE_Response constructor.
+	 */
+	public function __construct()
+	{
+		$this->terminateRequest(false);
+	}
+
+
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value)
+	{
+		$this->notice[ $key ] = $value;
+	}
+
+
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key)
+	{
+		return $this->notice[ $key ] ?? null;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getNotices(): array
+	{
+		return $this->notice;
+	}
+
+
+	/**
+	 * @param string $string
+	 * @param bool   $append
+	 */
+	public function addOutput(string $string, bool $append = true)
+	{
+		if ($append) {
+			$this->output[] = $string;
+			return;
+		}
+		array_unshift($this->output, $string);
+	}
+
+
+	/**
+	 * @param bool   $as_string
+	 * @param string $separator
+	 * @return array|string
+	 */
+	public function getOutput(bool $as_string = true, string $separator = PHP_EOL)
+	{
+		return $as_string
+			? implode($separator, $this->output)
+			: $this->output;
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated(): bool
+	{
+		return $this->request_terminated;
+	}
+
+
+	/**
+	 * @param bool|int|string|null $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true)
+	{
+		$this->request_terminated = filter_var($request_terminated, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated(): bool
+	{
+		return $this->deactivate_plugin;
+	}
+
+
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin()
+	{
+		$this->deactivate_plugin = true;
+	}
+
+
+	/**
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function requestHeaders(): array
+	{
+		return $this->request_headers;
+	}
+
+
+	/**
+	 * @param string $request_header
+	 * @return void
+	 * @since 5.0.0.p
+	 */
+	public function setRequestHeader(string $request_header): void
+	{
+		$this->request_headers[] = $request_header;
+	}
 }

core/services/request/RequestInterface.php

Indentation +218 added lines, -218 removed lines

@@ -15,224 +15,224 @@
  */
 interface RequestInterface extends RequestTypeContextCheckerInterface
 {
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type);
 
 
-    /**
-     * @return array
-     */
-    public function getParams();
-
-
-    /**
-     * @return array
-     */
-    public function postParams();
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams();
-
-
-    /**
-     * @return array
-     */
-    public function serverParams();
-
-
-    /**
-     * @param string $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam($key, $default = null);
-
-
-    /**
-     * @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);
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet($key);
-
-
-    /**
-     * @return array
-     */
-    public function filesParams();
-
-
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams();
-
-
-    /**
-     * @param string $key
-     * @param string $value
-     * @param bool   $override_ee
-     * @return void
-     */
-    public function setRequestParam($key, $value, $override_ee = false);
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param string     $key
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key);
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param mixed|null $default
-     * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
-     * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
-     * @param string     $delimiter for CSV type strings that should be returned as an array
-     * @return array|bool|float|int|string
-     */
-    public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
-
-
-    /**
-     * 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 false|int
-     */
-    public function matches($pattern);
-
-
-    /**
-     * remove param
-     *
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false);
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false);
-
-
-    /**
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     * @return void
-     */
-    public function unSetServerParam(string $key, bool $unset_from_global_too = false);
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress();
-
-
-    /**
-     * @param boolean $relativeToWpRoot    whether or not to return the uri relative to WordPress' home URL.
-     * @param boolean $remove_query_params whether or not to return the uri with all query params removed.
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false, $remove_query_params = false);
-
-
-    /**
-     * @return string
-     */
-    public function userAgent();
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
-
-
-    /**
-     * @return bool
-     */
-    public function isBot();
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
-
-
-    /**
-     * 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();
-
-
-    /**
-     * 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);
-
-
-    /**
-     * merges the incoming array of parameters into the existing request parameters
-     *
-     * @param array $request_params
-     * @return mixed
-     * @since   4.10.24.p
-     */
-    public function mergeRequestParams(array $request_params);
+	/**
+	 * @return array
+	 */
+	public function getParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams();
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams();
+
+
+	/**
+	 * @param string $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key, $default = null);
+
+
+	/**
+	 * @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);
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet($key);
+
+
+	/**
+	 * @return array
+	 */
+	public function filesParams();
+
+
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams();
+
+
+	/**
+	 * @param string $key
+	 * @param string $value
+	 * @param bool   $override_ee
+	 * @return void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false);
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getRequestParam($key, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key);
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param mixed|null $default
+	 * @param string     $type      the expected data type for the parameter's value, ie: string, int, bool, etc
+	 * @param bool       $is_array  if true, then parameter value will be treated as an array of $type
+	 * @param string     $delimiter for CSV type strings that should be returned as an array
+	 * @return array|bool|float|int|string
+	 */
+	public function getMatch($pattern, $default = null, $type = DataType::STRING, $is_array = false, $delimiter = '');
+
+
+	/**
+	 * 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 false|int
+	 */
+	public function matches($pattern);
+
+
+	/**
+	 * remove param
+	 *
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false);
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false);
+
+
+	/**
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 * @return void
+	 */
+	public function unSetServerParam(string $key, bool $unset_from_global_too = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress();
+
+
+	/**
+	 * @param boolean $relativeToWpRoot    whether or not to return the uri relative to WordPress' home URL.
+	 * @param boolean $remove_query_params whether or not to return the uri with all query params removed.
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false, $remove_query_params = false);
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent();
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot();
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
+
+
+	/**
+	 * 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();
+
+
+	/**
+	 * 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);
+
+
+	/**
+	 * merges the incoming array of parameters into the existing request parameters
+	 *
+	 * @param array $request_params
+	 * @return mixed
+	 * @since   4.10.24.p
+	 */
+	public function mergeRequestParams(array $request_params);
 }

core/services/request/ResponseInterface.php

Indentation +53 added lines, -53 removed lines

@@ -11,77 +11,77 @@
  */
 interface ResponseInterface
 {
-    /**
-     * @param $key
-     * @param $value
-     * @return    void
-     */
-    public function setNotice($key, $value);
+	/**
+	 * @param $key
+	 * @param $value
+	 * @return    void
+	 */
+	public function setNotice($key, $value);
 
 
-    /**
-     * @param $key
-     * @return    mixed
-     */
-    public function getNotice($key);
+	/**
+	 * @param $key
+	 * @return    mixed
+	 */
+	public function getNotice($key);
 
 
-    /**
-     * @return    array
-     */
-    public function getNotices(): array;
+	/**
+	 * @return    array
+	 */
+	public function getNotices(): array;
 
 
-    /**
-     * @param string $string
-     * @param bool   $append
-     */
-    public function addOutput(string $string, bool $append = true);
+	/**
+	 * @param string $string
+	 * @param bool   $append
+	 */
+	public function addOutput(string $string, bool $append = true);
 
 
-    /**
-     * @param bool   $as_string
-     * @param string $separator
-     * @return array|string
-     */
-    public function getOutput(bool $as_string = true, string $separator = PHP_EOL);
+	/**
+	 * @param bool   $as_string
+	 * @param string $separator
+	 * @return array|string
+	 */
+	public function getOutput(bool $as_string = true, string $separator = PHP_EOL);
 
 
-    /**
-     * @return boolean
-     */
-    public function requestTerminated(): bool;
+	/**
+	 * @return boolean
+	 */
+	public function requestTerminated(): bool;
 
 
-    /**
-     * @param bool|int|string|null $request_terminated
-     */
-    public function terminateRequest($request_terminated = true);
+	/**
+	 * @param bool|int|string|null $request_terminated
+	 */
+	public function terminateRequest($request_terminated = true);
 
 
-    /**
-     * @return boolean
-     */
-    public function pluginDeactivated(): bool;
+	/**
+	 * @return boolean
+	 */
+	public function pluginDeactivated(): bool;
 
 
-    /**
-     * sets $deactivate_plugin to true
-     */
-    public function deactivatePlugin();
+	/**
+	 * sets $deactivate_plugin to true
+	 */
+	public function deactivatePlugin();
 
 
-    /**
-     * @return array
-     * @since 5.0.0.p
-     */
-    public function requestHeaders(): array;
+	/**
+	 * @return array
+	 * @since 5.0.0.p
+	 */
+	public function requestHeaders(): array;
 
 
-    /**
-     * @param string $request_header
-     * @return void
-     * @since 5.0.0.p
-     */
-    public function setRequestHeader(string $request_header): void;
+	/**
+	 * @param string $request_header
+	 * @return void
+	 * @since 5.0.0.p
+	 */
+	public function setRequestHeader(string $request_header): void;
 }

core/services/request/Request.php

Indentation +549 added lines, -549 removed lines

@@ -16,553 +16,553 @@
  */
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array
-     */
-    protected $cookies;
-
-    /**
-     * $_FILES parameters
-     *
-     * @var array
-     */
-    protected $files;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool
-     */
-    protected $is_bot;
-
-    /**
-     * @var RequestParams
-     */
-    protected $request_params;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    protected $request_type;
-
-    /**
-     * @var ServerParams
-     */
-    protected $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 or not 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
+	 */
+	protected $cookies;
+
+	/**
+	 * $_FILES parameters
+	 *
+	 * @var array
+	 */
+	protected $files;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool
+	 */
+	protected $is_bot;
+
+	/**
+	 * @var RequestParams
+	 */
+	protected $request_params;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	protected $request_type;
+
+	/**
+	 * @var ServerParams
+	 */
+	protected $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 or not 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/json/JsonConfig.php

Indentation +187 added lines, -187 removed lines

@@ -16,191 +16,191 @@
  */
 abstract class JsonConfig
 {
-    /**
-     * @var boolean $has_changes
-     */
-    private $has_changes = false;
-
-    /**
-     * @var string $option_name
-     */
-    private $option_name;
-
-
-    /**
-     * SettingsConfig constructor.
-     *
-     * @param array $defaults
-     */
-    public function __construct(array $defaults)
-    {
-        $this->setOptionName();
-        $this->load($defaults);
-        $this->clearChanges();
-    }
-
-
-    /**
-     * @return array
-     */
-    abstract protected function getProperties();
-
-
-    /**
-     * converts property name to:
-     *      camelCase for getters ex: show_expired => showExpired
-     *      PascalCase for setters ex: show_expired => ShowExpired
-     *
-     * @param string $string
-     * @param false  $camelCase
-     * @return string|string[]
-     * @since   5.0.0.p
-     */
-    private function convertCase($string, $camelCase = false)
-    {
-        $string = str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
-        if ($camelCase) {
-            $string = lcfirst($string);
-        }
-        return $string;
-    }
-
-
-    /**
-     * @param string $property
-     * @param bool   $getter
-     * @return string
-     */
-    private function createGetterSetter($property, $getter = true)
-    {
-        $setterOrGetter = $this->convertCase($property, $getter);
-        // if not a getter, prepend with "set". ex: Show_expired => setShowExpired
-        $setterOrGetter = ! $getter ? 'set' . $setterOrGetter : $setterOrGetter;
-        return $this->isValidMethod($setterOrGetter) ? $setterOrGetter : '';
-    }
-
-
-    /**
-     * @param string $method
-     * @return bool
-     * @throws DomainException
-     */
-    private function isValidMethod($method)
-    {
-        if (method_exists($this, $method)) {
-            return true;
-        }
-        throw new DomainException(
-            sprintf(
-                esc_html__('Missing %1$s method on JsonConfig class %2$s.', 'event_espresso'),
-                $method,
-                get_class($this)
-            )
-        );
-    }
-
-
-    /**
-     * converts class name to option name by changing backslashes to dashes
-     */
-    private function setOptionName()
-    {
-        $this->option_name = str_replace(['EventEspresso', '\\'], ['ee', '-'], get_class($this));
-    }
-
-
-    /**
-     * retrieves WP option for class, decodes the data, and resigns values to properties
-     *
-     * @param array $defaults
-     */
-    protected function load(array $defaults)
-    {
-        $config = get_option($this->option_name, '{}');
-        $config = (array) json_decode($config) + $defaults;
-        foreach ($this->getProperties() as $property => $value) {
-            if ($property === 'option_name') {
-                continue;
-            }
-            // convert to PascalCase and prepend with "set". ex: show_expired => setShowExpired
-            $setter = $this->createGetterSetter($property, false);
-            $value  = array_key_exists($property, $config) ? $config[ $property ] : null;
-            $this->{$setter}($value);
-        }
-    }
-
-
-    /**
-     * updates property value and marks changes if property value has changed
-     *
-     * @param string $property
-     * @param mixed  $value
-     */
-    protected function setProperty($property, $value)
-    {
-        $this->markChanges($this->{$property} === $value);
-        $this->{$property} = $value;
-    }
-
-
-    /**
-     * will only toggle has_changes to true otherwise keeps existing value (ie: will never toggle to false)
-     * why? this allows this method to be fed with the result of a conditional
-     * that compares an incoming value in a setter with it's previously set value.
-     * ie: if $x = 1 and you call setX(1) then the value has not really changed.
-     *
-     * @param bool $changes
-     * @since   5.0.0.p
-     */
-    protected function markChanges($changes = true)
-    {
-        $this->has_changes = filter_var($changes, FILTER_VALIDATE_BOOLEAN) ? true : $this->has_changes;
-    }
-
-
-    /**
-     * resets $has_changes flag to false but does NOT actually reset any data
-     */
-    public function clearChanges()
-    {
-        $this->has_changes = false;
-    }
-
-
-    /**
-     * flag for marking that changes have been made to property data
-     *
-     * @return bool
-     */
-    public function hasChanges()
-    {
-        return $this->has_changes;
-    }
-
-
-    /**
-     * encodes all property data to JSON and saves it to a WP option
-     */
-    public function update()
-    {
-        $config_exists = get_option($this->option_name);
-        if ($config_exists && ! $this->has_changes) {
-            return;
-        }
-        $config = [];
-        foreach ($this->getProperties() as $property => $value) {
-            if ($property === 'option_name') {
-                continue;
-            }
-            $getter = $this->createGetterSetter($property);
-            $config[ $property ] = $this->{$getter}();
-        }
-        $config = wp_json_encode($config);
-        if ($config_exists) {
-            update_option($this->option_name, $config);
-        } else {
-            add_option($this->option_name, $config, '', 'no');
-        }
-        $this->clearChanges();
-    }
+	/**
+	 * @var boolean $has_changes
+	 */
+	private $has_changes = false;
+
+	/**
+	 * @var string $option_name
+	 */
+	private $option_name;
+
+
+	/**
+	 * SettingsConfig constructor.
+	 *
+	 * @param array $defaults
+	 */
+	public function __construct(array $defaults)
+	{
+		$this->setOptionName();
+		$this->load($defaults);
+		$this->clearChanges();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	abstract protected function getProperties();
+
+
+	/**
+	 * converts property name to:
+	 *      camelCase for getters ex: show_expired => showExpired
+	 *      PascalCase for setters ex: show_expired => ShowExpired
+	 *
+	 * @param string $string
+	 * @param false  $camelCase
+	 * @return string|string[]
+	 * @since   5.0.0.p
+	 */
+	private function convertCase($string, $camelCase = false)
+	{
+		$string = str_replace(' ', '', ucwords(str_replace('_', ' ', $string)));
+		if ($camelCase) {
+			$string = lcfirst($string);
+		}
+		return $string;
+	}
+
+
+	/**
+	 * @param string $property
+	 * @param bool   $getter
+	 * @return string
+	 */
+	private function createGetterSetter($property, $getter = true)
+	{
+		$setterOrGetter = $this->convertCase($property, $getter);
+		// if not a getter, prepend with "set". ex: Show_expired => setShowExpired
+		$setterOrGetter = ! $getter ? 'set' . $setterOrGetter : $setterOrGetter;
+		return $this->isValidMethod($setterOrGetter) ? $setterOrGetter : '';
+	}
+
+
+	/**
+	 * @param string $method
+	 * @return bool
+	 * @throws DomainException
+	 */
+	private function isValidMethod($method)
+	{
+		if (method_exists($this, $method)) {
+			return true;
+		}
+		throw new DomainException(
+			sprintf(
+				esc_html__('Missing %1$s method on JsonConfig class %2$s.', 'event_espresso'),
+				$method,
+				get_class($this)
+			)
+		);
+	}
+
+
+	/**
+	 * converts class name to option name by changing backslashes to dashes
+	 */
+	private function setOptionName()
+	{
+		$this->option_name = str_replace(['EventEspresso', '\\'], ['ee', '-'], get_class($this));
+	}
+
+
+	/**
+	 * retrieves WP option for class, decodes the data, and resigns values to properties
+	 *
+	 * @param array $defaults
+	 */
+	protected function load(array $defaults)
+	{
+		$config = get_option($this->option_name, '{}');
+		$config = (array) json_decode($config) + $defaults;
+		foreach ($this->getProperties() as $property => $value) {
+			if ($property === 'option_name') {
+				continue;
+			}
+			// convert to PascalCase and prepend with "set". ex: show_expired => setShowExpired
+			$setter = $this->createGetterSetter($property, false);
+			$value  = array_key_exists($property, $config) ? $config[ $property ] : null;
+			$this->{$setter}($value);
+		}
+	}
+
+
+	/**
+	 * updates property value and marks changes if property value has changed
+	 *
+	 * @param string $property
+	 * @param mixed  $value
+	 */
+	protected function setProperty($property, $value)
+	{
+		$this->markChanges($this->{$property} === $value);
+		$this->{$property} = $value;
+	}
+
+
+	/**
+	 * will only toggle has_changes to true otherwise keeps existing value (ie: will never toggle to false)
+	 * why? this allows this method to be fed with the result of a conditional
+	 * that compares an incoming value in a setter with it's previously set value.
+	 * ie: if $x = 1 and you call setX(1) then the value has not really changed.
+	 *
+	 * @param bool $changes
+	 * @since   5.0.0.p
+	 */
+	protected function markChanges($changes = true)
+	{
+		$this->has_changes = filter_var($changes, FILTER_VALIDATE_BOOLEAN) ? true : $this->has_changes;
+	}
+
+
+	/**
+	 * resets $has_changes flag to false but does NOT actually reset any data
+	 */
+	public function clearChanges()
+	{
+		$this->has_changes = false;
+	}
+
+
+	/**
+	 * flag for marking that changes have been made to property data
+	 *
+	 * @return bool
+	 */
+	public function hasChanges()
+	{
+		return $this->has_changes;
+	}
+
+
+	/**
+	 * encodes all property data to JSON and saves it to a WP option
+	 */
+	public function update()
+	{
+		$config_exists = get_option($this->option_name);
+		if ($config_exists && ! $this->has_changes) {
+			return;
+		}
+		$config = [];
+		foreach ($this->getProperties() as $property => $value) {
+			if ($property === 'option_name') {
+				continue;
+			}
+			$getter = $this->createGetterSetter($property);
+			$config[ $property ] = $this->{$getter}();
+		}
+		$config = wp_json_encode($config);
+		if ($config_exists) {
+			update_option($this->option_name, $config);
+		} else {
+			add_option($this->option_name, $config, '', 'no');
+		}
+		$this->clearChanges();
+	}
 }

core/services/json/JsonDataNodeInterface.php

Indentation +45 added lines, -45 removed lines

@@ -18,61 +18,61 @@
  */
 interface JsonDataNodeInterface extends JsonSerializable
 {
-    /**
-     * @param JsonDataNode $data_node
-     * @throws DomainException
-     */
-    public function addDataNode(JsonDataNode $data_node);
+	/**
+	 * @param JsonDataNode $data_node
+	 * @throws DomainException
+	 */
+	public function addDataNode(JsonDataNode $data_node);
 
 
-    /**
-     * the actual data in key value array format
-     *
-     * @return array
-     */
-    public function data();
+	/**
+	 * the actual data in key value array format
+	 *
+	 * @return array
+	 */
+	public function data();
 
 
-    /**
-     * specifies the domain (use case) that this route defines
-     * ! IMPORTANT !
-     * only one domain can be set pre request
-     *
-     * @return string
-     */
-    public function domain();
+	/**
+	 * specifies the domain (use case) that this route defines
+	 * ! IMPORTANT !
+	 * only one domain can be set pre request
+	 *
+	 * @return string
+	 */
+	public function domain();
 
 
-    /**
-     * !!! IMPORTANT !!!
-     * JsonDataNode::setInitialized(true) needs to be called once initialization is complete
-     * else you're a bad person and bad things will happen to you !!!
-     *
-     * @since 5.0.0.p
-     */
-    public function initialize();
+	/**
+	 * !!! IMPORTANT !!!
+	 * JsonDataNode::setInitialized(true) needs to be called once initialization is complete
+	 * else you're a bad person and bad things will happen to you !!!
+	 *
+	 * @since 5.0.0.p
+	 */
+	public function initialize();
 
 
-    /**
-     * true if the data node has been initialized,
-     * which entails retrieving the required data and adding it to the data node data array
-     *
-     * @return bool
-     */
-    public function isInitialized();
+	/**
+	 * true if the data node has been initialized,
+	 * which entails retrieving the required data and adding it to the data node data array
+	 *
+	 * @return bool
+	 */
+	public function isInitialized();
 
 
-    /**
-     * true if the data node has NOT been initialized
-     *
-     * @return bool
-     */
-    public function isNotInitialized();
+	/**
+	 * true if the data node has NOT been initialized
+	 *
+	 * @return bool
+	 */
+	public function isNotInitialized();
 
 
-    /**
-     * @return string
-     * @since 5.0.0.p
-     */
-    public function nodeName();
+	/**
+	 * @return string
+	 * @since 5.0.0.p
+	 */
+	public function nodeName();
 }