eventespresso / event-espresso-core

core/services/shortcodes/EspressoShortcode.php

Indentation +219 added lines, -219 removed lines

@@ -20,223 +20,223 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array) $attributes)
-        );
-    }
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if ($shortcode->initialized() === false) {
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof EE_Event) {
-            return $event->ID();
-        }
-        global $post;
-        if ($post instanceof WP_Post) {
-            return $post->ID;
-        }
-        return 0;
-    }
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[ $key ])) {
-                $callback = $custom_sanitization[ $key ];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[ $key ] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[ $key ] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null:
-                case is_int($value):
-                case is_float($value):
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
-                    $attributes[ $key ] = $value;
-                    break;
-                case is_string($value):
-                    $attributes[ $key ] = sanitize_text_field($value);
-                    break;
-                case is_array($value):
-                    $attributes[ $key ] = $this->sanitizeAttributes($value);
-                    break;
-                default:
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
-
-
-    /**
-     * Returns whether or not this shortcode has been initialized
-     *
-     * @return boolean
-     */
-    public function initialized()
-    {
-        return $this->initialized;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array) $attributes)
+		);
+	}
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if ($shortcode->initialized() === false) {
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof EE_Event) {
+			return $event->ID();
+		}
+		global $post;
+		if ($post instanceof WP_Post) {
+			return $post->ID;
+		}
+		return 0;
+	}
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[ $key ])) {
+				$callback = $custom_sanitization[ $key ];
+				if ($callback === 'skip_sanitization') {
+					$attributes[ $key ] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[ $key ] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null:
+				case is_int($value):
+				case is_float($value):
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true):
+					$attributes[ $key ] = $value;
+					break;
+				case is_string($value):
+					$attributes[ $key ] = sanitize_text_field($value);
+					break;
+				case is_array($value):
+					$attributes[ $key ] = $this->sanitizeAttributes($value);
+					break;
+				default:
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[ $key ] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
+
+
+	/**
+	 * Returns whether or not this shortcode has been initialized
+	 *
+	 * @return boolean
+	 */
+	public function initialized()
+	{
+		return $this->initialized;
+	}
 }

core/services/request/ServerParams.php

Indentation +179 added lines, -179 removed lines

