eventespresso / event-espresso-core

core/EES_Shortcode.shortcode.php

Indentation +168 added lines, -168 removed lines

@@ -14,172 +14,172 @@
  */
 abstract class EES_Shortcode extends EE_Base
 {
-    /**
-     * @protected   public
-     * @var     array $_attributes
-     */
-    protected $_attributes = [];
-
-
-    /**
-     * class constructor - should ONLY be instantiated by EE_Front_Controller
-     */
-    final public function __construct()
-    {
-        $shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
-        // assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
-        add_shortcode($shortcode, [$this, 'process_shortcode']);
-        // make sure system knows this is an EE page
-        /** @var CurrentPage $current_page */
-        $current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
-        $current_page->setEspressoPage(true);
-    }
-
-
-    /**
-     * run - initial shortcode module setup called during "parse_request" hook by
-     * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
-     * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
-     * by a theme or plugin in a non-standard way.
-     * Basically this method is primarily used for loading resources and assets like CSS or JS
-     * that will be required by the shortcode when it is actually processed.
-     * Please note that assets may not load if the fallback_shortcode_processor() is being used.
-     *
-     * @param WP $WP
-     * @return void
-     */
-    abstract public function run(WP $WP);
-
-
-    /**
-     *  process_shortcode
-     *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the
-     *  shortcode within the_content
-     *
-     * @param array|string $attributes
-     * @return mixed
-     */
-    abstract public function process_shortcode($attributes = []);
-
-
-    /**
-     *    instance - returns instance of child class object
-     *
-     * @param string|null $shortcode_class
-     * @return EES_Shortcode
-     */
-    final public static function instance(string $shortcode_class = ''): ?EES_Shortcode
-    {
-        $shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
-        if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
-            return null;
-        }
-        $shortcode     = LegacyShortcodesManager::generateShortcodeTagFromClassName($shortcode_class);
-        $shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
-            ? EE_Registry::instance()->shortcodes->{$shortcode}
-            : null;
-        return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
-            ? $shortcode_obj
-            : new $shortcode_class();
-    }
-
-
-    /**
-     *    fallback_shortcode_processor - create instance and call process_shortcode
-     *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things
-     *    work at all
-     *
-     * @param array|string $attributes
-     * @return mixed
-     */
-    final public static function fallback_shortcode_processor($attributes = null)
-    {
-        if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
-            return null;
-        }
-        // what shortcode was actually parsed ?
-        $shortcode_class = get_called_class();
-        // notify rest of system that fallback processor was triggered
-        add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
-        // get instance of actual shortcode
-        $shortcode_obj = self::instance($shortcode_class);
-        // verify class
-        if ($shortcode_obj instanceof EES_Shortcode) {
-            global $wp;
-            $shortcode_obj->run($wp);
-            // set attributes and run the shortcode
-            $shortcode_obj->_attributes = (array) $attributes;
-            return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
-        }
-        return null;
-    }
-
-
-    /**
-     *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a
-     *    deactivated addon, and simply returns an empty string
-     *
-     * @param $attributes
-     * @return string
-     */
-    final public static function invalid_shortcode_processor($attributes): string
-    {
-        return '';
-    }
-
-
-    /**
-     * 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 by supplying an array for the $custom_sanitization param,
-     * 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 pass the following for your $custom_sanitization array:
-     *      array('event_id' => 'absint')
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @param array $custom_sanitization
-     * @return array
-     */
-    public static function sanitize_attributes(array $attributes, array $custom_sanitization = []): array
-    {
-        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;
-                } elseif (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, [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 ] = EES_Shortcode::sanitize_attributes($value);
-                    break;
-                default:
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[ $key ] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
+	/**
+	 * @protected   public
+	 * @var     array $_attributes
+	 */
+	protected $_attributes = [];
+
+
+	/**
+	 * class constructor - should ONLY be instantiated by EE_Front_Controller
+	 */
+	final public function __construct()
+	{
+		$shortcode = LegacyShortcodesManager::generateShortcodeTagFromClassName(get_class($this));
+		// assign shortcode to the preferred callback, which overwrites the "fallback shortcode processor" assigned earlier
+		add_shortcode($shortcode, [$this, 'process_shortcode']);
+		// make sure system knows this is an EE page
+		/** @var CurrentPage $current_page */
+		$current_page = LoaderFactory::getLoader()->getShared(CurrentPage::class);
+		$current_page->setEspressoPage(true);
+	}
+
+
+	/**
+	 * run - initial shortcode module setup called during "parse_request" hook by
+	 * \EE_Front_Controller::_initialize_shortcodes() IF this shortcode is going to execute during this request !
+	 * It may also get called by \EES_Shortcode::fallback_shortcode_processor() if the shortcode is being implemented
+	 * by a theme or plugin in a non-standard way.
+	 * Basically this method is primarily used for loading resources and assets like CSS or JS
+	 * that will be required by the shortcode when it is actually processed.
+	 * Please note that assets may not load if the fallback_shortcode_processor() is being used.
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	abstract public function run(WP $WP);
+
+
+	/**
+	 *  process_shortcode
+	 *  this method is the callback function for the actual shortcode, and is what runs when WP encounters the
+	 *  shortcode within the_content
+	 *
+	 * @param array|string $attributes
+	 * @return mixed
+	 */
+	abstract public function process_shortcode($attributes = []);
+
+
+	/**
+	 *    instance - returns instance of child class object
+	 *
+	 * @param string|null $shortcode_class
+	 * @return EES_Shortcode
+	 */
+	final public static function instance(string $shortcode_class = ''): ?EES_Shortcode
+	{
+		$shortcode_class = ! empty($shortcode_class) ? $shortcode_class : get_called_class();
+		if ($shortcode_class === 'EES_Shortcode' || empty($shortcode_class)) {
+			return null;
+		}
+		$shortcode     = LegacyShortcodesManager::generateShortcodeTagFromClassName($shortcode_class);
+		$shortcode_obj = isset(EE_Registry::instance()->shortcodes->{$shortcode})
+			? EE_Registry::instance()->shortcodes->{$shortcode}
+			: null;
+		return $shortcode_obj instanceof $shortcode_class || $shortcode_class === 'self'
+			? $shortcode_obj
+			: new $shortcode_class();
+	}
+
+
+	/**
+	 *    fallback_shortcode_processor - create instance and call process_shortcode
+	 *    NOTE: shortcode may not function perfectly dues to missing assets, but it's better than not having things
+	 *    work at all
+	 *
+	 * @param array|string $attributes
+	 * @return mixed
+	 */
+	final public static function fallback_shortcode_processor($attributes = null)
+	{
+		if (EE_Maintenance_Mode::disable_frontend_for_maintenance()) {
+			return null;
+		}
+		// what shortcode was actually parsed ?
+		$shortcode_class = get_called_class();
+		// notify rest of system that fallback processor was triggered
+		add_filter('FHEE__fallback_shortcode_processor__' . $shortcode_class, '__return_true');
+		// get instance of actual shortcode
+		$shortcode_obj = self::instance($shortcode_class);
+		// verify class
+		if ($shortcode_obj instanceof EES_Shortcode) {
+			global $wp;
+			$shortcode_obj->run($wp);
+			// set attributes and run the shortcode
+			$shortcode_obj->_attributes = (array) $attributes;
+			return $shortcode_obj->process_shortcode($shortcode_obj->_attributes);
+		}
+		return null;
+	}
+
+
+	/**
+	 *    invalid_shortcode_processor -  used in cases where we know the shortcode is invalid, most likely due to a
+	 *    deactivated addon, and simply returns an empty string
+	 *
+	 * @param $attributes
+	 * @return string
+	 */
+	final public static function invalid_shortcode_processor($attributes): string
+	{
+		return '';
+	}
+
+
+	/**
+	 * 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 by supplying an array for the $custom_sanitization param,
+	 * 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 pass the following for your $custom_sanitization array:
+	 *      array('event_id' => 'absint')
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @param array $custom_sanitization
+	 * @return array
+	 */
+	public static function sanitize_attributes(array $attributes, array $custom_sanitization = []): array
+	{
+		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;
+				} elseif (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, [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 ] = EES_Shortcode::sanitize_attributes($value);
+					break;
+				default:
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[ $key ] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
 }

core/services/locators/FqcnLocator.php

Indentation +142 added lines, -142 removed lines

@@ -18,146 +18,146 @@
  */
 class FqcnLocator extends Locator
 {
-    protected array $FQCNs      = [];
-
-    protected array $namespaces = [];
-
-
-    /**
-     * @param string|null $namespace
-     * @param string|null $namespace_base_dir
-     */
-    protected function setNamespace(?string $namespace, ?string $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getFQCNs(): array
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function count(): int
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @param string|array $namespaces
-     * @return array
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function locate($namespaces): array
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @param string $partial_namespace
-     * @return array
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function findFQCNsByNamespace(string $partial_namespace): array
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        $iterator->setFlags(FilesystemIterator::CURRENT_AS_FILEINFO);
-        $iterator->setFlags(FilesystemIterator::UNIX_PATHS);
-        if (iterator_count($iterator) === 0) {
-            return [];
-        }
-        foreach ($iterator as $file) {
-            if ($file->isFile() && $file->getExtension() === 'php') {
-                $file = $file->getPath() . '/' . $file->getBasename('.php');
-                foreach ($this->namespaces as $namespace => $base_dir) {
-                    $namespace .= Psr4Autoloader::NS;
-                    if (strpos($file, $base_dir) === 0) {
-                        $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                                [$base_dir, '/'],
-                                [$namespace, Psr4Autoloader::NS],
-                                $file
-                            );
-                    }
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @param string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws EE_Error
-     */
-    protected function getDirectoryFromPartialNamespace(string $partial_namespace): string
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments so we can loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the Vendor and secondary base, so pull those from the array
-        $vendor_base = array_slice($namespace_segments, 0, 2);
-        $namespace   = $prefix = null;
-        while (! empty($vendor_base)) {
-            $namespace = implode(Psr4Autoloader::NS, $vendor_base);
-            // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-            if (! empty($prefix) && ! empty($prefix[0])) {
-                // found one!
-                break;
-            }
-            // remove base and try vendor only portion of namespace
-            array_pop($vendor_base);
-        }
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode('/', array_diff($namespace_segments, $vendor_base)) . '/';
-    }
+	protected array $FQCNs      = [];
+
+	protected array $namespaces = [];
+
+
+	/**
+	 * @param string|null $namespace
+	 * @param string|null $namespace_base_dir
+	 */
+	protected function setNamespace(?string $namespace, ?string $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getFQCNs(): array
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function count(): int
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @param string|array $namespaces
+	 * @return array
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function locate($namespaces): array
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @param string $partial_namespace
+	 * @return array
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function findFQCNsByNamespace(string $partial_namespace): array
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		$iterator->setFlags(FilesystemIterator::CURRENT_AS_FILEINFO);
+		$iterator->setFlags(FilesystemIterator::UNIX_PATHS);
+		if (iterator_count($iterator) === 0) {
+			return [];
+		}
+		foreach ($iterator as $file) {
+			if ($file->isFile() && $file->getExtension() === 'php') {
+				$file = $file->getPath() . '/' . $file->getBasename('.php');
+				foreach ($this->namespaces as $namespace => $base_dir) {
+					$namespace .= Psr4Autoloader::NS;
+					if (strpos($file, $base_dir) === 0) {
+						$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+								[$base_dir, '/'],
+								[$namespace, Psr4Autoloader::NS],
+								$file
+							);
+					}
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @param string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 */
+	protected function getDirectoryFromPartialNamespace(string $partial_namespace): string
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments so we can loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the Vendor and secondary base, so pull those from the array
+		$vendor_base = array_slice($namespace_segments, 0, 2);
+		$namespace   = $prefix = null;
+		while (! empty($vendor_base)) {
+			$namespace = implode(Psr4Autoloader::NS, $vendor_base);
+			// check if there's a base directory registered for that namespace
+			$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+			if (! empty($prefix) && ! empty($prefix[0])) {
+				// found one!
+				break;
+			}
+			// remove base and try vendor only portion of namespace
+			array_pop($vendor_base);
+		}
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode('/', array_diff($namespace_segments, $vendor_base)) . '/';
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -29,13 +29,13 @@ 
      */
     protected function setNamespace(?string $namespace, ?string $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -68,12 +68,12 @@ 
      */
     public function locate($namespaces): array
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->findFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -103,11 +103,11 @@ 
         }
         foreach ($iterator as $file) {
             if ($file->isFile() && $file->getExtension() === 'php') {
-                $file = $file->getPath() . '/' . $file->getBasename('.php');
+                $file = $file->getPath().'/'.$file->getBasename('.php');
                 foreach ($this->namespaces as $namespace => $base_dir) {
                     $namespace .= Psr4Autoloader::NS;
                     if (strpos($file, $base_dir) === 0) {
-                        $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                        $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                                 [$base_dir, '/'],
                                 [$namespace, Psr4Autoloader::NS],
                                 $file
@@ -141,11 +141,11 @@ 
         // we're only interested in the Vendor and secondary base, so pull those from the array
         $vendor_base = array_slice($namespace_segments, 0, 2);
         $namespace   = $prefix = null;
-        while (! empty($vendor_base)) {
+        while ( ! empty($vendor_base)) {
             $namespace = implode(Psr4Autoloader::NS, $vendor_base);
             // check if there's a base directory registered for that namespace
-            $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-            if (! empty($prefix) && ! empty($prefix[0])) {
+            $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
+            if ( ! empty($prefix) && ! empty($prefix[0])) {
                 // found one!
                 break;
             }
@@ -158,6 +158,6 @@ 
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode('/', array_diff($namespace_segments, $vendor_base)) . '/';
+        return $prefix[0].implode('/', array_diff($namespace_segments, $vendor_base)).'/';
     }
 }

core/services/graphql/GraphQLEndpoint.php

Indentation +65 added lines, -65 removed lines

@@ -18,79 +18,79 @@
  */
 class GraphQLEndpoint extends WordPressOption
 {
-    const DEFAULT_ENDPOINT = 'graphql';
+	const DEFAULT_ENDPOINT = 'graphql';
 
-    const OPTION_NAME      = 'ee-graphql-endpoint';
+	const OPTION_NAME      = 'ee-graphql-endpoint';
 
-    private bool $is_gql_request = false;
+	private bool $is_gql_request = false;
 
 
-    /**
-     * GraphQLEndpoint constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct(GraphQLEndpoint::OPTION_NAME, GraphQLEndpoint::DEFAULT_ENDPOINT, true);
-        add_action('graphql_register_settings', [$this, 'verifyAndSetEndpoint'], 20);
-        if (! defined('GRAPHQL_DEBUG') || ! GRAPHQL_DEBUG) {
-            // disable WPGraphQL admin by default.
-            add_filter('graphql_show_admin', '__return_false');
-            add_filter('graphql_enable_graphiql', '__return_false');
-        }
-    }
+	/**
+	 * GraphQLEndpoint constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct(GraphQLEndpoint::OPTION_NAME, GraphQLEndpoint::DEFAULT_ENDPOINT, true);
+		add_action('graphql_register_settings', [$this, 'verifyAndSetEndpoint'], 20);
+		if (! defined('GRAPHQL_DEBUG') || ! GRAPHQL_DEBUG) {
+			// disable WPGraphQL admin by default.
+			add_filter('graphql_show_admin', '__return_false');
+			add_filter('graphql_enable_graphiql', '__return_false');
+		}
+	}
 
 
-    /**
-     * @return false|mixed|void
-     */
-    public function getEndpoint()
-    {
-        return $this->loadOption();
-    }
+	/**
+	 * @return false|mixed|void
+	 */
+	public function getEndpoint()
+	{
+		return $this->loadOption();
+	}
 
 
-    /**
-     * @return mixed|void|bool
-     */
-    public function isGraphqlRequest()
-    {
-        if (! isset($this->is_gql_request)) {
-            // grab the GQL endpoint that we saved in the future... wait... wut?
-            $endpoint = $this->getEndpoint();
-            // set our saved endpoint on the WP GQL Pouter class
-            // don't worry, this is a static property that they overwrite when they initialize things,
-            // and we are essentially getting the value from them anyways, so it should be ok (fingers crossed)
-            Router::$route = $endpoint;
-            // now call their function for checking if this is a GQL request
-            // because they use a bunch of filters and stuff we don't want to duplicate here
-            $this->is_gql_request = Router::is_graphql_http_request();
-        }
-        return $this->is_gql_request;
-    }
+	/**
+	 * @return mixed|void|bool
+	 */
+	public function isGraphqlRequest()
+	{
+		if (! isset($this->is_gql_request)) {
+			// grab the GQL endpoint that we saved in the future... wait... wut?
+			$endpoint = $this->getEndpoint();
+			// set our saved endpoint on the WP GQL Pouter class
+			// don't worry, this is a static property that they overwrite when they initialize things,
+			// and we are essentially getting the value from them anyways, so it should be ok (fingers crossed)
+			Router::$route = $endpoint;
+			// now call their function for checking if this is a GQL request
+			// because they use a bunch of filters and stuff we don't want to duplicate here
+			$this->is_gql_request = Router::is_graphql_http_request();
+		}
+		return $this->is_gql_request;
+	}
 
 
-    /**
-     * callback hooked into the graphql_register_settings action
-     * basically grabs the value for the 'graphql_endpoint' setting and saves it to our own WP option.
-     * i know, i know, i know...
-     * WHY are we saving the graphql_endpoint to a WP option if WP GraphQL is already doing the same ?!?!
-     * Because we perform our request type detection during `plugins_loaded`,
-     * but they don't settle on their endpoint until `after_setup_theme` has run,
-     * which is too late for us, so we are just going to save this separately so that we have it.
-     * Oh, and this will essentially recheck this value on EVERY request
-     * but will only update our saved value if it has actually changed
-     */
-    public function verifyAndSetEndpoint()
-    {
-        try {
-            $this->updateOption(
-                get_graphql_setting(
-                    'graphql_endpoint',
-                    apply_filters('graphql_endpoint', GraphQLEndpoint::DEFAULT_ENDPOINT)
-                )
-            );
-        } catch (Throwable $t) {
-            // eat it
-        }
-    }
+	/**
+	 * callback hooked into the graphql_register_settings action
+	 * basically grabs the value for the 'graphql_endpoint' setting and saves it to our own WP option.
+	 * i know, i know, i know...
+	 * WHY are we saving the graphql_endpoint to a WP option if WP GraphQL is already doing the same ?!?!
+	 * Because we perform our request type detection during `plugins_loaded`,
+	 * but they don't settle on their endpoint until `after_setup_theme` has run,
+	 * which is too late for us, so we are just going to save this separately so that we have it.
+	 * Oh, and this will essentially recheck this value on EVERY request
+	 * but will only update our saved value if it has actually changed
+	 */
+	public function verifyAndSetEndpoint()
+	{
+		try {
+			$this->updateOption(
+				get_graphql_setting(
+					'graphql_endpoint',
+					apply_filters('graphql_endpoint', GraphQLEndpoint::DEFAULT_ENDPOINT)
+				)
+			);
+		} catch (Throwable $t) {
+			// eat it
+		}
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     {
         parent::__construct(GraphQLEndpoint::OPTION_NAME, GraphQLEndpoint::DEFAULT_ENDPOINT, true);
         add_action('graphql_register_settings', [$this, 'verifyAndSetEndpoint'], 20);
-        if (! defined('GRAPHQL_DEBUG') || ! GRAPHQL_DEBUG) {
+        if ( ! defined('GRAPHQL_DEBUG') || ! GRAPHQL_DEBUG) {
             // disable WPGraphQL admin by default.
             add_filter('graphql_show_admin', '__return_false');
             add_filter('graphql_enable_graphiql', '__return_false');
@@ -54,7 +54,7 @@ 
      */
     public function isGraphqlRequest()
     {
-        if (! isset($this->is_gql_request)) {
+        if ( ! isset($this->is_gql_request)) {
             // grab the GQL endpoint that we saved in the future... wait... wut?
             $endpoint = $this->getEndpoint();
             // set our saved endpoint on the WP GQL Pouter class

core/services/form/meta/Attributes.php

Indentation +180 added lines, -180 removed lines

@@ -16,184 +16,184 @@
  */
 class Attributes implements JsonableInterface
 {
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
-
-    /**
-     * @var InputTypes
-     */
-    private $input_types;
-
-    /**
-     * @var array
-     */
-    private $attributes = [];
-
-    /**
-     * @var array
-     */
-    private $attribute_types = [
-        'accept'          => 'string',
-        'accesskey'       => 'string',
-        'alt'             => 'string',
-        'autocomplete'    => 'bool',
-        'autofocus'       => 'bool',
-        'checked'         => 'bool',
-        // Custom HTML classes to be applied to the form input's container
-        'class'           => 'string',
-        'contenteditable' => 'bool',
-        'dir'             => 'string',
-        'disabled'        => 'bool',
-        'height'          => 'string',
-        'hidden'          => 'bool',
-        'id'              => 'string',
-        'list'            => 'string',
-        // Maximum numeric value allowed for form input answer.
-        'max'             => 'int',
-        // Maximum characters allowed for form input answer.
-        'maxlength'       => 'int',
-        // Minimum numeric value allowed for form input answer.
-        'min'             => 'int',
-        'multiple'        => 'bool',
-        'name'            => 'string',
-        'pattern'         => 'string',
-        // Example text displayed within an input to assist users with completing the form.
-        'placeholder'     => 'string',
-        'readonly'        => 'bool',
-        'size'            => 'int',
-        'spellcheck'      => 'bool',
-        'step'            => 'float',
-        'style'           => 'string',
-        'tabindex'        => 'int',
-        'title'           => 'string',
-        'translate'       => 'bool',
-        // Form input type. Values correspond to the Input::TYPE_* constants.
-        'type'            => 'string',
-        'value'           => 'string',
-        'width'           => 'string',
-    ];
-
-
-    /**
-     * Attributes constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param InputTypes      $element_types
-     * @param array           $attributes
-     */
-    public function __construct(JsonDataHandler $json_data_handler, array $attributes, InputTypes $element_types)
-    {
-        $this->json_data_handler = $json_data_handler;
-        $this->input_types       = $element_types;
-        $this->setAttributes($attributes);
-    }
-
-
-    /**
-     * @param string $json
-     * @return Attributes
-     */
-    public static function fromJson(string $json): Attributes
-    {
-        $json_data_handler = new JsonDataHandler();
-        $json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
-        $attributes = $json_data_handler->decodeJson($json);
-        /** @var InputTypes */
-        $element_types = LoaderFactory::getShared('EventEspresso\core\services\form\meta\InputTypes');
-        return LoaderFactory::getNew(Attributes::class, [$json_data_handler, (array) $attributes, $element_types]);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return $this->attributes();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function toJson(): string
-    {
-        return $this->json_data_handler->encodeData($this->attributes());
-    }
-
-
-    /**
-     * @param string                $attribute
-     * @param bool|float|int|string $value
-     * @return bool|float|int|string
-     */
-    private function sanitize(string $attribute, $value)
-    {
-        if ($attribute === 'type') {
-            $valid_types = $this->input_types->validTypeOptions();
-            return in_array($value, $valid_types, true) ?: Text::TYPE_TEXT;
-        }
-        $type = $this->attribute_types[ $attribute ] ?? 'string';
-        switch ($type) {
-            case 'bool':
-                return filter_var($value, FILTER_VALIDATE_BOOLEAN);
-            case 'int':
-                return filter_var($value, FILTER_SANITIZE_NUMBER_INT);
-            case 'float':
-                return filter_var($value, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
-            case 'string':
-            default:
-                return filter_var(
-                    $value,
-                    FILTER_SANITIZE_STRING,
-                    FILTER_FLAG_ENCODE_LOW | FILTER_FLAG_ENCODE_HIGH | FILTER_FLAG_ENCODE_AMP
-                );
-        }
-    }
-
-
-    /**
-     * Custom HTML classes to be applied to this form input's help text.
-     * returns a concatenated string unless $as_array is set to true
-     *
-     * @return array
-     */
-    public function attributes(): array
-    {
-        return $this->attributes;
-    }
-
-
-    /**
-     * @param string                $attribute
-     * @param bool|float|int|string $value
-     */
-    public function addAttribute(string $attribute, $value): void
-    {
-        if (array_key_exists($attribute, $this->attribute_types)) {
-            $this->attributes[ $attribute ] = $this->sanitize($attribute, $value);
-        }
-    }
-
-
-    /**
-     * @param string $attribute
-     */
-    public function removeAttribute(string $attribute): void
-    {
-        unset($this->attributes[ $attribute ]);
-    }
-
-
-    /**
-     * @param array $attributes array where keys are the attribute name and values are the attribute's value
-     */
-    public function setAttributes(array $attributes): void
-    {
-        foreach ($attributes as $attribute => $value) {
-            $this->addAttribute($attribute, $value);
-        }
-    }
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
+
+	/**
+	 * @var InputTypes
+	 */
+	private $input_types;
+
+	/**
+	 * @var array
+	 */
+	private $attributes = [];
+
+	/**
+	 * @var array
+	 */
+	private $attribute_types = [
+		'accept'          => 'string',
+		'accesskey'       => 'string',
+		'alt'             => 'string',
+		'autocomplete'    => 'bool',
+		'autofocus'       => 'bool',
+		'checked'         => 'bool',
+		// Custom HTML classes to be applied to the form input's container
+		'class'           => 'string',
+		'contenteditable' => 'bool',
+		'dir'             => 'string',
+		'disabled'        => 'bool',
+		'height'          => 'string',
+		'hidden'          => 'bool',
+		'id'              => 'string',
+		'list'            => 'string',
+		// Maximum numeric value allowed for form input answer.
+		'max'             => 'int',
+		// Maximum characters allowed for form input answer.
+		'maxlength'       => 'int',
+		// Minimum numeric value allowed for form input answer.
+		'min'             => 'int',
+		'multiple'        => 'bool',
+		'name'            => 'string',
+		'pattern'         => 'string',
+		// Example text displayed within an input to assist users with completing the form.
+		'placeholder'     => 'string',
+		'readonly'        => 'bool',
+		'size'            => 'int',
+		'spellcheck'      => 'bool',
+		'step'            => 'float',
+		'style'           => 'string',
+		'tabindex'        => 'int',
+		'title'           => 'string',
+		'translate'       => 'bool',
+		// Form input type. Values correspond to the Input::TYPE_* constants.
+		'type'            => 'string',
+		'value'           => 'string',
+		'width'           => 'string',
+	];
+
+
+	/**
+	 * Attributes constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param InputTypes      $element_types
+	 * @param array           $attributes
+	 */
+	public function __construct(JsonDataHandler $json_data_handler, array $attributes, InputTypes $element_types)
+	{
+		$this->json_data_handler = $json_data_handler;
+		$this->input_types       = $element_types;
+		$this->setAttributes($attributes);
+	}
+
+
+	/**
+	 * @param string $json
+	 * @return Attributes
+	 */
+	public static function fromJson(string $json): Attributes
+	{
+		$json_data_handler = new JsonDataHandler();
+		$json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
+		$attributes = $json_data_handler->decodeJson($json);
+		/** @var InputTypes */
+		$element_types = LoaderFactory::getShared('EventEspresso\core\services\form\meta\InputTypes');
+		return LoaderFactory::getNew(Attributes::class, [$json_data_handler, (array) $attributes, $element_types]);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return $this->attributes();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function toJson(): string
+	{
+		return $this->json_data_handler->encodeData($this->attributes());
+	}
+
+
+	/**
+	 * @param string                $attribute
+	 * @param bool|float|int|string $value
+	 * @return bool|float|int|string
+	 */
+	private function sanitize(string $attribute, $value)
+	{
+		if ($attribute === 'type') {
+			$valid_types = $this->input_types->validTypeOptions();
+			return in_array($value, $valid_types, true) ?: Text::TYPE_TEXT;
+		}
+		$type = $this->attribute_types[ $attribute ] ?? 'string';
+		switch ($type) {
+			case 'bool':
+				return filter_var($value, FILTER_VALIDATE_BOOLEAN);
+			case 'int':
+				return filter_var($value, FILTER_SANITIZE_NUMBER_INT);
+			case 'float':
+				return filter_var($value, FILTER_SANITIZE_NUMBER_FLOAT, FILTER_FLAG_ALLOW_FRACTION);
+			case 'string':
+			default:
+				return filter_var(
+					$value,
+					FILTER_SANITIZE_STRING,
+					FILTER_FLAG_ENCODE_LOW | FILTER_FLAG_ENCODE_HIGH | FILTER_FLAG_ENCODE_AMP
+				);
+		}
+	}
+
+
+	/**
+	 * Custom HTML classes to be applied to this form input's help text.
+	 * returns a concatenated string unless $as_array is set to true
+	 *
+	 * @return array
+	 */
+	public function attributes(): array
+	{
+		return $this->attributes;
+	}
+
+
+	/**
+	 * @param string                $attribute
+	 * @param bool|float|int|string $value
+	 */
+	public function addAttribute(string $attribute, $value): void
+	{
+		if (array_key_exists($attribute, $this->attribute_types)) {
+			$this->attributes[ $attribute ] = $this->sanitize($attribute, $value);
+		}
+	}
+
+
+	/**
+	 * @param string $attribute
+	 */
+	public function removeAttribute(string $attribute): void
+	{
+		unset($this->attributes[ $attribute ]);
+	}
+
+
+	/**
+	 * @param array $attributes array where keys are the attribute name and values are the attribute's value
+	 */
+	public function setAttributes(array $attributes): void
+	{
+		foreach ($attributes as $attribute => $value) {
+			$this->addAttribute($attribute, $value);
+		}
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -135,7 +135,7 @@ 
             $valid_types = $this->input_types->validTypeOptions();
             return in_array($value, $valid_types, true) ?: Text::TYPE_TEXT;
         }
-        $type = $this->attribute_types[ $attribute ] ?? 'string';
+        $type = $this->attribute_types[$attribute] ?? 'string';
         switch ($type) {
             case 'bool':
                 return filter_var($value, FILTER_VALIDATE_BOOLEAN);
@@ -173,7 +173,7 @@ 
     public function addAttribute(string $attribute, $value): void
     {
         if (array_key_exists($attribute, $this->attribute_types)) {
-            $this->attributes[ $attribute ] = $this->sanitize($attribute, $value);
+            $this->attributes[$attribute] = $this->sanitize($attribute, $value);
         }
     }
 
@@ -183,7 +183,7 @@ 
      */
     public function removeAttribute(string $attribute): void
     {
-        unset($this->attributes[ $attribute ]);
+        unset($this->attributes[$attribute]);
     }
 
 

core/services/form/meta/InputOptions.php

Indentation +102 added lines, -102 removed lines

@@ -14,106 +14,106 @@
  */
 class InputOptions implements JsonableInterface
 {
-    /**
-     * @var JsonDataHandler
-     */
-    private $json_data_handler;
-
-    /**
-     * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
-     *
-     * @var array
-     */
-    private $options = [];
-
-
-    /**
-     * HelpText constructor.
-     *
-     * @param JsonDataHandler $json_data_handler
-     * @param array           $options
-     */
-    public function __construct(JsonDataHandler $json_data_handler, array $options)
-    {
-        $this->json_data_handler = $json_data_handler;
-        $this->setOptions($options);
-    }
-
-
-    /**
-     * @param string $json
-     * @return InputOptions
-     */
-    public static function fromJson(string $json): InputOptions
-    {
-        $json_data_handler = new JsonDataHandler();
-        $json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
-        $data = $json_data_handler->decodeJson($json);
-        return new InputOptions($json_data_handler, (array) $data ?? []);
-    }
-
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        return array_values($this->options);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function toJson(): string
-    {
-        return $this->json_data_handler->encodeData($this->toArray());
-    }
-
-
-    /**
-     * an array where keys are option values and values are option labels
-     *
-     * @return array
-     */
-    public function options(): array
-    {
-        return $this->options;
-    }
-
-
-    /**
-     * @param array $option
-     */
-    public function addOption(array $option): void
-    {
-        if (isset($option['label'], $option['value'])) {
-            $label = sanitize_text_field($option['label']);
-            $value = sanitize_key($option['value']);
-
-            // use `value` as key
-            $this->options[ $value ] = compact('label', 'value');
-        }
-    }
-
-
-    /**
-     * @param int|float|string $option_value
-     */
-    public function removeOption(string $option_value): void
-    {
-        $option_value = sanitize_key($option_value);
-        unset($this->options[ $option_value ]);
-    }
-
-
-    /**
-     * @param array $options an array where keys are option values and values are option labels
-     */
-    public function setOptions(array $options): void
-    {
-        foreach ($options as $option) {
-            $this->addOption((array) $option);
-        }
-    }
+	/**
+	 * @var JsonDataHandler
+	 */
+	private $json_data_handler;
+
+	/**
+	 * Options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc
+	 *
+	 * @var array
+	 */
+	private $options = [];
+
+
+	/**
+	 * HelpText constructor.
+	 *
+	 * @param JsonDataHandler $json_data_handler
+	 * @param array           $options
+	 */
+	public function __construct(JsonDataHandler $json_data_handler, array $options)
+	{
+		$this->json_data_handler = $json_data_handler;
+		$this->setOptions($options);
+	}
+
+
+	/**
+	 * @param string $json
+	 * @return InputOptions
+	 */
+	public static function fromJson(string $json): InputOptions
+	{
+		$json_data_handler = new JsonDataHandler();
+		$json_data_handler->configure(JsonDataHandler::DATA_TYPE_ARRAY);
+		$data = $json_data_handler->decodeJson($json);
+		return new InputOptions($json_data_handler, (array) $data ?? []);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function toArray(): array
+	{
+		return array_values($this->options);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function toJson(): string
+	{
+		return $this->json_data_handler->encodeData($this->toArray());
+	}
+
+
+	/**
+	 * an array where keys are option values and values are option labels
+	 *
+	 * @return array
+	 */
+	public function options(): array
+	{
+		return $this->options;
+	}
+
+
+	/**
+	 * @param array $option
+	 */
+	public function addOption(array $option): void
+	{
+		if (isset($option['label'], $option['value'])) {
+			$label = sanitize_text_field($option['label']);
+			$value = sanitize_key($option['value']);
+
+			// use `value` as key
+			$this->options[ $value ] = compact('label', 'value');
+		}
+	}
+
+
+	/**
+	 * @param int|float|string $option_value
+	 */
+	public function removeOption(string $option_value): void
+	{
+		$option_value = sanitize_key($option_value);
+		unset($this->options[ $option_value ]);
+	}
+
+
+	/**
+	 * @param array $options an array where keys are option values and values are option labels
+	 */
+	public function setOptions(array $options): void
+	{
+		foreach ($options as $option) {
+			$this->addOption((array) $option);
+		}
+	}
 }

core/services/request/DataType.php

Indentation +44 added lines, -44 removed lines

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

core/services/request/CurrentPage.php

Indentation +295 added lines, -295 removed lines

@@ -22,299 +22,299 @@
  */
 class CurrentPage
 {
-    private EE_CPT_Strategy  $cpt_strategy;
-
-    private bool             $initialized;
-
-    private ?bool            $is_espresso_page = null;
-
-    private int              $post_id          = 0;
-
-    private string           $post_name        = '';
-
-    private array            $post_type        = [];
-
-    private RequestInterface $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);
-    }
-
-
-    /**
-     * @param WP|null $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, 'parseQueryVars'], 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): string
-    {
-        $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(): array
-    {
-        return array_filter(
-            $this->post_type,
-            function ($post_type) {
-                return strpos($post_type, 'espresso_') === 0;
-            }
-        );
-    }
-
-
-    /**
-     * pokes and prods the WP object query_vars in an attempt to shake out a page/post ID
-     *
-     * @param WP|null $WP $WP
-     * @return int
-     */
-    private function getPostId(WP $WP = null): ?int
-    {
-        $post_id = 0;
-        if ($WP instanceof WP) {
-            // look for the post ID in the aptly named 'p' query var
-            if (isset($WP->query_vars['p'])) {
-                $post_id = $WP->query_vars['p'];
-            }
-            // not a post? what about a page?
-            if (! $post_id && isset($WP->query_vars['page_id'])) {
-                $post_id = $WP->query_vars['page_id'];
-            }
-            // ok... maybe pretty permalinks are off and the ID is set in the raw request...
-            // but hasn't been processed yet ie: this method is being called too early :\
-            if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
-                $post_id = basename($WP->request);
-            }
-        }
-        // none of the above? ok what about an explicit "post_id" URL parameter?
-        if (! $post_id && $this->request->requestParamIsSet('post_id')) {
-            $post_id = $this->request->getRequestParam('post_id', 0, DataType::INT);
-        }
-        return (int) $post_id;
-    }
-
-
-    /**
-     * similar to getPostId() above but attempts to obtain the "name" for the current page/post
-     *
-     * @param WP|null $WP $WP
-     * @return string|null
-     */
-    private function getPostName(WP $WP = null): ?string
-    {
-        global $wpdb;
-        $post_name = '';
-        if ($WP instanceof WP) {
-            // if this is a post, then is the post name set?
-            if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
-                $post_name = is_array($WP->query_vars['name']) ? $WP->query_vars['name'][0] : $WP->query_vars['name'];
-            }
-            // what about the page name?
-            if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
-                $post_name = is_array($WP->query_vars['pagename']) ? $WP->query_vars['pagename'][0]
-                    : $WP->query_vars['pagename'];
-            }
-            // this stinks but let's run a query to try and get the post name from the URL
-            // (assuming pretty permalinks are on)
-            if (! $post_name && ! 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;
-                    }
-                }
-            }
-        }
-        // ug... ok... nothing yet... but do we have a post ID?
-        // if so then... sigh... run a query to get the 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;
-            }
-        }
-        // still nothing? ok what about an explicit 'post_name' URL parameter?
-        if (! $post_name && $this->request->requestParamIsSet('post_name')) {
-            $post_name = $this->request->getRequestParam('post_name');
-        }
-        return $post_name;
-    }
-
-
-    /**
-     * also similar to getPostId() and getPostName() above but not as insane
-     *
-     * @param WP|null $WP $WP
-     * @return array
-     */
-    private function getPostType(WP $WP = null): array
-    {
-        $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', [], DataType::STRING, true);
-        }
-        return (array) $post_types;
-    }
-
-
-    /**
-     * if TRUE, then the current page is somehow utilizing EE logic
-     *
-     * @return bool
-     */
-    public function isEspressoPage(): bool
-    {
-        if ($this->is_espresso_page === null) {
-            $this->setEspressoPage();
-        }
-        return $this->is_espresso_page;
-    }
-
-
-    /**
-     * @return int
-     */
-    public function postId(): int
-    {
-        return $this->post_id;
-    }
-
-
-    /**
-     * @return string|null
-     */
-    public function postName(): ?string
-    {
-        return $this->post_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postType(): array
-    {
-        return $this->post_type;
-    }
-
-
-    /**
-     * for manually indicating the current page will utilize EE logic
-     *
-     * @param bool|int|string|null $value
-     * @return void
-     */
-    public function setEspressoPage($value = null)
-    {
-        $this->is_espresso_page = $value !== null
-            ? filter_var($value, FILTER_VALIDATE_BOOLEAN)
-            : $this->testForEspressoPage();
-    }
-
-
-    /**
-     * attempts to determine if the current page/post is an EE related page/post
-     * because it utilizes one of our CPT taxonomies, endpoints, or post types
-     *
-     * @return bool
-     */
-    private function testForEspressoPage(): bool
-    {
-        // 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 = $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;
-    }
+	private EE_CPT_Strategy  $cpt_strategy;
+
+	private bool             $initialized;
+
+	private ?bool            $is_espresso_page = null;
+
+	private int              $post_id          = 0;
+
+	private string           $post_name        = '';
+
+	private array            $post_type        = [];
+
+	private RequestInterface $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);
+	}
+
+
+	/**
+	 * @param WP|null $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, 'parseQueryVars'], 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): string
+	{
+		$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(): array
+	{
+		return array_filter(
+			$this->post_type,
+			function ($post_type) {
+				return strpos($post_type, 'espresso_') === 0;
+			}
+		);
+	}
+
+
+	/**
+	 * pokes and prods the WP object query_vars in an attempt to shake out a page/post ID
+	 *
+	 * @param WP|null $WP $WP
+	 * @return int
+	 */
+	private function getPostId(WP $WP = null): ?int
+	{
+		$post_id = 0;
+		if ($WP instanceof WP) {
+			// look for the post ID in the aptly named 'p' query var
+			if (isset($WP->query_vars['p'])) {
+				$post_id = $WP->query_vars['p'];
+			}
+			// not a post? what about a page?
+			if (! $post_id && isset($WP->query_vars['page_id'])) {
+				$post_id = $WP->query_vars['page_id'];
+			}
+			// ok... maybe pretty permalinks are off and the ID is set in the raw request...
+			// but hasn't been processed yet ie: this method is being called too early :\
+			if (! $post_id && $WP->request !== null && is_numeric(basename($WP->request))) {
+				$post_id = basename($WP->request);
+			}
+		}
+		// none of the above? ok what about an explicit "post_id" URL parameter?
+		if (! $post_id && $this->request->requestParamIsSet('post_id')) {
+			$post_id = $this->request->getRequestParam('post_id', 0, DataType::INT);
+		}
+		return (int) $post_id;
+	}
+
+
+	/**
+	 * similar to getPostId() above but attempts to obtain the "name" for the current page/post
+	 *
+	 * @param WP|null $WP $WP
+	 * @return string|null
+	 */
+	private function getPostName(WP $WP = null): ?string
+	{
+		global $wpdb;
+		$post_name = '';
+		if ($WP instanceof WP) {
+			// if this is a post, then is the post name set?
+			if (isset($WP->query_vars['name']) && ! empty($WP->query_vars['name'])) {
+				$post_name = is_array($WP->query_vars['name']) ? $WP->query_vars['name'][0] : $WP->query_vars['name'];
+			}
+			// what about the page name?
+			if (! $post_name && isset($WP->query_vars['pagename']) && ! empty($WP->query_vars['pagename'])) {
+				$post_name = is_array($WP->query_vars['pagename']) ? $WP->query_vars['pagename'][0]
+					: $WP->query_vars['pagename'];
+			}
+			// this stinks but let's run a query to try and get the post name from the URL
+			// (assuming pretty permalinks are on)
+			if (! $post_name && ! 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;
+					}
+				}
+			}
+		}
+		// ug... ok... nothing yet... but do we have a post ID?
+		// if so then... sigh... run a query to get the 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;
+			}
+		}
+		// still nothing? ok what about an explicit 'post_name' URL parameter?
+		if (! $post_name && $this->request->requestParamIsSet('post_name')) {
+			$post_name = $this->request->getRequestParam('post_name');
+		}
+		return $post_name;
+	}
+
+
+	/**
+	 * also similar to getPostId() and getPostName() above but not as insane
+	 *
+	 * @param WP|null $WP $WP
+	 * @return array
+	 */
+	private function getPostType(WP $WP = null): array
+	{
+		$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', [], DataType::STRING, true);
+		}
+		return (array) $post_types;
+	}
+
+
+	/**
+	 * if TRUE, then the current page is somehow utilizing EE logic
+	 *
+	 * @return bool
+	 */
+	public function isEspressoPage(): bool
+	{
+		if ($this->is_espresso_page === null) {
+			$this->setEspressoPage();
+		}
+		return $this->is_espresso_page;
+	}
+
+
+	/**
+	 * @return int
+	 */
+	public function postId(): int
+	{
+		return $this->post_id;
+	}
+
+
+	/**
+	 * @return string|null
+	 */
+	public function postName(): ?string
+	{
+		return $this->post_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postType(): array
+	{
+		return $this->post_type;
+	}
+
+
+	/**
+	 * for manually indicating the current page will utilize EE logic
+	 *
+	 * @param bool|int|string|null $value
+	 * @return void
+	 */
+	public function setEspressoPage($value = null)
+	{
+		$this->is_espresso_page = $value !== null
+			? filter_var($value, FILTER_VALIDATE_BOOLEAN)
+			: $this->testForEspressoPage();
+	}
+
+
+	/**
+	 * attempts to determine if the current page/post is an EE related page/post
+	 * because it utilizes one of our CPT taxonomies, endpoints, or post types
+	 *
+	 * @return bool
+	 */
+	private function testForEspressoPage(): bool
+	{
+		// 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 = $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 +15 added lines, -15 removed lines

@@ -63,7 +63,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);
@@ -88,7 +88,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) {
@@ -105,7 +105,7 @@ 
     {
         return array_filter(
             $this->post_type,
-            function ($post_type) {
+            function($post_type) {
                 return strpos($post_type, 'espresso_') === 0;
             }
         );
@@ -127,17 +127,17 @@ 
                 $post_id = $WP->query_vars['p'];
             }
             // not a post? what about a page?
-            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'];
             }
             // ok... maybe pretty permalinks are off and the ID is set in the raw request...
             // but hasn't been processed yet ie: this method is being called too early :\
-            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);
             }
         }
         // none of the above? ok what about an explicit "post_id" URL parameter?
-        if (! $post_id && $this->request->requestParamIsSet('post_id')) {
+        if ( ! $post_id && $this->request->requestParamIsSet('post_id')) {
             $post_id = $this->request->getRequestParam('post_id', 0, DataType::INT);
         }
         return (int) $post_id;
@@ -160,15 +160,15 @@ 
                 $post_name = is_array($WP->query_vars['name']) ? $WP->query_vars['name'][0] : $WP->query_vars['name'];
             }
             // what about the page 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 = is_array($WP->query_vars['pagename']) ? $WP->query_vars['pagename'][0]
                     : $WP->query_vars['pagename'];
             }
             // this stinks but let's run a query to try and get the post name from the URL
             // (assuming pretty permalinks are on)
-            if (! $post_name && ! empty($WP->request)) {
+            if ( ! $post_name && ! 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';
@@ -181,7 +181,7 @@ 
         }
         // ug... ok... nothing yet... but do we have a post ID?
         // if so then... sigh... run a query to get the post name :\
-        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';
@@ -191,7 +191,7 @@ 
             }
         }
         // still nothing? ok what about an explicit 'post_name' URL parameter?
-        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;
@@ -290,7 +290,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;
                 }
             }
@@ -300,13 +300,13 @@ 
         $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 = $post_type_CPT_endpoints[ $espresso_post_type ] ?? '';
+                    $post_name = $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;

core/services/request/sanitizers/RequestSanitizer.php

Indentation +78 added lines, -78 removed lines

@@ -8,88 +8,88 @@
 class RequestSanitizer
 {
 
-    private Basic $email_validator;
+	private Basic $email_validator;
 
 
-    /**
-     * @param Basic $email_validator
-     */
-    public function __construct(Basic $email_validator)
-    {
-        $this->email_validator = $email_validator;
-    }
+	/**
+	 * @param Basic $email_validator
+	 */
+	public function __construct(Basic $email_validator)
+	{
+		$this->email_validator = $email_validator;
+	}
 
 
-    /**
-     * 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", or "string"
-     * @param bool   $is_array  if true, then $param will be treated as an array of $type
-     * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
-     * @return array|bool|float|int|string
-     * @since 4.10.14.p
-     */
-    public function clean(
-        $param,
-        string $type = DataType::STRING,
-        bool $is_array = false,
-        string $delimiter = ''
-    ) {
-        if ($delimiter !== '' && is_string($param)) {
-            $param    = explode($delimiter, $param);
-            $is_array = is_array($param);
-            // unset the delimiter else this function will recurse forever when we loop over the array of results
-            $delimiter = '';
-        }
-        // check if we are getting an improperly typed array and correct
-        $is_array = $is_array && is_array($param);
-        if ($is_array) {
-            $values = [];
-            foreach ((array) $param as $key => $value) {
-                $values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
-            }
-            return $values;
-        }
-        return $this->sanitizeParam($param, $type);
-    }
+	/**
+	 * 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", or "string"
+	 * @param bool   $is_array  if true, then $param will be treated as an array of $type
+	 * @param string $delimiter if $param is a CSV like value (ex: 1,2,3,4,5...) then this is the value separator
+	 * @return array|bool|float|int|string
+	 * @since 4.10.14.p
+	 */
+	public function clean(
+		$param,
+		string $type = DataType::STRING,
+		bool $is_array = false,
+		string $delimiter = ''
+	) {
+		if ($delimiter !== '' && is_string($param)) {
+			$param    = explode($delimiter, $param);
+			$is_array = is_array($param);
+			// unset the delimiter else this function will recurse forever when we loop over the array of results
+			$delimiter = '';
+		}
+		// check if we are getting an improperly typed array and correct
+		$is_array = $is_array && is_array($param);
+		if ($is_array) {
+			$values = [];
+			foreach ((array) $param as $key => $value) {
+				$values[ $key ] = $this->clean($value, $type, is_array($value), $delimiter);
+			}
+			return $values;
+		}
+		return $this->sanitizeParam($param, $type);
+	}
 
 
-    /**
-     * @param mixed  $param
-     * @param string $type
-     * @return array|float|int|mixed|string|string[]|null
-     * @since   4.10.20.p
-     */
-    public function sanitizeParam($param, string $type = DataType::STRING)
-    {
-        switch ($type) {
-            case DataType::BOOL:
-                return filter_var($param, FILTER_VALIDATE_BOOLEAN);
-            case DataType::EDITOR:
-                $allowed_tags = AllowedTags::getWithFullTags();
-                return wp_kses($param, $allowed_tags);
-            case DataType::EMAIL:
-                return $this->email_validator->validate($param) ? $param : '';
-            case DataType::FLOAT:
-                return (float) $param;
-            case DataType::FQCN:
-                return preg_replace('[^\\\w\d]', '', $param);
-            case DataType::HTML:
-                $allowed_tags = AllowedTags::getAllowedTags();
-                return wp_kses($param, $allowed_tags);
-            case DataType::INT:
-                return (int) $param;
-            case DataType::KEY:
-                return sanitize_key($param);
-            case DataType::TITLE:
-                return sanitize_title($param);
-            case DataType::URL:
-                return esc_url_raw($param);
-            case DataType::STRING:
-            default:
-                return sanitize_text_field($param);
-        }
-    }
+	/**
+	 * @param mixed  $param
+	 * @param string $type
+	 * @return array|float|int|mixed|string|string[]|null
+	 * @since   4.10.20.p
+	 */
+	public function sanitizeParam($param, string $type = DataType::STRING)
+	{
+		switch ($type) {
+			case DataType::BOOL:
+				return filter_var($param, FILTER_VALIDATE_BOOLEAN);
+			case DataType::EDITOR:
+				$allowed_tags = AllowedTags::getWithFullTags();
+				return wp_kses($param, $allowed_tags);
+			case DataType::EMAIL:
+				return $this->email_validator->validate($param) ? $param : '';
+			case DataType::FLOAT:
+				return (float) $param;
+			case DataType::FQCN:
+				return preg_replace('[^\\\w\d]', '', $param);
+			case DataType::HTML:
+				$allowed_tags = AllowedTags::getAllowedTags();
+				return wp_kses($param, $allowed_tags);
+			case DataType::INT:
+				return (int) $param;
+			case DataType::KEY:
+				return sanitize_key($param);
+			case DataType::TITLE:
+				return sanitize_title($param);
+			case DataType::URL:
+				return esc_url_raw($param);
+			case DataType::STRING:
+			default:
+				return sanitize_text_field($param);
+		}
+	}
 }

core/services/request/ServerParams.php

Indentation +205 added lines, -205 removed lines

@@ -6,209 +6,209 @@
 
 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();
-    }
-
-
-    /**
-     * @param array $server
-     * @return array
-     */
-    private function cleanServerParams(array $server): array
-    {
-        $cleaned = [];
-        foreach ($server as $key => $value) {
-            $cleaned[ $key ] = $this->sanitizer->clean($key, $value);
-        }
-        return $cleaned;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getAllServerParams(): array
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * @param string     $key
-     * @param mixed|null $default
-     * @return array|int|float|string
-     */
-    public function getServerParam(string $key, $default = null)
-    {
-        return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
-    }
-
-
-    /**
-     * @param string                 $key
-     * @param array|int|float|string $value
-     * @param bool                   $set_global_too
-     * @return void
-     */
-    public function setServerParam(string $key, $value, bool $set_global_too = false)
-    {
-        $value                = $this->sanitizer->clean($key, $value);
-        $this->server[ $key ] = $value;
-        if ($set_global_too) {
-            $_SERVER[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * @param string $key
-     * @param bool   $unset_from_global_too
-     * @return void
-     */
-    public function unSetServerParam(string $key, bool $unset_from_global_too = false)
-    {
-        // because unset may not actually remove var
-        $this->server[ $key ] = null;
-        unset($this->server[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_SERVER[ $key ]);
-        }
-    }
-
-
-    /**
-     * @param string $key
-     * @return bool
-     */
-    public function serverParamIsSet(string $key): bool
-    {
-        return isset($this->server[ $key ]);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress(): string
-    {
-        return (string) $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @return string
-     */
-    private function setVisitorIp(): string
-    {
-        $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 ])) {
-                $potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
-                foreach ($potential_ip as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return (string) $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(bool $relativeToWpRoot = false): string
-    {
-        if ($relativeToWpRoot) {
-            $home_path = parse_url(home_url(), PHP_URL_PATH);
-            $home_path = trim((string) $home_path, '/');
-            $home_path = ! empty($home_path)
-                ? trailingslashit($home_path)
-                : $home_path;
-            return str_replace($home_path, '', (string) ($this->server['REQUEST_URI'] ?? ''));
-        }
-        return $this->server['REQUEST_URI'];
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent(): string
-    {
-        if (empty($this->user_agent)) {
-            $this->setUserAgent();
-        }
-        return (string) $this->user_agent;
-    }
-
-
-    /**
-     * @param string|null $user_agent
-     */
-    public function setUserAgent(?string $user_agent = '')
-    {
-        $this->user_agent = $user_agent === '' || ! is_string($user_agent)
-            ? (string) $this->getServerParam('HTTP_USER_AGENT', 'unknown')
-            : (string) 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();
+	}
+
+
+	/**
+	 * @param array $server
+	 * @return array
+	 */
+	private function cleanServerParams(array $server): array
+	{
+		$cleaned = [];
+		foreach ($server as $key => $value) {
+			$cleaned[ $key ] = $this->sanitizer->clean($key, $value);
+		}
+		return $cleaned;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getAllServerParams(): array
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * @param string     $key
+	 * @param mixed|null $default
+	 * @return array|int|float|string
+	 */
+	public function getServerParam(string $key, $default = null)
+	{
+		return $this->serverParamIsSet($key) ? $this->server[ $key ] : $default;
+	}
+
+
+	/**
+	 * @param string                 $key
+	 * @param array|int|float|string $value
+	 * @param bool                   $set_global_too
+	 * @return void
+	 */
+	public function setServerParam(string $key, $value, bool $set_global_too = false)
+	{
+		$value                = $this->sanitizer->clean($key, $value);
+		$this->server[ $key ] = $value;
+		if ($set_global_too) {
+			$_SERVER[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * @param string $key
+	 * @param bool   $unset_from_global_too
+	 * @return void
+	 */
+	public function unSetServerParam(string $key, bool $unset_from_global_too = false)
+	{
+		// because unset may not actually remove var
+		$this->server[ $key ] = null;
+		unset($this->server[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_SERVER[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @param string $key
+	 * @return bool
+	 */
+	public function serverParamIsSet(string $key): bool
+	{
+		return isset($this->server[ $key ]);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress(): string
+	{
+		return (string) $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @return string
+	 */
+	private function setVisitorIp(): string
+	{
+		$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 ])) {
+				$potential_ip = array_map('trim', explode(',', $this->server[ $key ]));
+				foreach ($potential_ip as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return (string) $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(bool $relativeToWpRoot = false): string
+	{
+		if ($relativeToWpRoot) {
+			$home_path = parse_url(home_url(), PHP_URL_PATH);
+			$home_path = trim((string) $home_path, '/');
+			$home_path = ! empty($home_path)
+				? trailingslashit($home_path)
+				: $home_path;
+			return str_replace($home_path, '', (string) ($this->server['REQUEST_URI'] ?? ''));
+		}
+		return $this->server['REQUEST_URI'];
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent(): string
+	{
+		if (empty($this->user_agent)) {
+			$this->setUserAgent();
+		}
+		return (string) $this->user_agent;
+	}
+
+
+	/**
+	 * @param string|null $user_agent
+	 */
+	public function setUserAgent(?string $user_agent = '')
+	{
+		$this->user_agent = $user_agent === '' || ! is_string($user_agent)
+			? (string) $this->getServerParam('HTTP_USER_AGENT', 'unknown')
+			: (string) esc_attr($user_agent);
+	}
 }