@@ -7,183 +7,183 @@
 class ServerParams
 {
 
-    /**
-     * IP address for request
-     *
-     * @var string
-     */
-    protected $ip_address;
-
-
-    /**
-     * @var ServerSanitizer
-     */
-    protected $sanitizer;
-
-    /**
-     * sanitized $_SERVER parameters
-     *
-     * @var array
-     */
-    protected $server;
-
-    /**
-     * @var string
-     */
-    protected $request_uri;
-
-    /**
-     * @var string
-     */
-    protected $user_agent;
-
-
-    /**
-     * ServerParams constructor.
-     *
-     * @param ServerSanitizer $sanitizer
-     * @param array           $server
-     */
-    public function __construct(ServerSanitizer $sanitizer, array $server = [])
-    {
-        $this->sanitizer  = $sanitizer;
-        $this->server     = $this->cleanServerParams($server);
-        $this->ip_address = $this->setVisitorIp();
-    }
-
-
-    /**
-     * @return array
-     */
-    private function cleanServerParams(array $server)
-    {
-        $cleaned = [];
-        $server  = ! empty($server) ? $server : $_SERVER;
-        foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
-            // \EEH_Debug_Tools::printr($cleaned[ $key ], $key, __FILE__, __LINE__);
-        }
-        return $cleaned;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getAllServerParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * @param string $key
-     * @return array|int|float|string
-     */
-    public function getServerParam($key)
-    {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : null;
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $this->server[ $key ] = $this->sanitizer->clean($key, $value);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function serverParamIsSet($key)
-    {
-        return isset($this->server[ $key ]);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function setVisitorIp()
-    {
-        $visitor_ip  = '0.0.0.0';
-        $server_keys = [
-            'HTTP_CLIENT_IP',
-            'HTTP_FORWARDED',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_FORWARDED_FOR',
-            'REMOTE_ADDR',
-        ];
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * 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/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        if ($relativeToWpRoot) {
-            $home_path = untrailingslashit(parse_url(home_url(), PHP_URL_PATH));
-            return str_replace($home_path, '', $this->server['REQUEST_URI']);
-        }
-        return $this->server['REQUEST_URI'];
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        if (empty($this->user_agent)) {
-            $this->setUserAgent();
-        }
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        $this->user_agent = $user_agent === '' || ! is_string($user_agent)
-            ? $this->getServerParam('HTTP_USER_AGENT')
-            : esc_attr($user_agent);
-    }
+	/**
+	 * IP address for request
+	 *
+	 * @var string
+	 */
+	protected $ip_address;
+
+
+	/**
+	 * @var ServerSanitizer
+	 */
+	protected $sanitizer;
+
+	/**
+	 * sanitized $_SERVER parameters
+	 *
+	 * @var array
+	 */
+	protected $server;
+
+	/**
+	 * @var string
+	 */
+	protected $request_uri;
+
+	/**
+	 * @var string
+	 */
+	protected $user_agent;
+
+
+	/**
+	 * ServerParams constructor.
+	 *
+	 * @param ServerSanitizer $sanitizer
+	 * @param array           $server
+	 */
+	public function __construct(ServerSanitizer $sanitizer, array $server = [])
+	{
+		$this->sanitizer  = $sanitizer;
+		$this->server     = $this->cleanServerParams($server);
+		$this->ip_address = $this->setVisitorIp();
+	}
+
+
+	/**
+	 * @return array
+	 */
+	private function cleanServerParams(array $server)
+	{
+		$cleaned = [];
+		$server  = ! empty($server) ? $server : $_SERVER;
+		foreach ($server as $key => $value) {
+			$cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+			// \EEH_Debug_Tools::printr($cleaned[ $key ], $key, __FILE__, __LINE__);
+		}
+		return $cleaned;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getAllServerParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key)
+	{
+		return $this->serverParamIsSet($key) ? $this->server[ $key ] : null;
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$this->server[ $key ] = $this->sanitizer->clean($key, $value);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function serverParamIsSet($key)
+	{
+		return isset($this->server[ $key ]);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function setVisitorIp()
+	{
+		$visitor_ip  = '0.0.0.0';
+		$server_keys = [
+			'HTTP_CLIENT_IP',
+			'HTTP_FORWARDED',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_FORWARDED_FOR',
+			'REMOTE_ADDR',
+		];
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * 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/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		if ($relativeToWpRoot) {
+			$home_path = untrailingslashit(parse_url(home_url(), PHP_URL_PATH));
+			return str_replace($home_path, '', $this->server['REQUEST_URI']);
+		}
+		return $this->server['REQUEST_URI'];
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		if (empty($this->user_agent)) {
+			$this->setUserAgent();
+		}
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		$this->user_agent = $user_agent === '' || ! is_string($user_agent)
+			? $this->getServerParam('HTTP_USER_AGENT')
+			: esc_attr($user_agent);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -60,7 +60,7 @@ 
         $cleaned = [];
         $server  = ! empty($server) ? $server : $_SERVER;
         foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+            $cleaned[$key] = $this->sanitizer->clean($key, $value);
             // \EEH_Debug_Tools::printr($cleaned[ $key ], $key, __FILE__, __LINE__);
         }
         return $cleaned;
@@ -82,7 +82,7 @@ 
      */
     public function getServerParam($key)
     {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : null;
+        return $this->serverParamIsSet($key) ? $this->server[$key] : null;
     }
 
 
@@ -93,7 +93,7 @@ 
      */
     public function setServerParam($key, $value)
     {
-        $this->server[ $key ] = $this->sanitizer->clean($key, $value);
+        $this->server[$key] = $this->sanitizer->clean($key, $value);
     }
 
 
@@ -102,7 +102,7 @@ 
      */
     public function serverParamIsSet($key)
     {
-        return isset($this->server[ $key ]);
+        return isset($this->server[$key]);
     }
 
 
@@ -135,8 +135,8 @@ 
             'REMOTE_ADDR',
         ];
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+            if (isset($this->server[$key])) {
+                foreach (array_map('trim', explode(',', $this->server[$key])) as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;
                     }

core/services/request/files/FilesDataHandler.php

Indentation +251 added lines, -251 removed lines

@@ -40,279 +40,279 @@
  */
 class FilesDataHandler
 {
-    /**
-     * @var Request
-     */
-    protected $request;
+	/**
+	 * @var Request
+	 */
+	protected $request;
 
-    /**
-     * @var CollectionInterface | FileSubmissionInterface[]
-     */
-    protected $file_objects;
+	/**
+	 * @var CollectionInterface | FileSubmissionInterface[]
+	 */
+	protected $file_objects;
 
-    /**
-     * @var bool
-     */
-    protected $initialized = false;
+	/**
+	 * @var bool
+	 */
+	protected $initialized = false;
 
 
-    /**
-     * FilesDataHandler constructor.
-     *
-     * @param Request $request
-     */
-    public function __construct(Request $request)
-    {
-        $this->request = $request;
-    }
+	/**
+	 * FilesDataHandler constructor.
+	 *
+	 * @param Request $request
+	 */
+	public function __construct(Request $request)
+	{
+		$this->request = $request;
+	}
 
 
-    /**
-     * @return CollectionInterface | FileSubmissionInterface[]
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @since 4.9.80.p
-     */
-    protected function getFileObjects()
-    {
-        $this->initialize();
-        return $this->file_objects;
-    }
+	/**
+	 * @return CollectionInterface | FileSubmissionInterface[]
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.80.p
+	 */
+	protected function getFileObjects()
+	{
+		$this->initialize();
+		return $this->file_objects;
+	}
 
 
-    /**
-     * Sets up the file objects from the request's $_FILES data.
-     *
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @since 4.9.80.p
-     */
-    protected function initialize()
-    {
-        if ($this->initialized) {
-            return;
-        }
-        $this->file_objects = new Collection(
-        // collection interface
-            'EventEspresso\core\services\request\files\FileSubmissionInterface',
-            // collection name
-            'submitted_files'
-        );
-        $files_raw_data     = $this->request->filesParams();
-        if (empty($files_raw_data)) {
-            return;
-        }
-        if ($this->isStrangeFilesArray($files_raw_data)) {
-            $data = $this->fixFilesDataArray($files_raw_data);
-        } else {
-            $data = $files_raw_data;
-        }
-        $this->createFileObjects($data);
-        $this->initialized = true;
-    }
+	/**
+	 * Sets up the file objects from the request's $_FILES data.
+	 *
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @since 4.9.80.p
+	 */
+	protected function initialize()
+	{
+		if ($this->initialized) {
+			return;
+		}
+		$this->file_objects = new Collection(
+		// collection interface
+			'EventEspresso\core\services\request\files\FileSubmissionInterface',
+			// collection name
+			'submitted_files'
+		);
+		$files_raw_data     = $this->request->filesParams();
+		if (empty($files_raw_data)) {
+			return;
+		}
+		if ($this->isStrangeFilesArray($files_raw_data)) {
+			$data = $this->fixFilesDataArray($files_raw_data);
+		} else {
+			$data = $files_raw_data;
+		}
+		$this->createFileObjects($data);
+		$this->initialized = true;
+	}
 
 
-    /**
-     * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
-     *
-     * @param $files_data
-     * @return bool
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    protected function isStrangeFilesArray($files_data)
-    {
-        if (! is_array($files_data)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $files_data
-                )
-            );
-        }
-        $first_value = reset($files_data);
-        if (! is_array($first_value)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $first_value
-                )
-            );
-        }
-        $first_sub_array_item = reset($first_value);
-        if (is_array($first_sub_array_item)) {
-            // not just a 2d array
-            return true;
-        }
-        // yep, just 2d array
-        return false;
-    }
+	/**
+	 * Detects if $_FILES is a weird multi-dimensional array that needs fixing or not.
+	 *
+	 * @param $files_data
+	 * @return bool
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	protected function isStrangeFilesArray($files_data)
+	{
+		if (! is_array($files_data)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $files_data
+				)
+			);
+		}
+		$first_value = reset($files_data);
+		if (! is_array($first_value)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $_FILES data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $first_value
+				)
+			);
+		}
+		$first_sub_array_item = reset($first_value);
+		if (is_array($first_sub_array_item)) {
+			// not just a 2d array
+			return true;
+		}
+		// yep, just 2d array
+		return false;
+	}
 
 
-    /**
-     * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
-     * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
-     * "name", "size", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
-     * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
-     *
-     * @param $files_data
-     * @return array
-     * @since 4.9.80.p
-     */
-    protected function fixFilesDataArray($files_data)
-    {
-        $sane_files_array = [];
-        foreach ($files_data as $top_level_name => $top_level_children) {
-            $sub_array                           = [];
-            $sane_files_array[ $top_level_name ] = [];
-            foreach ($top_level_children as $file_data_part => $second_level_children) {
-                foreach ($second_level_children as $next_level_name => $sub_values) {
-                    $sub_array[ $next_level_name ] = $this->organizeFilesData($sub_values, $file_data_part);
-                }
-                $sane_files_array[ $top_level_name ] = array_replace_recursive(
-                    $sub_array,
-                    $sane_files_array[ $top_level_name ]
-                );
-            }
-        }
-        return $sane_files_array;
-    }
+	/**
+	 * Takes into account that $_FILES does a weird thing when you have hierarchical form names (eg `<input type="file"
+	 * name="my[hierarchical][form]">`): it leaves the top-level form part alone, but replaces the SECOND part with
+	 * "name", "size", "tmp_name", etc. So that file's data is located at "my[name][hierarchical][form]",
+	 * "my[size][hierarchical][form]", "my[tmp_name][hierarchical][form]", etc. It's really weird.
+	 *
+	 * @param $files_data
+	 * @return array
+	 * @since 4.9.80.p
+	 */
+	protected function fixFilesDataArray($files_data)
+	{
+		$sane_files_array = [];
+		foreach ($files_data as $top_level_name => $top_level_children) {
+			$sub_array                           = [];
+			$sane_files_array[ $top_level_name ] = [];
+			foreach ($top_level_children as $file_data_part => $second_level_children) {
+				foreach ($second_level_children as $next_level_name => $sub_values) {
+					$sub_array[ $next_level_name ] = $this->organizeFilesData($sub_values, $file_data_part);
+				}
+				$sane_files_array[ $top_level_name ] = array_replace_recursive(
+					$sub_array,
+					$sane_files_array[ $top_level_name ]
+				);
+			}
+		}
+		return $sane_files_array;
+	}
 
 
-    /**
-     * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
-     *
-     * @param $data array|string
-     * @param $type 'name', 'tmp_name', 'size', or 'error'
-     * @return array
-     * @since 4.9.80.p
-     */
-    protected function organizeFilesData($data, $type)
-    {
-        if (! is_array($data)) {
-            return [
-                $type => $data,
-            ];
-        }
-        $organized_data = [];
-        foreach ($data as $input_name_part => $sub_inputs_or_value) {
-            if (is_array($sub_inputs_or_value)) {
-                $organized_data[ $input_name_part ] = $this->organizeFilesData($sub_inputs_or_value, $type);
-            } else {
-                $organized_data[ $input_name_part ][ $type ] = $sub_inputs_or_value;
-            }
-        }
-        return $organized_data;
-    }
+	/**
+	 * Recursively explores the array until it finds a leaf node, and tacks `$type` as a final index in front of it.
+	 *
+	 * @param $data array|string
+	 * @param $type 'name', 'tmp_name', 'size', or 'error'
+	 * @return array
+	 * @since 4.9.80.p
+	 */
+	protected function organizeFilesData($data, $type)
+	{
+		if (! is_array($data)) {
+			return [
+				$type => $data,
+			];
+		}
+		$organized_data = [];
+		foreach ($data as $input_name_part => $sub_inputs_or_value) {
+			if (is_array($sub_inputs_or_value)) {
+				$organized_data[ $input_name_part ] = $this->organizeFilesData($sub_inputs_or_value, $type);
+			} else {
+				$organized_data[ $input_name_part ][ $type ] = $sub_inputs_or_value;
+			}
+		}
+		return $organized_data;
+	}
 
 
-    /**
-     * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
-     * to be in post data, with all the file's data located side-by-side in an array) and creates a
-     * multi-dimensional array of FileSubmissionInterface objects. Stores it in `$this->file_objects`.
-     *
-     * @param array $organized_files   $_FILES but organized like $_POST
-     * @param array $name_parts_so_far for multidimensional HTML form names,
-     * @throws UnexpectedValueException
-     * @throws InvalidArgumentException
-     * @since 4.9.80.p
-     */
-    protected function createFileObjects($organized_files, $name_parts_so_far = [])
-    {
-        if (! is_array($organized_files)) {
-            throw new UnexpectedValueException(
-                sprintf(
-                    esc_html__(
-                        'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
-                        'event_espresso'
-                    ),
-                    (string) $organized_files
-                )
-            );
-        }
-        foreach ($organized_files as $key => $value) {
-            $this_input_name_parts = $name_parts_so_far;
-            array_push(
-                $this_input_name_parts,
-                $key
-            );
-            if (isset($value['name'], $value['tmp_name'], $value['size'])) {
-                $html_name = $this->inputNameFromParts($this_input_name_parts);
-                $this->file_objects->add(
-                    new FileSubmission(
-                        $value['name'],
-                        $value['tmp_name'],
-                        $value['size'],
-                        $value['error']
-                    ),
-                    $html_name
-                );
-            } else {
-                $this->createFileObjects($value, $this_input_name_parts);
-            }
-        }
-    }
+	/**
+	 * Takes the organized $_FILES array (where all file info is located at the same spot as you'd expect an input
+	 * to be in post data, with all the file's data located side-by-side in an array) and creates a
+	 * multi-dimensional array of FileSubmissionInterface objects. Stores it in `$this->file_objects`.
+	 *
+	 * @param array $organized_files   $_FILES but organized like $_POST
+	 * @param array $name_parts_so_far for multidimensional HTML form names,
+	 * @throws UnexpectedValueException
+	 * @throws InvalidArgumentException
+	 * @since 4.9.80.p
+	 */
+	protected function createFileObjects($organized_files, $name_parts_so_far = [])
+	{
+		if (! is_array($organized_files)) {
+			throw new UnexpectedValueException(
+				sprintf(
+					esc_html__(
+						'Unexpected PHP $organized_files data format. "%1$s" was expected to be an array.',
+						'event_espresso'
+					),
+					(string) $organized_files
+				)
+			);
+		}
+		foreach ($organized_files as $key => $value) {
+			$this_input_name_parts = $name_parts_so_far;
+			array_push(
+				$this_input_name_parts,
+				$key
+			);
+			if (isset($value['name'], $value['tmp_name'], $value['size'])) {
+				$html_name = $this->inputNameFromParts($this_input_name_parts);
+				$this->file_objects->add(
+					new FileSubmission(
+						$value['name'],
+						$value['tmp_name'],
+						$value['size'],
+						$value['error']
+					),
+					$html_name
+				);
+			} else {
+				$this->createFileObjects($value, $this_input_name_parts);
+			}
+		}
+	}
 
 
-    /**
-     * Takes the input name parts, like `['my', 'great', 'file', 'input1']`
-     * and returns the HTML name for it, "my[great][file][input1]"
-     *
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    protected function inputNameFromParts($parts)
-    {
-        if (! is_array($parts)) {
-            throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
-        }
-        $generated_string = '';
-        foreach ($parts as $part) {
-            $part = (string) $part;
-            // wrap all but the first part in []
-            $generated_string .= $generated_string === '' ? $part : '[' . $part . ']';
-        }
-        return $generated_string;
-    }
+	/**
+	 * Takes the input name parts, like `['my', 'great', 'file', 'input1']`
+	 * and returns the HTML name for it, "my[great][file][input1]"
+	 *
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	protected function inputNameFromParts($parts)
+	{
+		if (! is_array($parts)) {
+			throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
+		}
+		$generated_string = '';
+		foreach ($parts as $part) {
+			$part = (string) $part;
+			// wrap all but the first part in []
+			$generated_string .= $generated_string === '' ? $part : '[' . $part . ']';
+		}
+		return $generated_string;
+	}
 
 
-    /**
-     * Gets the input by the indicated $name_parts.
-     * Eg if you're looking for an input named "my[great][file][input1]", $name_parts
-     * should be `['my', 'great', 'file', 'input1']`.
-     * Alternatively, you could use `FileDataHandler::getFileObject('my[great][file][input1]');`
-     *
-     * @param $name_parts
-     * @return FileSubmissionInterface
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    public function getFileObjectFromNameParts($name_parts)
-    {
-        return $this->getFileObjects()->get($this->inputNameFromParts($name_parts));
-    }
+	/**
+	 * Gets the input by the indicated $name_parts.
+	 * Eg if you're looking for an input named "my[great][file][input1]", $name_parts
+	 * should be `['my', 'great', 'file', 'input1']`.
+	 * Alternatively, you could use `FileDataHandler::getFileObject('my[great][file][input1]');`
+	 *
+	 * @param $name_parts
+	 * @return FileSubmissionInterface
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	public function getFileObjectFromNameParts($name_parts)
+	{
+		return $this->getFileObjects()->get($this->inputNameFromParts($name_parts));
+	}
 
 
-    /**
-     * Gets the FileSubmissionInterface corresponding to the HTML name provided.
-     *
-     * @param $html_name
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws UnexpectedValueException
-     * @since 4.9.80.p
-     */
-    public function getFileObject($html_name)
-    {
-        return $this->getFileObjects()->get($html_name);
-    }
+	/**
+	 * Gets the FileSubmissionInterface corresponding to the HTML name provided.
+	 *
+	 * @param $html_name
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws UnexpectedValueException
+	 * @since 4.9.80.p
+	 */
+	public function getFileObject($html_name)
+	{
+		return $this->getFileObjects()->get($html_name);
+	}
 }
 // End of file FilesDataHandler.php
 // Location: EventEspresso\core\services\request\files/FilesDataHandler.php

Spacing +13 added lines, -13 removed lines

@@ -99,7 +99,7 @@ 
             // collection name
             'submitted_files'
         );
-        $files_raw_data     = $this->request->filesParams();
+        $files_raw_data = $this->request->filesParams();
         if (empty($files_raw_data)) {
             return;
         }
@@ -123,7 +123,7 @@ 
      */
     protected function isStrangeFilesArray($files_data)
     {
-        if (! is_array($files_data)) {
+        if ( ! is_array($files_data)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -135,7 +135,7 @@ 
             );
         }
         $first_value = reset($files_data);
-        if (! is_array($first_value)) {
+        if ( ! is_array($first_value)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -171,14 +171,14 @@ 
         $sane_files_array = [];
         foreach ($files_data as $top_level_name => $top_level_children) {
             $sub_array                           = [];
-            $sane_files_array[ $top_level_name ] = [];
+            $sane_files_array[$top_level_name] = [];
             foreach ($top_level_children as $file_data_part => $second_level_children) {
                 foreach ($second_level_children as $next_level_name => $sub_values) {
-                    $sub_array[ $next_level_name ] = $this->organizeFilesData($sub_values, $file_data_part);
+                    $sub_array[$next_level_name] = $this->organizeFilesData($sub_values, $file_data_part);
                 }
-                $sane_files_array[ $top_level_name ] = array_replace_recursive(
+                $sane_files_array[$top_level_name] = array_replace_recursive(
                     $sub_array,
-                    $sane_files_array[ $top_level_name ]
+                    $sane_files_array[$top_level_name]
                 );
             }
         }
@@ -196,7 +196,7 @@ 
      */
     protected function organizeFilesData($data, $type)
     {
-        if (! is_array($data)) {
+        if ( ! is_array($data)) {
             return [
                 $type => $data,
             ];
@@ -204,9 +204,9 @@ 
         $organized_data = [];
         foreach ($data as $input_name_part => $sub_inputs_or_value) {
             if (is_array($sub_inputs_or_value)) {
-                $organized_data[ $input_name_part ] = $this->organizeFilesData($sub_inputs_or_value, $type);
+                $organized_data[$input_name_part] = $this->organizeFilesData($sub_inputs_or_value, $type);
             } else {
-                $organized_data[ $input_name_part ][ $type ] = $sub_inputs_or_value;
+                $organized_data[$input_name_part][$type] = $sub_inputs_or_value;
             }
         }
         return $organized_data;
@@ -226,7 +226,7 @@ 
      */
     protected function createFileObjects($organized_files, $name_parts_so_far = [])
     {
-        if (! is_array($organized_files)) {
+        if ( ! is_array($organized_files)) {
             throw new UnexpectedValueException(
                 sprintf(
                     esc_html__(
@@ -270,14 +270,14 @@ 
      */
     protected function inputNameFromParts($parts)
     {
-        if (! is_array($parts)) {
+        if ( ! is_array($parts)) {
             throw new UnexpectedValueException(esc_html__('Name parts should be an array.', 'event_espresso'));
         }
         $generated_string = '';
         foreach ($parts as $part) {
             $part = (string) $part;
             // wrap all but the first part in []
-            $generated_string .= $generated_string === '' ? $part : '[' . $part . ']';
+            $generated_string .= $generated_string === '' ? $part : '['.$part.']';
         }
         return $generated_string;
     }

core/services/request/sanitizers/ServerSanitizer.php

Indentation +55 added lines, -55 removed lines

@@ -11,59 +11,59 @@
  */
 class ServerSanitizer
 {
-    /**
-     * @param string $value
-     * @return mixed|string
-     */
-    public function clean($key, $value)
-    {
-        switch ($key) {
-            case 'AUTH_TYPE':
-                $valid_types = [
-                    'Basic',
-                    'Bearer',
-                    'Digest',
-                    'HOBA',
-                    'Mutual',
-                    'Negotiate',
-                    'OAuth',
-                    'SCRAM-SHA-1',
-                    'SCRAM-SHA-256',
-                    'vapid',
-                ];
-                return in_array($value, $valid_types, true) ? $value : 'Basic';
-            case 'argc':
-            case 'HTTP_DNT':
-            case 'HTTP_UPGRADE_INSECURE_REQUESTS':
-            case 'SERVER_PORT':
-            case 'REMOTE_PORT':
-            case 'REQUEST_TIME':
-                return (int) filter_var($value, FILTER_SANITIZE_NUMBER_INT);
-            case 'REQUEST_TIME_FLOAT':
-                return (float) filter_var($value, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
-            case 'REQUEST_METHOD':
-                $valid_types = [
-                    'CONNECT',
-                    'DELETE',
-                    'GET',
-                    'HEAD',
-                    'OPTIONS',
-                    'PATCH',
-                    'POST',
-                    'PUT',
-                    'TRACE',
-                ];
-                return in_array($value, $valid_types, true) ? $value : 'GET';
-            case 'HTTP_HOST':
-            case 'QUERY_STRING':
-            case 'REQUEST_URI':
-            case 'SCRIPT_NAME':
-            case 'SERVER_NAME':
-                return filter_var($value, FILTER_SANITIZE_URL);
-            case 'SERVER_ADMIN':
-                return filter_var($value, FILTER_SANITIZE_EMAIL);
-            default:
-                return filter_var($value, FILTER_SANITIZE_STRING);
-        }
-    }
+	/**
+	 * @param string $value
+	 * @return mixed|string
+	 */
+	public function clean($key, $value)
+	{
+		switch ($key) {
+			case 'AUTH_TYPE':
+				$valid_types = [
+					'Basic',
+					'Bearer',
+					'Digest',
+					'HOBA',
+					'Mutual',
+					'Negotiate',
+					'OAuth',
+					'SCRAM-SHA-1',
+					'SCRAM-SHA-256',
+					'vapid',
+				];
+				return in_array($value, $valid_types, true) ? $value : 'Basic';
+			case 'argc':
+			case 'HTTP_DNT':
+			case 'HTTP_UPGRADE_INSECURE_REQUESTS':
+			case 'SERVER_PORT':
+			case 'REMOTE_PORT':
+			case 'REQUEST_TIME':
+				return (int) filter_var($value, FILTER_SANITIZE_NUMBER_INT);
+			case 'REQUEST_TIME_FLOAT':
+				return (float) filter_var($value, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
+			case 'REQUEST_METHOD':
+				$valid_types = [
+					'CONNECT',
+					'DELETE',
+					'GET',
+					'HEAD',
+					'OPTIONS',
+					'PATCH',
+					'POST',
+					'PUT',
+					'TRACE',
+				];
+				return in_array($value, $valid_types, true) ? $value : 'GET';
+			case 'HTTP_HOST':
+			case 'QUERY_STRING':
+			case 'REQUEST_URI':
+			case 'SCRIPT_NAME':
+			case 'SERVER_NAME':
+				return filter_var($value, FILTER_SANITIZE_URL);
+			case 'SERVER_ADMIN':
+				return filter_var($value, FILTER_SANITIZE_EMAIL);
+			default:
+				return filter_var($value, FILTER_SANITIZE_STRING);
+		}
+	}
 }

core/services/request/sanitizers/RequestSanitizer.php

Indentation +42 added lines, -42 removed lines

@@ -4,46 +4,46 @@
 
 class RequestSanitizer
 {
-    /**
-     * Will sanitize the supplied request parameter based on the specified data type
-     *
-     * @param mixed  $param     the supplied request parameter
-     * @param string $type      the specified data type (default: "string")
-     *                          valid values: "bool", "float", "int", "key", "url", "string", or "arrayOf|*"
-     *                          where * is any of the other valid values ex: "arrayOf|int", "arrayOf|string"
-     * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
-     *                          (default: ",")
-     * @return array|bool|float|int|string
-     * @since $VID:$
-     */
-    public function clean($param, $type = 'string', $delimiter = ',')
-    {
-        switch ($type) {
-            case 'bool':
-                return filter_var($param, FILTER_VALIDATE_BOOLEAN);
-            case 'float':
-                return (float) $param;
-            case 'int':
-                return (int) $param;
-            case 'key':
-                return sanitize_key($param);
-            case 'url':
-                return esc_url_raw($param);
-            case 'string':
-                return sanitize_text_field($param);
-            default:
-                if (strpos($type, 'arrayOf|') === 0) {
-                    $values        = [];
-                    $array_of_type = substr($type, 8);
-                    $list          = is_string($param) ? explode($delimiter, $param) : (array) $param;
-                    foreach ($list as $key => $item) {
-                        $values[ $key ] = is_array($item)
-                            ? $this->clean($item, $type, $delimiter)
-                            : $this->clean($item, $array_of_type, $delimiter);
-                    }
-                    return $values;
-                }
-                return sanitize_text_field($param);
-        }
-    }
+	/**
+	 * Will sanitize the supplied request parameter based on the specified data type
+	 *
+	 * @param mixed  $param     the supplied request parameter
+	 * @param string $type      the specified data type (default: "string")
+	 *                          valid values: "bool", "float", "int", "key", "url", "string", or "arrayOf|*"
+	 *                          where * is any of the other valid values ex: "arrayOf|int", "arrayOf|string"
+	 * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
+	 *                          (default: ",")
+	 * @return array|bool|float|int|string
+	 * @since $VID:$
+	 */
+	public function clean($param, $type = 'string', $delimiter = ',')
+	{
+		switch ($type) {
+			case 'bool':
+				return filter_var($param, FILTER_VALIDATE_BOOLEAN);
+			case 'float':
+				return (float) $param;
+			case 'int':
+				return (int) $param;
+			case 'key':
+				return sanitize_key($param);
+			case 'url':
+				return esc_url_raw($param);
+			case 'string':
+				return sanitize_text_field($param);
+			default:
+				if (strpos($type, 'arrayOf|') === 0) {
+					$values        = [];
+					$array_of_type = substr($type, 8);
+					$list          = is_string($param) ? explode($delimiter, $param) : (array) $param;
+					foreach ($list as $key => $item) {
+						$values[ $key ] = is_array($item)
+							? $this->clean($item, $type, $delimiter)
+							: $this->clean($item, $array_of_type, $delimiter);
+					}
+					return $values;
+				}
+				return sanitize_text_field($param);
+		}
+	}
 }
\ No newline at end of file

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
                     $array_of_type = substr($type, 8);
                     $list          = is_string($param) ? explode($delimiter, $param) : (array) $param;
                     foreach ($list as $key => $item) {
-                        $values[ $key ] = is_array($item)
+                        $values[$key] = is_array($item)
                             ? $this->clean($item, $type, $delimiter)
                             : $this->clean($item, $array_of_type, $delimiter);
                     }

core/services/request/RequestParams.php

Indentation +306 added lines, -306 removed lines

@@ -14,310 +14,310 @@
 class RequestParams
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array
-     */
-    protected $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array
-     */
-    protected $post;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array
-     */
-    protected $request;
-
-    /**
-     * @var RequestSanitizer
-     */
-    protected $sanitizer;
-
-
-    /**
-     * RequestParams constructor.
-     *
-     * @param RequestSanitizer $sanitizer
-     * @param array            $get
-     * @param array            $post
-     */
-    public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
-    {
-        $this->sanitizer = $sanitizer;
-        $this->get       = ! empty($get) ? $get : (array) filter_input_array(INPUT_GET, FILTER_SANITIZE_STRING);
-        $this->post      = ! empty($post) ? $post : (array) filter_input_array(INPUT_POST, FILTER_SANITIZE_STRING);
-        $this->request   = array_merge($this->get, $this->post);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $value
-     * @param bool       $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * 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 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 = 'string', $delimiter = ',')
-    {
-        return $this->sanitizer->clean(
-            $this->parameterDrillDown($key, $default, 'get'),
-            $type,
-            $delimiter
-        );
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param string $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return (bool) $this->parameterDrillDown($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 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 = 'string', $delimiter = ',')
-    {
-        return $this->sanitizer->clean(
-            $this->parameterDrillDown($pattern, $default, 'match'),
-            $type,
-            $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 (bool) $this->parameterDrillDown($pattern, false, 'match', 'bool');
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, ['bool', 'key', 'value'], true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            ['\*', '\?'],
-            ['.*', '.'],
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_param;
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param string $return
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function parameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        $return = 'value',
-        array $request_params = []
-    ) {
-        $callback       = in_array($callback, ['is_set', 'get', 'match'], true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key  = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key  = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key      = $real_key ?: $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->parameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $return,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default, $return);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * remove params
-     *
-     * @param array $keys
-     * @param bool  $unset_from_global_too
-     */
-    public function unSetRequestParams(array $keys, $unset_from_global_too = false)
-    {
-        foreach ($keys as $key) {
-            $this->unSetRequestParam($key, $unset_from_global_too);
-        }
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array
+	 */
+	protected $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array
+	 */
+	protected $post;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array
+	 */
+	protected $request;
+
+	/**
+	 * @var RequestSanitizer
+	 */
+	protected $sanitizer;
+
+
+	/**
+	 * RequestParams constructor.
+	 *
+	 * @param RequestSanitizer $sanitizer
+	 * @param array            $get
+	 * @param array            $post
+	 */
+	public function __construct(RequestSanitizer $sanitizer, array $get = [], array $post = [])
+	{
+		$this->sanitizer = $sanitizer;
+		$this->get       = ! empty($get) ? $get : (array) filter_input_array(INPUT_GET, FILTER_SANITIZE_STRING);
+		$this->post      = ! empty($post) ? $post : (array) filter_input_array(INPUT_POST, FILTER_SANITIZE_STRING);
+		$this->request   = array_merge($this->get, $this->post);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $value
+	 * @param bool       $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * 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 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 = 'string', $delimiter = ',')
+	{
+		return $this->sanitizer->clean(
+			$this->parameterDrillDown($key, $default, 'get'),
+			$type,
+			$delimiter
+		);
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param string $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return (bool) $this->parameterDrillDown($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 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 = 'string', $delimiter = ',')
+	{
+		return $this->sanitizer->clean(
+			$this->parameterDrillDown($pattern, $default, 'match'),
+			$type,
+			$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 (bool) $this->parameterDrillDown($pattern, false, 'match', 'bool');
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, ['bool', 'key', 'value'], true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			['\*', '\?'],
+			['.*', '.'],
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_param;
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param string $return
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function parameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		$return = 'value',
+		array $request_params = []
+	) {
+		$callback       = in_array($callback, ['is_set', 'get', 'match'], true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key  = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key  = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key      = $real_key ?: $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->parameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$return,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default, $return);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->get[ $key ]     = null;
+		$this->post[ $key ]    = null;
+		$this->request[ $key ] = null;
+		unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * remove params
+	 *
+	 * @param array $keys
+	 * @param bool  $unset_from_global_too
+	 */
+	public function unSetRequestParams(array $keys, $unset_from_global_too = false)
+	{
+		foreach ($keys as $key) {
+			$this->unSetRequestParam($key, $unset_from_global_too);
+		}
+	}
 }
\ No newline at end of file

Spacing +14 added lines, -14 removed lines

@@ -96,7 +96,7 @@ 
     {
         // don't allow "ee" to be overwritten unless explicitly instructed to do so
         if ($override_ee || $key !== 'ee' || empty($this->request['ee'])) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -199,7 +199,7 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === 'value') {
                     return $request_param;
@@ -261,30 +261,30 @@ 
                 $key      = $real_key ?: $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->parameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
                     $return,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default, $return);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -298,12 +298,12 @@ 
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
         // because unset may not actually remove var
-        $this->get[ $key ]     = null;
-        $this->post[ $key ]    = null;
-        $this->request[ $key ] = null;
-        unset($this->get[ $key ], $this->post[ $key ], $this->request[ $key ]);
+        $this->get[$key]     = null;
+        $this->post[$key]    = null;
+        $this->request[$key] = null;
+        unset($this->get[$key], $this->post[$key], $this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_GET[ $key ], $_POST[ $key ], $_REQUEST[ $key ]);
+            unset($_GET[$key], $_POST[$key], $_REQUEST[$key]);
         }
     }
 

core/services/request/LegacyRequestInterface.php

Indentation +87 added lines, -87 removed lines

@@ -12,125 +12,125 @@
 interface LegacyRequestInterface
 {
 
-    /**
-     * @return array
-     */
-    public function get_params();
+	/**
+	 * @return array
+	 */
+	public function get_params();
 
 
-    /**
-     * @return array
-     */
-    public function post_params();
+	/**
+	 * @return array
+	 */
+	public function post_params();
 
 
-    /**
-     * @return array
-     */
-    public function cookie_params();
+	/**
+	 * @return array
+	 */
+	public function cookie_params();
 
 
-    /**
-     * @return array
-     */
-    public function server_params();
+	/**
+	 * @return array
+	 */
+	public function server_params();
 
 
-    /**
-     * returns sanitized contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function params();
+	/**
+	 * returns sanitized contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function params();
 
 
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function set($key, $value, $override_ee = false);
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function set($key, $value, $override_ee = false);
 
 
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function get($key, $default = null);
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function get($key, $default = null);
 
 
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function is_set($key);
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function is_set($key);
 
 
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function un_set($key, $unset_from_global_too = false);
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function un_set($key, $unset_from_global_too = false);
 
 
-    /**
-     * @return string
-     */
-    public function ip_address();
+	/**
+	 * @return string
+	 */
+	public function ip_address();
 
 
-    /**
-     * @return bool
-     */
-    public function isAdmin();
+	/**
+	 * @return bool
+	 */
+	public function isAdmin();
 
 
-    /**
-     * @return mixed
-     */
-    public function isAjax();
+	/**
+	 * @return mixed
+	 */
+	public function isAjax();
 
 
-    /**
-     * @return mixed
-     */
-    public function isFrontAjax();
+	/**
+	 * @return mixed
+	 */
+	public function isFrontAjax();
 
 
-    /**
-     * @return mixed|string
-     */
-    public function requestUri();
+	/**
+	 * @return mixed|string
+	 */
+	public function requestUri();
 
 
-    /**
-     * @return string
-     */
-    public function userAgent();
+	/**
+	 * @return string
+	 */
+	public function userAgent();
 
 
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '');
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '');
 
 
-    /**
-     * @return bool
-     */
-    public function isBot();
+	/**
+	 * @return bool
+	 */
+	public function isBot();
 
 
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot);
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot);
 }

core/services/request/Request.php

Indentation +475 added lines, -475 removed lines

@@ -17,479 +17,479 @@
 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_SANITIZE_STRING);
-        $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
-     * @return array|int|float|string
-     */
-    public function getServerParam($key)
-    {
-        return $this->server_params->getServerParam($key);
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @return void
-     */
-    public function setServerParam($key, $value)
-    {
-        $this->server_params->setServerParam($key, $value);
-    }
-
-
-    /**
-     * @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);
-    }
-
-
-    /**
-     * 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 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 = 'string', $delimiter = ',')
-    {
-        return $this->request_params->getRequestParam($key, $default, $type, $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 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 = 'string', $delimiter = ',')
-    {
-        return $this->request_params->getMatch($pattern, $default, $type, $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);
-    }
-
-
-    /**
-     * @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/".
-     * @return string
-     */
-    public function requestUri($relativeToWpRoot = false)
-    {
-        return $this->server_params->requestUri();
-    }
-
-
-    /**
-     * @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 isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @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();
-    }
-
-
-    /**
-     * @return RequestTypeContextCheckerInterface
-     */
-    public function getRequestType()
-    {
-        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_SANITIZE_STRING);
+		$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
+	 * @return array|int|float|string
+	 */
+	public function getServerParam($key)
+	{
+		return $this->server_params->getServerParam($key);
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @return void
+	 */
+	public function setServerParam($key, $value)
+	{
+		$this->server_params->setServerParam($key, $value);
+	}
+
+
+	/**
+	 * @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);
+	}
+
+
+	/**
+	 * 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 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 = 'string', $delimiter = ',')
+	{
+		return $this->request_params->getRequestParam($key, $default, $type, $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 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 = 'string', $delimiter = ',')
+	{
+		return $this->request_params->getMatch($pattern, $default, $type, $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);
+	}
+
+
+	/**
+	 * @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/".
+	 * @return string
+	 */
+	public function requestUri($relativeToWpRoot = false)
+	{
+		return $this->server_params->requestUri();
+	}
+
+
+	/**
+	 * @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 isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @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();
+	}
+
+
+	/**
+	 * @return RequestTypeContextCheckerInterface
+	 */
+	public function getRequestType()
+	{
+		return $this->request_type;
+	}
 }

core/services/request/CurrentPage.php

Indentation +289 added lines, -289 removed lines

@@ -7,293 +7,293 @@
 
 class CurrentPage
 {
-    /**
-     * @var EE_CPT_Strategy
-     */
-    private $cpt_strategy;
-
-    /**
-     * @var bool
-     */
-    private $initialized;
-
-    /**
-     * @var bool
-     */
-    private $is_espresso_page = false;
-
-    /**
-     * @var int
-     */
-    private $post_id = 0;
-
-    /**
-     * @var string
-     */
-    private $post_name = '';
-
-    /**
-     * @var array
-     */
-    private $post_type = [];
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-
-    /**
-     * CurrentPage constructor.
-     *
-     * @param EE_CPT_Strategy  $cpt_strategy
-     * @param RequestInterface $request
-     */
-    public function __construct(EE_CPT_Strategy $cpt_strategy, RequestInterface $request)
-    {
-        $this->cpt_strategy = $cpt_strategy;
-        $this->request      = $request;
-        $this->initialized  = is_admin();
-        // analyse the incoming WP request
-        add_action('parse_request', [$this, 'parseQueryVars'], 2, 1);
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return void
-     */
-    public function parseQueryVars(WP $WP = null)
-    {
-        if ($this->initialized) {
-            return;
-        }
-        // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $WP instanceof WP) {
-            global $WP;
-        }
-        $this->post_id   = $this->getPostId($WP);
-        $this->post_name = $this->getPostName($WP);
-        $this->post_type = $this->getPostType($WP);
-        // true or false ? is this page being used by EE ?
-        $this->setEspressoPage();
-        remove_action('parse_request', [$this, 'parseRequest'], 2);
-        $this->initialized   = true;
-    }
-
-
-    /**
-     * Just a helper method for getting the url for the displayed page.
-     *
-     * @param WP|null $WP
-     * @return string
-     */
-    public function getPermalink(WP $WP = null)
-    {
-        $post_id = $this->post_id ?: $this->getPostId($WP);
-        if ($post_id) {
-            return get_permalink($post_id);
-        }
-        if (! $WP instanceof WP) {
-            global $WP;
-        }
-        if ($WP instanceof WP && $WP->request) {
-            return site_url($WP->request);
-        }
-        return esc_url_raw(site_url($_SERVER['REQUEST_URI']));
-    }
-
-
-    /**
-     * @return array
-     */
-    public function espressoPostType()
-    {
-        return array_filter(
-            $this->post_type,
-            function ($post_type) {
-                return strpos($post_type, 'espresso_') === 0;
-            }
-        );
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return int
-     */
-    private function getPostId(WP $WP = null)
-    {
-        $post_id = null;
-        if ($WP instanceof WP) {
-            if (isset($WP->query_vars['p'])) {
-                $post_id = $WP->query_vars['p'];
-            }
-            if (! $post_id && isset($WP->query_vars['page_id'])) {
-                $post_id = $WP->query_vars['page_id'];
-            }
-            if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
-                $post_id = basename($WP->request);
-            }
-        }
-        if (! $post_id && $this->request->requestParamIsSet('post_id')) {
-            $post_id = $this->request->getRequestParam('post_id');
-        }
-        return $post_id;
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return string
-     */
-    private function getPostName(WP $WP = null)
-    {
-        global $wpdb;
-        $post_name = null;
-        if ($WP instanceof WP) {
-            if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
-                $post_name = $WP->query_vars['name'];
-            }
-            if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
-                $post_name = $WP->query_vars['pagename'];
-            }
-            if (! $post_name && $WP->request !== null && ! empty($WP->request)) {
-                $possible_post_name = basename($WP->request);
-                if (! is_numeric($possible_post_name)) {
-                    $SQL                = "SELECT ID from {$wpdb->posts}";
-                    $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
-                    $SQL                .= ' AND post_name=%s';
-                    $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
-                    if ($possible_post_name) {
-                        $post_name = $possible_post_name;
-                    }
-                }
-            }
-        }
-        if (! $post_name && $this->post_id) {
-            $SQL                = "SELECT post_name from {$wpdb->posts}";
-            $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
-            $SQL                .= ' AND ID=%d';
-            $possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->post_id));
-            if ($possible_post_name) {
-                $post_name = $possible_post_name;
-            }
-        }
-        if (! $post_name && $this->request->requestParamIsSet('post_name')) {
-            $post_name = $this->request->getRequestParam('post_name');
-        }
-        return $post_name;
-    }
-
-
-    /**
-     * @param WP $WP
-     * @return array
-     */
-    private function getPostType(WP $WP = null)
-    {
-        $post_types = [];
-        if ($WP instanceof WP) {
-            $post_types = isset($WP->query_vars['post_type'])
-                ? (array) $WP->query_vars['post_type']
-                : [];
-        }
-        if (empty($post_types) && $this->request->requestParamIsSet('post_type')) {
-            $post_types = $this->request->getRequestParam('post_type');
-        }
-        return (array) $post_types;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEspressoPage()
-    {
-        return $this->is_espresso_page;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function postId()
-    {
-        return $this->post_id;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function postName()
-    {
-        return $this->post_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postType()
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * @param null|bool $value
-     * @return void
-     */
-    public function setEspressoPage($value = null)
-    {
-        $this->is_espresso_page = $value !== null
-            ? filter_var($value, FILTER_VALIDATE_BOOLEAN)
-            : $this->testForEspressoPage();
-    }
-
-
-    /**
-     * @return bool
-     */
-    private function testForEspressoPage()
-    {
-        // in case it has already been set
-        if ($this->is_espresso_page) {
-            return true;
-        }
-        global $WP;
-        $espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
-        if (is_array($espresso_CPT_taxonomies)) {
-            foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
-                    return true;
-                }
-            }
-        }
-        // load espresso CPT endpoints
-        $espresso_CPT_endpoints  = $this->cpt_strategy->get_CPT_endpoints();
-        $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
-        foreach ($this->post_type as $post_type) {
-            // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
-                // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->post_name) {
-                    $espresso_post_type = $this->request->getRequestParam('post_type');
-                    // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
-                    // this essentially sets the post_name to "events" (or whatever EE CPT)
-                    $post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
-                        ? $post_type_CPT_endpoints[ $espresso_post_type ]
-                        : '';
-                    // if the post type matches one of ours then set the post name to the endpoint
-                    if ($post_name) {
-                        $this->post_name = $post_name;
-                    }
-                }
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * @var EE_CPT_Strategy
+	 */
+	private $cpt_strategy;
+
+	/**
+	 * @var bool
+	 */
+	private $initialized;
+
+	/**
+	 * @var bool
+	 */
+	private $is_espresso_page = false;
+
+	/**
+	 * @var int
+	 */
+	private $post_id = 0;
+
+	/**
+	 * @var string
+	 */
+	private $post_name = '';
+
+	/**
+	 * @var array
+	 */
+	private $post_type = [];
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+
+	/**
+	 * CurrentPage constructor.
+	 *
+	 * @param EE_CPT_Strategy  $cpt_strategy
+	 * @param RequestInterface $request
+	 */
+	public function __construct(EE_CPT_Strategy $cpt_strategy, RequestInterface $request)
+	{
+		$this->cpt_strategy = $cpt_strategy;
+		$this->request      = $request;
+		$this->initialized  = is_admin();
+		// analyse the incoming WP request
+		add_action('parse_request', [$this, 'parseQueryVars'], 2, 1);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function parseQueryVars(WP $WP = null)
+	{
+		if ($this->initialized) {
+			return;
+		}
+		// if somebody forgot to provide us with WP, that's ok because its global
+		if (! $WP instanceof WP) {
+			global $WP;
+		}
+		$this->post_id   = $this->getPostId($WP);
+		$this->post_name = $this->getPostName($WP);
+		$this->post_type = $this->getPostType($WP);
+		// true or false ? is this page being used by EE ?
+		$this->setEspressoPage();
+		remove_action('parse_request', [$this, 'parseRequest'], 2);
+		$this->initialized   = true;
+	}
+
+
+	/**
+	 * Just a helper method for getting the url for the displayed page.
+	 *
+	 * @param WP|null $WP
+	 * @return string
+	 */
+	public function getPermalink(WP $WP = null)
+	{
+		$post_id = $this->post_id ?: $this->getPostId($WP);
+		if ($post_id) {
+			return get_permalink($post_id);
+		}
+		if (! $WP instanceof WP) {
+			global $WP;
+		}
+		if ($WP instanceof WP && $WP->request) {
+			return site_url($WP->request);
+		}
+		return esc_url_raw(site_url($_SERVER['REQUEST_URI']));
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function espressoPostType()
+	{
+		return array_filter(
+			$this->post_type,
+			function ($post_type) {
+				return strpos($post_type, 'espresso_') === 0;
+			}
+		);
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return int
+	 */
+	private function getPostId(WP $WP = null)
+	{
+		$post_id = null;
+		if ($WP instanceof WP) {
+			if (isset($WP->query_vars['p'])) {
+				$post_id = $WP->query_vars['p'];
+			}
+			if (! $post_id && isset($WP->query_vars['page_id'])) {
+				$post_id = $WP->query_vars['page_id'];
+			}
+			if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
+				$post_id = basename($WP->request);
+			}
+		}
+		if (! $post_id && $this->request->requestParamIsSet('post_id')) {
+			$post_id = $this->request->getRequestParam('post_id');
+		}
+		return $post_id;
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return string
+	 */
+	private function getPostName(WP $WP = null)
+	{
+		global $wpdb;
+		$post_name = null;
+		if ($WP instanceof WP) {
+			if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
+				$post_name = $WP->query_vars['name'];
+			}
+			if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
+				$post_name = $WP->query_vars['pagename'];
+			}
+			if (! $post_name && $WP->request !== null && ! empty($WP->request)) {
+				$possible_post_name = basename($WP->request);
+				if (! is_numeric($possible_post_name)) {
+					$SQL                = "SELECT ID from {$wpdb->posts}";
+					$SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
+					$SQL                .= ' AND post_name=%s';
+					$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $possible_post_name));
+					if ($possible_post_name) {
+						$post_name = $possible_post_name;
+					}
+				}
+			}
+		}
+		if (! $post_name && $this->post_id) {
+			$SQL                = "SELECT post_name from {$wpdb->posts}";
+			$SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
+			$SQL                .= ' AND ID=%d';
+			$possible_post_name = $wpdb->get_var($wpdb->prepare($SQL, $this->post_id));
+			if ($possible_post_name) {
+				$post_name = $possible_post_name;
+			}
+		}
+		if (! $post_name && $this->request->requestParamIsSet('post_name')) {
+			$post_name = $this->request->getRequestParam('post_name');
+		}
+		return $post_name;
+	}
+
+
+	/**
+	 * @param WP $WP
+	 * @return array
+	 */
+	private function getPostType(WP $WP = null)
+	{
+		$post_types = [];
+		if ($WP instanceof WP) {
+			$post_types = isset($WP->query_vars['post_type'])
+				? (array) $WP->query_vars['post_type']
+				: [];
+		}
+		if (empty($post_types) && $this->request->requestParamIsSet('post_type')) {
+			$post_types = $this->request->getRequestParam('post_type');
+		}
+		return (array) $post_types;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEspressoPage()
+	{
+		return $this->is_espresso_page;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function postId()
+	{
+		return $this->post_id;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function postName()
+	{
+		return $this->post_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postType()
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * @param null|bool $value
+	 * @return void
+	 */
+	public function setEspressoPage($value = null)
+	{
+		$this->is_espresso_page = $value !== null
+			? filter_var($value, FILTER_VALIDATE_BOOLEAN)
+			: $this->testForEspressoPage();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	private function testForEspressoPage()
+	{
+		// in case it has already been set
+		if ($this->is_espresso_page) {
+			return true;
+		}
+		global $WP;
+		$espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
+		if (is_array($espresso_CPT_taxonomies)) {
+			foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
+				if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
+					return true;
+				}
+			}
+		}
+		// load espresso CPT endpoints
+		$espresso_CPT_endpoints  = $this->cpt_strategy->get_CPT_endpoints();
+		$post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
+		foreach ($this->post_type as $post_type) {
+			// was a post name passed ?
+			if (isset($post_type_CPT_endpoints[ $post_type ])) {
+				// kk we know this is an espresso page, but is it a specific post ?
+				if (! $this->post_name) {
+					$espresso_post_type = $this->request->getRequestParam('post_type');
+					// there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
+					// this essentially sets the post_name to "events" (or whatever EE CPT)
+					$post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
+						? $post_type_CPT_endpoints[ $espresso_post_type ]
+						: '';
+					// if the post type matches one of ours then set the post name to the endpoint
+					if ($post_name) {
+						$this->post_name = $post_name;
+					}
+				}
+				return true;
+			}
+		}
+		return false;
+	}
 }

Spacing +17 added lines, -17 removed lines

@@ -69,7 +69,7 @@ 
             return;
         }
         // if somebody forgot to provide us with WP, that's ok because its global
-        if (! $WP instanceof WP) {
+        if ( ! $WP instanceof WP) {
             global $WP;
         }
         $this->post_id   = $this->getPostId($WP);
@@ -78,7 +78,7 @@ 
         // true or false ? is this page being used by EE ?
         $this->setEspressoPage();
         remove_action('parse_request', [$this, 'parseRequest'], 2);
-        $this->initialized   = true;
+        $this->initialized = true;
     }
 
 
@@ -94,7 +94,7 @@ 
         if ($post_id) {
             return get_permalink($post_id);
         }
-        if (! $WP instanceof WP) {
+        if ( ! $WP instanceof WP) {
             global $WP;
         }
         if ($WP instanceof WP && $WP->request) {
@@ -111,7 +111,7 @@ 
     {
         return array_filter(
             $this->post_type,
-            function ($post_type) {
+            function($post_type) {
                 return strpos($post_type, 'espresso_') === 0;
             }
         );
@@ -129,14 +129,14 @@ 
             if (isset($WP->query_vars['p'])) {
                 $post_id = $WP->query_vars['p'];
             }
-            if (! $post_id && isset($WP->query_vars['page_id'])) {
+            if ( ! $post_id && isset($WP->query_vars['page_id'])) {
                 $post_id = $WP->query_vars['page_id'];
             }
-            if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
+            if ( ! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
                 $post_id = basename($WP->request);
             }
         }
-        if (! $post_id && $this->request->requestParamIsSet('post_id')) {
+        if ( ! $post_id && $this->request->requestParamIsSet('post_id')) {
             $post_id = $this->request->getRequestParam('post_id');
         }
         return $post_id;
@@ -155,12 +155,12 @@ 
             if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
                 $post_name = $WP->query_vars['name'];
             }
-            if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
+            if ( ! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
                 $post_name = $WP->query_vars['pagename'];
             }
-            if (! $post_name && $WP->request !== null && ! empty($WP->request)) {
+            if ( ! $post_name && $WP->request !== null && ! empty($WP->request)) {
                 $possible_post_name = basename($WP->request);
-                if (! is_numeric($possible_post_name)) {
+                if ( ! is_numeric($possible_post_name)) {
                     $SQL                = "SELECT ID from {$wpdb->posts}";
                     $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
                     $SQL                .= ' AND post_name=%s';
@@ -171,7 +171,7 @@ 
                 }
             }
         }
-        if (! $post_name && $this->post_id) {
+        if ( ! $post_name && $this->post_id) {
             $SQL                = "SELECT post_name from {$wpdb->posts}";
             $SQL                .= " WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash')";
             $SQL                .= ' AND ID=%d';
@@ -180,7 +180,7 @@ 
                 $post_name = $possible_post_name;
             }
         }
-        if (! $post_name && $this->request->requestParamIsSet('post_name')) {
+        if ( ! $post_name && $this->request->requestParamIsSet('post_name')) {
             $post_name = $this->request->getRequestParam('post_name');
         }
         return $post_name;
@@ -267,7 +267,7 @@ 
         $espresso_CPT_taxonomies = $this->cpt_strategy->get_CPT_taxonomies();
         if (is_array($espresso_CPT_taxonomies)) {
             foreach ($espresso_CPT_taxonomies as $espresso_CPT_taxonomy => $details) {
-                if (isset($WP->query_vars, $WP->query_vars[ $espresso_CPT_taxonomy ])) {
+                if (isset($WP->query_vars, $WP->query_vars[$espresso_CPT_taxonomy])) {
                     return true;
                 }
             }
@@ -277,14 +277,14 @@ 
         $post_type_CPT_endpoints = array_flip($espresso_CPT_endpoints);
         foreach ($this->post_type as $post_type) {
             // was a post name passed ?
-            if (isset($post_type_CPT_endpoints[ $post_type ])) {
+            if (isset($post_type_CPT_endpoints[$post_type])) {
                 // kk we know this is an espresso page, but is it a specific post ?
-                if (! $this->post_name) {
+                if ( ! $this->post_name) {
                     $espresso_post_type = $this->request->getRequestParam('post_type');
                     // there's no specific post name set, so maybe it's one of our endpoints like www.domain.com/events
                     // this essentially sets the post_name to "events" (or whatever EE CPT)
-                    $post_name = isset($post_type_CPT_endpoints[ $espresso_post_type ])
-                        ? $post_type_CPT_endpoints[ $espresso_post_type ]
+                    $post_name = isset($post_type_CPT_endpoints[$espresso_post_type])
+                        ? $post_type_CPT_endpoints[$espresso_post_type]
                         : '';
                     // if the post type matches one of ours then set the post name to the endpoint
                     if ($post_name) {