eventespresso / event-espresso-core

core/services/container/Recipe.php

Indentation +306 added lines, -306 removed lines

@@ -19,310 +19,310 @@
 class Recipe implements RecipeInterface
 {
 
-    /**
-     * A default Recipe to use if none is specified for a class
-     */
-    const DEFAULT_ID = '*';
-
-    /**
-     * Identifier for the entity class to be constructed.
-     * Typically a Fully Qualified Class Name
-     *
-     * @var string $identifier
-     */
-    private $identifier;
-
-    /**
-     * Fully Qualified Class Name
-     *
-     * @var string $fqcn
-     */
-    private $fqcn;
-
-    /**
-     * a dependency class map array
-     * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
-     * and that class type hints for an interface, then this property allows you to configure what dependencies
-     * get used when instantiating the class.
-     * For example:
-     *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
-     *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
-     *  We want one Coffee object to use HonduranBean for its BeanInterface,
-     *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
-     *  To do this, we need to create two Recipes:
-     *      one with an identifier of 'HonduranCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'HonduranBean')
-     *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
-     *          array('BeanInterface' => 'KenyanBean')
-     *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
-     *  an instance of HonduranBean will get injected for the BeanInterface dependency,
-     *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
-     *  an instance of KenyanBean will get injected for the BeanInterface dependency
-     *
-     * @var array $ingredients
-     */
-    private $ingredients = array();
-
-    /**
-     * one of the class constants from CoffeeShop:
-     *  CoffeeMaker::BREW_NEW - creates a new instance
-     *  CoffeeMaker::BREW_SHARED - creates a shared instance
-     *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
-     *
-     * @var string $type
-     */
-    private $type;
-
-    /**
-     * class name aliases - typically a Fully Qualified Interface that the class implements
-     * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
-     *
-     * @var array $filters
-     */
-    private $filters = array();
-
-    /**
-     * array of full server filepaths to files that may contain the class
-     *
-     * @var array $paths
-     */
-    private $paths = array();
-
-
-    /**
-     * Recipe constructor.
-     *
-     * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
-     * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
-     * @param array  $ingredients   array of dependencies that can not be resolved automatically,
-     *                              used for resolving concrete classes for type hinted interfaces
-     *                              for the dependencies of THIS class
-     * @param string $type          recipe type: one of the class constants on
-     *                              \EventEspresso\core\services\container\CoffeeMaker
-     * @param array  $filters       array of class aliases, or class interfaces
-     *                              this works somewhat opposite to the $ingredients array above,
-     *                              in that this array specifies interfaces or aliases
-     *                              that this Recipe can be used for when resolving OTHER class's dependencies
-     * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
-     *                              then supply a filepath, or array of filepaths, so that it can be included
-     * @throws InvalidIdentifierException
-     * @throws RuntimeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        $identifier,
-        $fqcn = '',
-        array $filters = array(),
-        array $ingredients = array(),
-        $type = CoffeeMaker::BREW_NEW,
-        array $paths = array()
-    ) {
-        $this->setIdentifier($identifier);
-        $this->setFilters($filters);
-        $this->setIngredients($ingredients);
-        $this->setType($type);
-        $this->setPaths($paths);
-        $this->setFqcn($fqcn);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function fqcn()
-    {
-        return $this->fqcn;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function filters()
-    {
-        return $this->filters;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ingredients()
-    {
-        return $this->ingredients;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function type()
-    {
-        return $this->type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function paths()
-    {
-        return $this->paths;
-    }
-
-
-    /**
-     * @param  string $identifier Identifier for the entity class that the Recipe applies to
-     *                            Typically a Fully Qualified Class Name
-     * @throws InvalidIdentifierException
-     */
-    public function setIdentifier($identifier)
-    {
-        if (! is_string($identifier) || empty($identifier)) {
-            throw new InvalidIdentifierException(
-                is_object($identifier) ? get_class($identifier) : gettype($identifier),
-                __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * Ensures incoming string is a valid Fully Qualified Class Name,
-     * except if this is the default wildcard Recipe ( * ),
-     * or it's NOT an actual FQCN because the Recipe is using filepaths
-     * for classes that are not PSR-4 compatible
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string $fqcn
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     */
-    public function setFqcn($fqcn)
-    {
-        $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if (! is_string($fqcn)) {
-            throw new InvalidDataTypeException(
-                '$fqcn',
-                is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
-                __('string (Fully\Qualified\ClassName)', 'event_espresso')
-            );
-        }
-        $fqcn = ltrim($fqcn, '\\');
-        if ($fqcn !== Recipe::DEFAULT_ID
-            && ! empty($fqcn)
-            && empty($this->paths)
-            && ! (class_exists($fqcn) || interface_exists($fqcn))
-        ) {
-            throw new InvalidClassException($fqcn);
-        }
-        $this->fqcn = $fqcn;
-    }
-
-
-    /**
-     * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
-     *                              example:
-     *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     * @throws InvalidDataTypeException
-     */
-    public function setIngredients(array $ingredients)
-    {
-        if (empty($ingredients)) {
-            return;
-        }
-        if (! is_array($ingredients)) {
-            throw new InvalidDataTypeException(
-                '$ingredients',
-                is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
-                __('array of class dependencies', 'event_espresso')
-            );
-        }
-        $this->ingredients = array_merge($this->ingredients, $ingredients);
-    }
-
-
-    /**
-     * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
-     * @throws InvalidIdentifierException
-     */
-    public function setType($type = CoffeeMaker::BREW_NEW)
-    {
-        $this->type = CoffeeMaker::validateType($type);
-    }
-
-
-    /**
-     * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
-     *                          example:
-     *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
-     * @throws InvalidDataTypeException
-     */
-    public function setFilters(array $filters)
-    {
-        if (empty($filters)) {
-            return;
-        }
-        if (! is_array($filters)) {
-            throw new InvalidDataTypeException(
-                '$filters',
-                is_object($filters) ? get_class($filters) : gettype($filters),
-                __('array of class aliases', 'event_espresso')
-            );
-        }
-        $this->filters = array_merge($this->filters, $filters);
-    }
-
-
-    /**
-     * Ensures incoming paths is a valid filepath, or array of valid filepaths,
-     * and merges them in with any existing filepaths
-     * PLZ NOTE:
-     *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
-     *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
-     *
-     * @param string|array $paths
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     */
-    public function setPaths($paths = array())
-    {
-        if (empty($paths)) {
-            return;
-        }
-        if (! (is_string($paths) || is_array($paths))) {
-            throw new InvalidDataTypeException(
-                '$path',
-                is_object($paths) ? get_class($paths) : gettype($paths),
-                __('string or array of strings (full server filepath(s))', 'event_espresso')
-            );
-        }
-        $paths = (array) $paths;
-        foreach ($paths as $path) {
-            if (strpos($path, '*') === false && ! is_readable($path)) {
-                throw new RuntimeException(
-                    sprintf(
-                        __('The following filepath is not readable: "%1$s"', 'event_espresso'),
-                        $path
-                    )
-                );
-            }
-        }
-        $this->paths = array_merge($this->paths, $paths);
-    }
+	/**
+	 * A default Recipe to use if none is specified for a class
+	 */
+	const DEFAULT_ID = '*';
+
+	/**
+	 * Identifier for the entity class to be constructed.
+	 * Typically a Fully Qualified Class Name
+	 *
+	 * @var string $identifier
+	 */
+	private $identifier;
+
+	/**
+	 * Fully Qualified Class Name
+	 *
+	 * @var string $fqcn
+	 */
+	private $fqcn;
+
+	/**
+	 * a dependency class map array
+	 * If a Recipe is for a single class (or group of classes that shares the EXACT SAME constructor arguments),
+	 * and that class type hints for an interface, then this property allows you to configure what dependencies
+	 * get used when instantiating the class.
+	 * For example:
+	 *  There's a class called Coffee, and one of its constructor arguments is BeanInterface
+	 *  There are two implementations of BeanInterface: HonduranBean, and KenyanBean
+	 *  We want one Coffee object to use HonduranBean for its BeanInterface,
+	 *  and the 2nd Coffee object to use KenyanBean for its BeanInterface.
+	 *  To do this, we need to create two Recipes:
+	 *      one with an identifier of 'HonduranCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'HonduranBean')
+	 *      and the other with an identifier of 'KenyanCoffee' using the following ingredients :
+	 *          array('BeanInterface' => 'KenyanBean')
+	 *  Then, whenever the CoffeeShop brews an instance of HonduranCoffee,
+	 *  an instance of HonduranBean will get injected for the BeanInterface dependency,
+	 *  and whenever the CoffeeShop brews an instance of KenyanCoffee,
+	 *  an instance of KenyanBean will get injected for the BeanInterface dependency
+	 *
+	 * @var array $ingredients
+	 */
+	private $ingredients = array();
+
+	/**
+	 * one of the class constants from CoffeeShop:
+	 *  CoffeeMaker::BREW_NEW - creates a new instance
+	 *  CoffeeMaker::BREW_SHARED - creates a shared instance
+	 *  CoffeeMaker::BREW_LOAD_ONLY - loads but does not instantiate
+	 *
+	 * @var string $type
+	 */
+	private $type;
+
+	/**
+	 * class name aliases - typically a Fully Qualified Interface that the class implements
+	 * identifiers passed to the CoffeeShop will be run through the filters to find the correct class name
+	 *
+	 * @var array $filters
+	 */
+	private $filters = array();
+
+	/**
+	 * array of full server filepaths to files that may contain the class
+	 *
+	 * @var array $paths
+	 */
+	private $paths = array();
+
+
+	/**
+	 * Recipe constructor.
+	 *
+	 * @param string $identifier    class identifier, can be an alias, or FQCN, or whatever
+	 * @param string $fqcn          \Fully\Qualified\ClassName, optional if $identifier is FQCN
+	 * @param array  $ingredients   array of dependencies that can not be resolved automatically,
+	 *                              used for resolving concrete classes for type hinted interfaces
+	 *                              for the dependencies of THIS class
+	 * @param string $type          recipe type: one of the class constants on
+	 *                              \EventEspresso\core\services\container\CoffeeMaker
+	 * @param array  $filters       array of class aliases, or class interfaces
+	 *                              this works somewhat opposite to the $ingredients array above,
+	 *                              in that this array specifies interfaces or aliases
+	 *                              that this Recipe can be used for when resolving OTHER class's dependencies
+	 * @param array  $paths         if class can not be loaded via PSR-4 autoloading,
+	 *                              then supply a filepath, or array of filepaths, so that it can be included
+	 * @throws InvalidIdentifierException
+	 * @throws RuntimeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		$identifier,
+		$fqcn = '',
+		array $filters = array(),
+		array $ingredients = array(),
+		$type = CoffeeMaker::BREW_NEW,
+		array $paths = array()
+	) {
+		$this->setIdentifier($identifier);
+		$this->setFilters($filters);
+		$this->setIngredients($ingredients);
+		$this->setType($type);
+		$this->setPaths($paths);
+		$this->setFqcn($fqcn);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function fqcn()
+	{
+		return $this->fqcn;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function filters()
+	{
+		return $this->filters;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ingredients()
+	{
+		return $this->ingredients;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function type()
+	{
+		return $this->type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function paths()
+	{
+		return $this->paths;
+	}
+
+
+	/**
+	 * @param  string $identifier Identifier for the entity class that the Recipe applies to
+	 *                            Typically a Fully Qualified Class Name
+	 * @throws InvalidIdentifierException
+	 */
+	public function setIdentifier($identifier)
+	{
+		if (! is_string($identifier) || empty($identifier)) {
+			throw new InvalidIdentifierException(
+				is_object($identifier) ? get_class($identifier) : gettype($identifier),
+				__('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * Ensures incoming string is a valid Fully Qualified Class Name,
+	 * except if this is the default wildcard Recipe ( * ),
+	 * or it's NOT an actual FQCN because the Recipe is using filepaths
+	 * for classes that are not PSR-4 compatible
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string $fqcn
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 */
+	public function setFqcn($fqcn)
+	{
+		$fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
+		if (! is_string($fqcn)) {
+			throw new InvalidDataTypeException(
+				'$fqcn',
+				is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
+				__('string (Fully\Qualified\ClassName)', 'event_espresso')
+			);
+		}
+		$fqcn = ltrim($fqcn, '\\');
+		if ($fqcn !== Recipe::DEFAULT_ID
+			&& ! empty($fqcn)
+			&& empty($this->paths)
+			&& ! (class_exists($fqcn) || interface_exists($fqcn))
+		) {
+			throw new InvalidClassException($fqcn);
+		}
+		$this->fqcn = $fqcn;
+	}
+
+
+	/**
+	 * @param array $ingredients    an array of dependencies where keys are the aliases and values are the FQCNs
+	 *                              example:
+	 *                              array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 * @throws InvalidDataTypeException
+	 */
+	public function setIngredients(array $ingredients)
+	{
+		if (empty($ingredients)) {
+			return;
+		}
+		if (! is_array($ingredients)) {
+			throw new InvalidDataTypeException(
+				'$ingredients',
+				is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
+				__('array of class dependencies', 'event_espresso')
+			);
+		}
+		$this->ingredients = array_merge($this->ingredients, $ingredients);
+	}
+
+
+	/**
+	 * @param string $type one of the class constants returned from CoffeeMaker::getTypes()
+	 * @throws InvalidIdentifierException
+	 */
+	public function setType($type = CoffeeMaker::BREW_NEW)
+	{
+		$this->type = CoffeeMaker::validateType($type);
+	}
+
+
+	/**
+	 * @param array $filters    an array of filters where keys are the aliases and values are the FQCNs
+	 *                          example:
+	 *                          array( 'ClassInterface' => 'Fully\Qualified\ClassName' )
+	 * @throws InvalidDataTypeException
+	 */
+	public function setFilters(array $filters)
+	{
+		if (empty($filters)) {
+			return;
+		}
+		if (! is_array($filters)) {
+			throw new InvalidDataTypeException(
+				'$filters',
+				is_object($filters) ? get_class($filters) : gettype($filters),
+				__('array of class aliases', 'event_espresso')
+			);
+		}
+		$this->filters = array_merge($this->filters, $filters);
+	}
+
+
+	/**
+	 * Ensures incoming paths is a valid filepath, or array of valid filepaths,
+	 * and merges them in with any existing filepaths
+	 * PLZ NOTE:
+	 *  Recipe::setFqcn() has a check to see if Recipe::$paths is empty or not,
+	 *  therefore you should always call Recipe::setPaths() before Recipe::setFqcn()
+	 *
+	 * @param string|array $paths
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 */
+	public function setPaths($paths = array())
+	{
+		if (empty($paths)) {
+			return;
+		}
+		if (! (is_string($paths) || is_array($paths))) {
+			throw new InvalidDataTypeException(
+				'$path',
+				is_object($paths) ? get_class($paths) : gettype($paths),
+				__('string or array of strings (full server filepath(s))', 'event_espresso')
+			);
+		}
+		$paths = (array) $paths;
+		foreach ($paths as $path) {
+			if (strpos($path, '*') === false && ! is_readable($path)) {
+				throw new RuntimeException(
+					sprintf(
+						__('The following filepath is not readable: "%1$s"', 'event_espresso'),
+						$path
+					)
+				);
+			}
+		}
+		$this->paths = array_merge($this->paths, $paths);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -189,7 +189,7 @@ 
      */
     public function setIdentifier($identifier)
     {
-        if (! is_string($identifier) || empty($identifier)) {
+        if ( ! is_string($identifier) || empty($identifier)) {
             throw new InvalidIdentifierException(
                 is_object($identifier) ? get_class($identifier) : gettype($identifier),
                 __('class identifier (typically a \Fully\Qualified\ClassName)', 'event_espresso')
@@ -216,7 +216,7 @@ 
     public function setFqcn($fqcn)
     {
         $fqcn = ! empty($fqcn) ? $fqcn : $this->identifier;
-        if (! is_string($fqcn)) {
+        if ( ! is_string($fqcn)) {
             throw new InvalidDataTypeException(
                 '$fqcn',
                 is_object($fqcn) ? get_class($fqcn) : gettype($fqcn),
@@ -246,7 +246,7 @@ 
         if (empty($ingredients)) {
             return;
         }
-        if (! is_array($ingredients)) {
+        if ( ! is_array($ingredients)) {
             throw new InvalidDataTypeException(
                 '$ingredients',
                 is_object($ingredients) ? get_class($ingredients) : gettype($ingredients),
@@ -278,7 +278,7 @@ 
         if (empty($filters)) {
             return;
         }
-        if (! is_array($filters)) {
+        if ( ! is_array($filters)) {
             throw new InvalidDataTypeException(
                 '$filters',
                 is_object($filters) ? get_class($filters) : gettype($filters),
@@ -305,7 +305,7 @@ 
         if (empty($paths)) {
             return;
         }
-        if (! (is_string($paths) || is_array($paths))) {
+        if ( ! (is_string($paths) || is_array($paths))) {
             throw new InvalidDataTypeException(
                 '$path',
                 is_object($paths) ? get_class($paths) : gettype($paths),

core/services/shortcodes/LegacyShortcodesManager.php

Indentation +405 added lines, -405 removed lines

@@ -21,409 +21,409 @@
 class LegacyShortcodesManager
 {
 
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-
-    /**
-     * LegacyShortcodesManager constructor.
-     *
-     * @param \EE_Registry $registry
-     */
-    public function __construct(EE_Registry $registry)
-    {
-        $this->registry = $registry;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function registry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * registerShortcodes
-     *
-     * @return void
-     */
-    public function registerShortcodes()
-    {
-        $this->registry->shortcodes = $this->getShortcodes();
-    }
-
-
-    /**
-     * getShortcodes
-     *
-     * @return array
-     */
-    public function getShortcodes()
-    {
-        // previously this method would glob the shortcodes directory
-        // then filter that list of shortcodes to register,
-        // but now we are going to just supply an empty array.
-        // this allows any shortcodes that have not yet been converted to the new system
-        // to still get loaded and processed, albeit using the same legacy logic as before
-        $shortcodes_to_register = apply_filters(
-            'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
-            array()
-        );
-        if (! empty($shortcodes_to_register)) {
-            // cycle thru shortcode folders
-            foreach ($shortcodes_to_register as $shortcode_path) {
-                // add to list of installed shortcode modules
-                $this->registerShortcode($shortcode_path);
-            }
-        }
-        // filter list of installed modules
-        return apply_filters(
-            'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
-            ! empty($this->registry->shortcodes)
-                ? $this->registry->shortcodes
-                : array()
-        );
-    }
-
-
-    /**
-     *    register_shortcode - makes core aware of this shortcode
-     *
-     * @access    public
-     * @param    string $shortcode_path - full path up to and including shortcode folder
-     * @return    bool
-     */
-    public function registerShortcode($shortcode_path = null)
-    {
-        do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
-        $shortcode_ext = '.shortcode.php';
-        // make all separators match
-        $shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
-        // does the file path INCLUDE the actual file name as part of the path ?
-        if (strpos($shortcode_path, $shortcode_ext) !== false) {
-            // grab shortcode file name from directory name and break apart at dots
-            $shortcode_file = explode('.', basename($shortcode_path));
-            // take first segment from file name pieces and remove class prefix if it exists
-            $shortcode = strpos($shortcode_file[0], 'EES_') === 0
-                ? substr($shortcode_file[0], 4)
-                : $shortcode_file[0];
-            // sanitize shortcode directory name
-            $shortcode = sanitize_key($shortcode);
-            // now we need to rebuild the shortcode path
-            $shortcode_path = explode(DS, $shortcode_path);
-            // remove last segment
-            array_pop($shortcode_path);
-            // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
-        } else {
-            // we need to generate the filename based off of the folder name
-            // grab and sanitize shortcode directory name
-            $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
-        }
-        // create classname from shortcode directory or file name
-        $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
-        // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
-        // does the shortcode exist ?
-        if (! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
-            $msg = sprintf(
-                esc_html__(
-                    'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
-                    'event_espresso'
-                ),
-                $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
-        // verify that class exists
-        if (! class_exists($shortcode_class)) {
-            $msg = sprintf(
-                esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
-                $shortcode_class
-            );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-        $shortcode = strtoupper($shortcode);
-        // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
-        return true;
-    }
-
-
-    /**
-     *    _initialize_shortcodes
-     *    allow shortcodes to set hooks for the rest of the system
-     *
-     * @access private
-     * @return void
-     */
-    public function addShortcodes()
-    {
-        // cycle thru shortcode folders
-        foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
-            // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
-            // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
-            // which set hooks ?
-            if (is_admin()) {
-                // fire immediately
-                call_user_func(array($shortcode_class, 'set_hooks_admin'));
-            } else {
-                // delay until other systems are online
-                add_action(
-                    'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
-                    array($shortcode_class, 'set_hooks')
-                );
-                // convert classname to UPPERCASE and create WP shortcode.
-                $shortcode_tag = strtoupper($shortcode);
-                // but first check if the shortcode has already
-                // been added before assigning 'fallback_shortcode_processor'
-                if (! shortcode_exists($shortcode_tag)) {
-                    // NOTE: this shortcode declaration will get overridden if the shortcode
-                    // is successfully detected in the post content in initializeShortcode()
-                    add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
-                }
-            }
-        }
-    }
-
-
-    /**
-     * callback for the WP "get_header" hook point
-     * checks posts for EE shortcodes, and initializes them,
-     * then toggles filter switch that loads core default assets
-     *
-     * @param \WP_Query $wp_query
-     * @return void
-     */
-    public function initializeShortcodes(WP_Query $wp_query)
-    {
-        if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
-            return;
-        }
-        global $wp;
-        /** @var EE_Front_controller $Front_Controller */
-        $Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
-        $Front_Controller->Request_Handler()->set_request_vars();
-        // grab post_name from request
-        $current_post = apply_filters(
-            'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
-            $Front_Controller->Request_Handler()->get('post_name')
-        );
-        $show_on_front = get_option('show_on_front');
-        // if it's not set, then check if frontpage is blog
-        if (empty($current_post)) {
-            // yup.. this is the posts page, prepare to load all shortcode modules
-            $current_post = 'posts';
-            // unless..
-            if ($show_on_front === 'page') {
-                // some other page is set as the homepage
-                $page_on_front = get_option('page_on_front');
-                if ($page_on_front) {
-                    // k now we need to find the post_name for this page
-                    global $wpdb;
-                    $page_on_front = $wpdb->get_var(
-                        $wpdb->prepare(
-                            "SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
-                            $page_on_front
-                        )
-                    );
-                    // set the current post slug to what it actually is
-                    $current_post = $page_on_front ? $page_on_front : $current_post;
-                }
-            }
-        }
-        // in case $current_post is hierarchical like: /parent-page/current-page
-        $current_post = basename($current_post);
-        if (// is current page/post the "blog" page ?
-            $current_post === EE_Config::get_page_for_posts()
-            // or are we on a category page?
-            || (
-                is_array(term_exists($current_post, 'category'))
-                || array_key_exists('category_name', $wp->query_vars)
-            )
-        ) {
-            // initialize all legacy shortcodes
-            $load_assets = $this->parseContentForShortcodes('', true);
-        } else {
-            global $wpdb;
-            $post_content = $wpdb->get_var(
-                $wpdb->prepare(
-                    "SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
-                    $current_post
-                )
-            );
-            $load_assets = $this->parseContentForShortcodes($post_content);
-        }
-        if ($load_assets) {
-            $this->registry->REQ->set_espresso_page(true);
-            add_filter('FHEE_load_css', '__return_true');
-            add_filter('FHEE_load_js', '__return_true');
-        }
-        do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
-    }
-
-
-    /**
-     * checks supplied content against list of legacy shortcodes,
-     * then initializes any found shortcodes, and returns true.
-     * returns false if no shortcodes found.
-     *
-     * @param string $content
-     * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
-     * @return bool
-     */
-    public function parseContentForShortcodes($content = '', $load_all = false)
-    {
-        $has_shortcode = false;
-        foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
-            if ($load_all || has_shortcode($content, $shortcode_class)) {
-                // load up the shortcode
-                $this->initializeShortcode($shortcode_class);
-                $has_shortcode = true;
-            }
-        }
-        return $has_shortcode;
-    }
-
-
-    /**
-     * given a shortcode name, will instantiate the shortcode and call it's run() method
-     *
-     * @param string $shortcode_class
-     * @param WP     $wp
-     */
-    public function initializeShortcode($shortcode_class = '', WP $wp = null)
-    {
-        // don't do anything if shortcode is already initialized
-        if (empty($this->registry->shortcodes->{$shortcode_class})
-            || ! is_string($this->registry->shortcodes->{$shortcode_class})
-        ) {
-            return;
-        }
-        // let's pause to reflect on this...
-        $sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
-        // ensure that class is actually a shortcode
-        if (defined('WP_DEBUG')
-            && WP_DEBUG === true
-            && ! $sc_reflector->isSubclassOf('EES_Shortcode')
-        ) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
-                        'event_espresso'
-                    ),
-                    $shortcode_class
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            add_filter('FHEE_run_EE_the_content', '__return_true');
-            return;
-        }
-        global $wp;
-        // and pass the request object to the run method
-        $this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
-        // fire the shortcode class's run method, so that it can activate resources
-        $this->registry->shortcodes->{$shortcode_class}->run($wp);
-    }
-
-
-    /**
-     * get classname, remove EES_prefix, and convert to UPPERCASE
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function generateShortcodeTagFromClassName($class_name)
-    {
-        return strtoupper(str_replace('EES_', '', $class_name));
-    }
-
-
-    /**
-     * add EES_prefix and Capitalize words
-     *
-     * @param string $tag
-     * @return string
-     */
-    public static function generateShortcodeClassNameFromTag($tag)
-    {
-        // order of operation runs from inside to out
-        // 5) maybe add prefix
-        return LegacyShortcodesManager::addShortcodeClassPrefix(
-            // 4) find spaces, replace with underscores
-            str_replace(
-                ' ',
-                '_',
-                // 3) capitalize first letter of each word
-                ucwords(
-                    // 2) also change to lowercase so ucwords() will work
-                    strtolower(
-                        // 1) find underscores, replace with spaces so ucwords() will work
-                        str_replace(
-                            '_',
-                            ' ',
-                            $tag
-                        )
-                    )
-                )
-            )
-        );
-    }
-
-
-    /**
-     * maybe add EES_prefix
-     *
-     * @param string $class_name
-     * @return string
-     */
-    public static function addShortcodeClassPrefix($class_name)
-    {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getEspressoShortcodeTags()
-    {
-        static $shortcode_tags = array();
-        if (empty($shortcode_tags)) {
-            $shortcode_tags = array_keys((array) $this->registry->shortcodes);
-        }
-        return $shortcode_tags;
-    }
-
-
-    /**
-     * @param string $content
-     * @return string
-     */
-    public function doShortcode($content)
-    {
-        foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
-            if (strpos($content, $shortcode_tag) !== false) {
-                $shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
-                $this->initializeShortcode($shortcode_class);
-            }
-        }
-        return do_shortcode($content);
-    }
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+
+	/**
+	 * LegacyShortcodesManager constructor.
+	 *
+	 * @param \EE_Registry $registry
+	 */
+	public function __construct(EE_Registry $registry)
+	{
+		$this->registry = $registry;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function registry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * registerShortcodes
+	 *
+	 * @return void
+	 */
+	public function registerShortcodes()
+	{
+		$this->registry->shortcodes = $this->getShortcodes();
+	}
+
+
+	/**
+	 * getShortcodes
+	 *
+	 * @return array
+	 */
+	public function getShortcodes()
+	{
+		// previously this method would glob the shortcodes directory
+		// then filter that list of shortcodes to register,
+		// but now we are going to just supply an empty array.
+		// this allows any shortcodes that have not yet been converted to the new system
+		// to still get loaded and processed, albeit using the same legacy logic as before
+		$shortcodes_to_register = apply_filters(
+			'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
+			array()
+		);
+		if (! empty($shortcodes_to_register)) {
+			// cycle thru shortcode folders
+			foreach ($shortcodes_to_register as $shortcode_path) {
+				// add to list of installed shortcode modules
+				$this->registerShortcode($shortcode_path);
+			}
+		}
+		// filter list of installed modules
+		return apply_filters(
+			'FHEE__EE_Config___register_shortcodes__installed_shortcodes',
+			! empty($this->registry->shortcodes)
+				? $this->registry->shortcodes
+				: array()
+		);
+	}
+
+
+	/**
+	 *    register_shortcode - makes core aware of this shortcode
+	 *
+	 * @access    public
+	 * @param    string $shortcode_path - full path up to and including shortcode folder
+	 * @return    bool
+	 */
+	public function registerShortcode($shortcode_path = null)
+	{
+		do_action('AHEE__EE_Config__register_shortcode__begin', $shortcode_path);
+		$shortcode_ext = '.shortcode.php';
+		// make all separators match
+		$shortcode_path = str_replace(array('\\', '/'), DS, $shortcode_path);
+		// does the file path INCLUDE the actual file name as part of the path ?
+		if (strpos($shortcode_path, $shortcode_ext) !== false) {
+			// grab shortcode file name from directory name and break apart at dots
+			$shortcode_file = explode('.', basename($shortcode_path));
+			// take first segment from file name pieces and remove class prefix if it exists
+			$shortcode = strpos($shortcode_file[0], 'EES_') === 0
+				? substr($shortcode_file[0], 4)
+				: $shortcode_file[0];
+			// sanitize shortcode directory name
+			$shortcode = sanitize_key($shortcode);
+			// now we need to rebuild the shortcode path
+			$shortcode_path = explode(DS, $shortcode_path);
+			// remove last segment
+			array_pop($shortcode_path);
+			// glue it back together
+			$shortcode_path = implode(DS, $shortcode_path) . DS;
+		} else {
+			// we need to generate the filename based off of the folder name
+			// grab and sanitize shortcode directory name
+			$shortcode = sanitize_key(basename($shortcode_path));
+			$shortcode_path = rtrim($shortcode_path, DS) . DS;
+		}
+		// create classname from shortcode directory or file name
+		$shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
+		// add class prefix
+		$shortcode_class = 'EES_' . $shortcode;
+		// does the shortcode exist ?
+		if (! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+			$msg = sprintf(
+				esc_html__(
+					'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
+					'event_espresso'
+				),
+				$shortcode_class,
+				$shortcode_path . DS . $shortcode_class . $shortcode_ext
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		// load the shortcode class file
+		require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+		// verify that class exists
+		if (! class_exists($shortcode_class)) {
+			$msg = sprintf(
+				esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
+				$shortcode_class
+			);
+			EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+		$shortcode = strtoupper($shortcode);
+		// add to array of registered shortcodes
+		$this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+		return true;
+	}
+
+
+	/**
+	 *    _initialize_shortcodes
+	 *    allow shortcodes to set hooks for the rest of the system
+	 *
+	 * @access private
+	 * @return void
+	 */
+	public function addShortcodes()
+	{
+		// cycle thru shortcode folders
+		foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
+			// add class prefix
+			$shortcode_class = 'EES_' . $shortcode;
+			// fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
+			// which set hooks ?
+			if (is_admin()) {
+				// fire immediately
+				call_user_func(array($shortcode_class, 'set_hooks_admin'));
+			} else {
+				// delay until other systems are online
+				add_action(
+					'AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons',
+					array($shortcode_class, 'set_hooks')
+				);
+				// convert classname to UPPERCASE and create WP shortcode.
+				$shortcode_tag = strtoupper($shortcode);
+				// but first check if the shortcode has already
+				// been added before assigning 'fallback_shortcode_processor'
+				if (! shortcode_exists($shortcode_tag)) {
+					// NOTE: this shortcode declaration will get overridden if the shortcode
+					// is successfully detected in the post content in initializeShortcode()
+					add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * callback for the WP "get_header" hook point
+	 * checks posts for EE shortcodes, and initializes them,
+	 * then toggles filter switch that loads core default assets
+	 *
+	 * @param \WP_Query $wp_query
+	 * @return void
+	 */
+	public function initializeShortcodes(WP_Query $wp_query)
+	{
+		if (empty($this->registry->shortcodes) || ! $wp_query->is_main_query() || is_admin()) {
+			return;
+		}
+		global $wp;
+		/** @var EE_Front_controller $Front_Controller */
+		$Front_Controller = $this->registry->load_core('Front_Controller', array(), false);
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__begin', $wp, $Front_Controller);
+		$Front_Controller->Request_Handler()->set_request_vars();
+		// grab post_name from request
+		$current_post = apply_filters(
+			'FHEE__EE_Front_Controller__initialize_shortcodes__current_post_name',
+			$Front_Controller->Request_Handler()->get('post_name')
+		);
+		$show_on_front = get_option('show_on_front');
+		// if it's not set, then check if frontpage is blog
+		if (empty($current_post)) {
+			// yup.. this is the posts page, prepare to load all shortcode modules
+			$current_post = 'posts';
+			// unless..
+			if ($show_on_front === 'page') {
+				// some other page is set as the homepage
+				$page_on_front = get_option('page_on_front');
+				if ($page_on_front) {
+					// k now we need to find the post_name for this page
+					global $wpdb;
+					$page_on_front = $wpdb->get_var(
+						$wpdb->prepare(
+							"SELECT post_name from {$wpdb->posts} WHERE post_type='page' AND post_status NOT IN ('auto-draft', 'inherit', 'trash') AND ID=%d",
+							$page_on_front
+						)
+					);
+					// set the current post slug to what it actually is
+					$current_post = $page_on_front ? $page_on_front : $current_post;
+				}
+			}
+		}
+		// in case $current_post is hierarchical like: /parent-page/current-page
+		$current_post = basename($current_post);
+		if (// is current page/post the "blog" page ?
+			$current_post === EE_Config::get_page_for_posts()
+			// or are we on a category page?
+			|| (
+				is_array(term_exists($current_post, 'category'))
+				|| array_key_exists('category_name', $wp->query_vars)
+			)
+		) {
+			// initialize all legacy shortcodes
+			$load_assets = $this->parseContentForShortcodes('', true);
+		} else {
+			global $wpdb;
+			$post_content = $wpdb->get_var(
+				$wpdb->prepare(
+					"SELECT post_content from {$wpdb->posts} WHERE post_status NOT IN ('auto-draft', 'inherit', 'trash') AND post_name=%s",
+					$current_post
+				)
+			);
+			$load_assets = $this->parseContentForShortcodes($post_content);
+		}
+		if ($load_assets) {
+			$this->registry->REQ->set_espresso_page(true);
+			add_filter('FHEE_load_css', '__return_true');
+			add_filter('FHEE_load_js', '__return_true');
+		}
+		do_action('AHEE__EE_Front_Controller__initialize_shortcodes__end', $Front_Controller);
+	}
+
+
+	/**
+	 * checks supplied content against list of legacy shortcodes,
+	 * then initializes any found shortcodes, and returns true.
+	 * returns false if no shortcodes found.
+	 *
+	 * @param string $content
+	 * @param bool   $load_all if true, then ALL active legacy shortcodes will be initialized
+	 * @return bool
+	 */
+	public function parseContentForShortcodes($content = '', $load_all = false)
+	{
+		$has_shortcode = false;
+		foreach ($this->registry->shortcodes as $shortcode_class => $shortcode) {
+			if ($load_all || has_shortcode($content, $shortcode_class)) {
+				// load up the shortcode
+				$this->initializeShortcode($shortcode_class);
+				$has_shortcode = true;
+			}
+		}
+		return $has_shortcode;
+	}
+
+
+	/**
+	 * given a shortcode name, will instantiate the shortcode and call it's run() method
+	 *
+	 * @param string $shortcode_class
+	 * @param WP     $wp
+	 */
+	public function initializeShortcode($shortcode_class = '', WP $wp = null)
+	{
+		// don't do anything if shortcode is already initialized
+		if (empty($this->registry->shortcodes->{$shortcode_class})
+			|| ! is_string($this->registry->shortcodes->{$shortcode_class})
+		) {
+			return;
+		}
+		// let's pause to reflect on this...
+		$sc_reflector = new ReflectionClass(LegacyShortcodesManager::addShortcodeClassPrefix($shortcode_class));
+		// ensure that class is actually a shortcode
+		if (defined('WP_DEBUG')
+			&& WP_DEBUG === true
+			&& ! $sc_reflector->isSubclassOf('EES_Shortcode')
+		) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The requested %s shortcode is not of the class "EES_Shortcode". Please check your files.',
+						'event_espresso'
+					),
+					$shortcode_class
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			add_filter('FHEE_run_EE_the_content', '__return_true');
+			return;
+		}
+		global $wp;
+		// and pass the request object to the run method
+		$this->registry->shortcodes->{$shortcode_class} = $sc_reflector->newInstance();
+		// fire the shortcode class's run method, so that it can activate resources
+		$this->registry->shortcodes->{$shortcode_class}->run($wp);
+	}
+
+
+	/**
+	 * get classname, remove EES_prefix, and convert to UPPERCASE
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function generateShortcodeTagFromClassName($class_name)
+	{
+		return strtoupper(str_replace('EES_', '', $class_name));
+	}
+
+
+	/**
+	 * add EES_prefix and Capitalize words
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	public static function generateShortcodeClassNameFromTag($tag)
+	{
+		// order of operation runs from inside to out
+		// 5) maybe add prefix
+		return LegacyShortcodesManager::addShortcodeClassPrefix(
+			// 4) find spaces, replace with underscores
+			str_replace(
+				' ',
+				'_',
+				// 3) capitalize first letter of each word
+				ucwords(
+					// 2) also change to lowercase so ucwords() will work
+					strtolower(
+						// 1) find underscores, replace with spaces so ucwords() will work
+						str_replace(
+							'_',
+							' ',
+							$tag
+						)
+					)
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * maybe add EES_prefix
+	 *
+	 * @param string $class_name
+	 * @return string
+	 */
+	public static function addShortcodeClassPrefix($class_name)
+	{
+		return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getEspressoShortcodeTags()
+	{
+		static $shortcode_tags = array();
+		if (empty($shortcode_tags)) {
+			$shortcode_tags = array_keys((array) $this->registry->shortcodes);
+		}
+		return $shortcode_tags;
+	}
+
+
+	/**
+	 * @param string $content
+	 * @return string
+	 */
+	public function doShortcode($content)
+	{
+		foreach ($this->getEspressoShortcodeTags() as $shortcode_tag) {
+			if (strpos($content, $shortcode_tag) !== false) {
+				$shortcode_class = LegacyShortcodesManager::generateShortcodeClassNameFromTag($shortcode_tag);
+				$this->initializeShortcode($shortcode_class);
+			}
+		}
+		return do_shortcode($content);
+	}
 }

Spacing +14 added lines, -14 removed lines

@@ -74,7 +74,7 @@ 
             'FHEE__EE_Config__register_shortcodes__shortcodes_to_register',
             array()
         );
-        if (! empty($shortcodes_to_register)) {
+        if ( ! empty($shortcodes_to_register)) {
             // cycle thru shortcode folders
             foreach ($shortcodes_to_register as $shortcode_path) {
                 // add to list of installed shortcode modules
@@ -119,44 +119,44 @@ 
             // remove last segment
             array_pop($shortcode_path);
             // glue it back together
-            $shortcode_path = implode(DS, $shortcode_path) . DS;
+            $shortcode_path = implode(DS, $shortcode_path).DS;
         } else {
             // we need to generate the filename based off of the folder name
             // grab and sanitize shortcode directory name
             $shortcode = sanitize_key(basename($shortcode_path));
-            $shortcode_path = rtrim($shortcode_path, DS) . DS;
+            $shortcode_path = rtrim($shortcode_path, DS).DS;
         }
         // create classname from shortcode directory or file name
         $shortcode = str_replace(' ', '_', ucwords(str_replace('_', ' ', $shortcode)));
         // add class prefix
-        $shortcode_class = 'EES_' . $shortcode;
+        $shortcode_class = 'EES_'.$shortcode;
         // does the shortcode exist ?
-        if (! is_readable($shortcode_path . DS . $shortcode_class . $shortcode_ext)) {
+        if ( ! is_readable($shortcode_path.DS.$shortcode_class.$shortcode_ext)) {
             $msg = sprintf(
                 esc_html__(
                     'The requested %1$s shortcode file could not be found or is not readable due to file permissions. It should be in %2$s',
                     'event_espresso'
                 ),
                 $shortcode_class,
-                $shortcode_path . DS . $shortcode_class . $shortcode_ext
+                $shortcode_path.DS.$shortcode_class.$shortcode_ext
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         // load the shortcode class file
-        require_once($shortcode_path . $shortcode_class . $shortcode_ext);
+        require_once($shortcode_path.$shortcode_class.$shortcode_ext);
         // verify that class exists
-        if (! class_exists($shortcode_class)) {
+        if ( ! class_exists($shortcode_class)) {
             $msg = sprintf(
                 esc_html__('The requested %s shortcode class does not exist.', 'event_espresso'),
                 $shortcode_class
             );
-            EE_Error::add_error($msg . '||' . $msg, __FILE__, __FUNCTION__, __LINE__);
+            EE_Error::add_error($msg.'||'.$msg, __FILE__, __FUNCTION__, __LINE__);
             return false;
         }
         $shortcode = strtoupper($shortcode);
         // add to array of registered shortcodes
-        $this->registry->shortcodes->{$shortcode} = $shortcode_path . $shortcode_class . $shortcode_ext;
+        $this->registry->shortcodes->{$shortcode} = $shortcode_path.$shortcode_class.$shortcode_ext;
         return true;
     }
 
@@ -173,7 +173,7 @@ 
         // cycle thru shortcode folders
         foreach ($this->registry->shortcodes as $shortcode => $shortcode_path) {
             // add class prefix
-            $shortcode_class = 'EES_' . $shortcode;
+            $shortcode_class = 'EES_'.$shortcode;
             // fire the shortcode class's set_hooks methods in case it needs to hook into other parts of the system
             // which set hooks ?
             if (is_admin()) {
@@ -189,7 +189,7 @@ 
                 $shortcode_tag = strtoupper($shortcode);
                 // but first check if the shortcode has already
                 // been added before assigning 'fallback_shortcode_processor'
-                if (! shortcode_exists($shortcode_tag)) {
+                if ( ! shortcode_exists($shortcode_tag)) {
                     // NOTE: this shortcode declaration will get overridden if the shortcode
                     // is successfully detected in the post content in initializeShortcode()
                     add_shortcode($shortcode_tag, array($shortcode_class, 'fallback_shortcode_processor'));
@@ -395,7 +395,7 @@ 
      */
     public static function addShortcodeClassPrefix($class_name)
     {
-        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_' . $class_name;
+        return strpos($class_name, 'EES_') === 0 ? $class_name : 'EES_'.$class_name;
     }
 
 

core/services/formatters/Windows1252.php

Indentation +30 added lines, -30 removed lines

@@ -17,34 +17,34 @@
 class Windows1252 extends FormatterBase
 {
 
-    /**
-     * Converts the string to windows-1252 encoding.
-     *
-     * @param string|int|float $input anything easily cast into a string
-     * @return string
-     */
-    public function format($input)
-    {
-        // in case an int or float etc was passed in
-        $input = (string) $input;
-        if (function_exists('iconv')) {
-            $input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
-        } elseif (WP_DEBUG) {
-            trigger_error(
-                sprintf(
-                // @codingStandardsIgnoreStart
-                    esc_html__(
-                        '%1$s could not format the string "%2$s" because the function "%3$s" does not exist. Please verify PHP is installed with this function, see %4$s',
-                        'event_espresso'
-                    ),
-                    // @codingStandardsIgnoreEnd
-                    get_class($this),
-                    $input,
-                    'iconv',
-                    '<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
-                )
-            );
-        }
-        return $input;
-    }
+	/**
+	 * Converts the string to windows-1252 encoding.
+	 *
+	 * @param string|int|float $input anything easily cast into a string
+	 * @return string
+	 */
+	public function format($input)
+	{
+		// in case an int or float etc was passed in
+		$input = (string) $input;
+		if (function_exists('iconv')) {
+			$input = iconv('utf-8', 'cp1252//TRANSLIT', $input);
+		} elseif (WP_DEBUG) {
+			trigger_error(
+				sprintf(
+				// @codingStandardsIgnoreStart
+					esc_html__(
+						'%1$s could not format the string "%2$s" because the function "%3$s" does not exist. Please verify PHP is installed with this function, see %4$s',
+						'event_espresso'
+					),
+					// @codingStandardsIgnoreEnd
+					get_class($this),
+					$input,
+					'iconv',
+					'<a href="http://php.net/manual/en/iconv.installation.php">http://php.net/manual/en/iconv.installation.php</a>'
+				)
+			);
+		}
+		return $input;
+	}
 }

core/services/collections/CollectionDetails.php

Indentation +347 added lines, -347 removed lines

@@ -42,351 +42,351 @@
 class CollectionDetails implements CollectionDetailsInterface
 {
 
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's spl_object_hash() as it's identifier
-     */
-    const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use each object's class name as it's identifier
-     */
-    const ID_CLASS_NAME = 'identifier-uses-object-class-name';
-
-    /**
-     * if $identifier_type is set to this,
-     * then the collection will use the return value from a specified callback method on each object
-     */
-    const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
-
-    /**
-     * The interface used for controlling what gets added to the collection
-     *
-     * @var string $collection_interface
-     */
-    protected $collection_interface = '';
-
-    /**
-     * a unique name used to identify the collection in filter names
-     * supplied value is run through sanitize_title_with_dashes(),
-     * but then also converts dashes to underscores
-     *
-     * @var string $collection_name
-     */
-    protected $collection_name = '';
-
-    /**
-     * what the collection uses for the object identifier.
-     * corresponds to one of the class constants above.
-     * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
-     * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
-     * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
-     * defaults to using spl_object_hash() so that multiple objects of the same class can be added
-     *
-     * @var string $identifier_type
-     */
-    protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
-
-    /**
-     * the pattern applied to paths when searching for class files to add to the collection
-     * ie: "My_Awesome_*.class.php"
-     * defaults to "*.php"
-     *
-     * @var string $file_mask
-     */
-    protected $file_mask = '';
-
-    /**
-     * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
-     * then this specifies the method to use on each entity.
-     * If the callback method does not exist, then an exception will be thrown
-     *
-     * @var string $identifier_callback
-     */
-    protected $identifier_callback = '';
-
-    /**
-     * an array of Fully Qualified Class Names
-     *  for example:
-     *  $FQCNs = array(
-     *      '/Fully/Qualified/ClassNameA'
-     *      '/Fully/Qualified/Other/ClassNameB'
-     *  );
-     *
-     * @var array $collection_FQCNs
-     */
-    protected $collection_FQCNs = array();
-
-    /**
-     * an array of full server paths to folders containing files to be loaded into collection
-     *  for example:
-     *  $paths = array(
-     *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
-     *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
-     *  );
-     *
-     * @var array $collection_paths
-     */
-    protected $collection_paths = array();
-
-    /**
-     * @var LocatorInterface $file_locator
-     */
-    protected $file_locator;
-
-
-    /**
-     * CollectionDetails constructor.
-     *
-     * @access public
-     * @param string           $collection_name
-     * @param string           $collection_interface
-     * @param array            $collection_FQCNs
-     * @param array            $collection_paths
-     * @param string           $file_mask
-     * @param string           $identifier_type
-     * @param string           $identifier_callback
-     * @param LocatorInterface $file_locator
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    public function __construct(
-        $collection_name,
-        $collection_interface,
-        $collection_FQCNs = array(),
-        $collection_paths = array(),
-        $file_mask = '',
-        $identifier_type = CollectionDetails::ID_OBJECT_HASH,
-        $identifier_callback = '',
-        LocatorInterface $file_locator = null
-    ) {
-        $this->setCollectionName($collection_name);
-        $this->setCollectionInterface($collection_interface);
-        $this->setCollectionFQCNs($collection_FQCNs);
-        $this->setCollectionPaths($collection_paths);
-        $this->setFileMasks($file_mask);
-        $this->setIdentifierType($identifier_type);
-        $this->setIdentifierCallback($identifier_callback);
-        $this->file_locator = $file_locator;
-    }
-
-
-    /**
-     * @access public
-     * @return mixed
-     */
-    public function getCollectionInterface()
-    {
-        return $this->collection_interface;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    protected function setCollectionInterface($collection_interface)
-    {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
-            throw new InvalidInterfaceException($collection_interface);
-        }
-        $this->collection_interface = $collection_interface;
-    }
-
-
-    /**
-     * the collection name will be used for creating dynamic filters
-     *
-     * @access public
-     * @return string
-     */
-    public function collectionName()
-    {
-        return $this->collection_name;
-    }
-
-
-    /**
-     * sanitizes collection name and converts spaces and dashes to underscores
-     *
-     * @access protected
-     * @param string $collection_name
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setCollectionName($collection_name)
-    {
-        if (! is_string($collection_name)) {
-            throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
-        }
-        $this->collection_name = str_replace(
-            '-',
-            '_',
-            sanitize_title_with_dashes($collection_name, '', 'save')
-        );
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierType()
-    {
-        return $this->identifier_type;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_type
-     * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
-     */
-    protected function setIdentifierType($identifier_type)
-    {
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
-               || $identifier_type === CollectionDetails::ID_OBJECT_HASH
-               || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
-        )) {
-            throw new InvalidIdentifierException(
-                $identifier_type,
-                'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
-            );
-        }
-        $this->identifier_type = $identifier_type;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function identifierCallback()
-    {
-        return $this->identifier_callback;
-    }
-
-
-    /**
-     * @access protected
-     * @param string $identifier_callback
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setIdentifierCallback($identifier_callback = 'identifier')
-    {
-        if (! is_string($identifier_callback)) {
-            throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
-        }
-        $this->identifier_callback = $identifier_callback;
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getFileMask()
-    {
-        return $this->file_mask;
-    }
-
-
-    /**
-     * sets the file mask which is then used to filter what files get loaded
-     * when searching for classes to add to the collection. Defaults to '*.php'
-     *
-     * @access protected
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setFileMasks($file_mask)
-    {
-        $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
-        // we know our default is a string, so if it's not a string now,
-        // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
-        }
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getCollectionFQCNs()
-    {
-        return $this->collection_FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_FQCNs
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setCollectionFQCNs($collection_FQCNs)
-    {
-        foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
-                if (class_exists($collection_FQCN)) {
-                    $this->collection_FQCNs[] = $collection_FQCN;
-                } else {
-                    foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
-                        $this->collection_FQCNs[] = $FQCN;
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * @access protected
-     * @param  string $partial_FQCN
-     * @return array
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getFQCNsFromPartialNamespace($partial_FQCN)
-    {
-        if (! $this->file_locator instanceof FqcnLocator) {
-            $this->file_locator = new FqcnLocator();
-        }
-        $this->file_locator->locate($partial_FQCN);
-        return $this->file_locator->getFQCNs();
-    }
-
-
-    /**
-     * @access public
-     * @return string
-     */
-    public function getCollectionPaths()
-    {
-        return $this->collection_paths;
-    }
-
-
-    /**
-     * @access public
-     * @param string|array $collection_paths
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     */
-    public function setCollectionPaths($collection_paths)
-    {
-        foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
-                    throw new InvalidFilePathException($collection_path);
-                }
-                $this->collection_paths[] = $collection_path;
-            }
-        }
-    }
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's spl_object_hash() as it's identifier
+	 */
+	const ID_OBJECT_HASH = 'identifier-uses-spl-object-hash';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use each object's class name as it's identifier
+	 */
+	const ID_CLASS_NAME = 'identifier-uses-object-class-name';
+
+	/**
+	 * if $identifier_type is set to this,
+	 * then the collection will use the return value from a specified callback method on each object
+	 */
+	const ID_CALLBACK_METHOD = 'identifier-uses-callback-method';
+
+	/**
+	 * The interface used for controlling what gets added to the collection
+	 *
+	 * @var string $collection_interface
+	 */
+	protected $collection_interface = '';
+
+	/**
+	 * a unique name used to identify the collection in filter names
+	 * supplied value is run through sanitize_title_with_dashes(),
+	 * but then also converts dashes to underscores
+	 *
+	 * @var string $collection_name
+	 */
+	protected $collection_name = '';
+
+	/**
+	 * what the collection uses for the object identifier.
+	 * corresponds to one of the class constants above.
+	 * CollectionDetails::ID_OBJECT_HASH will use spl_object_hash( object ) for the identifier
+	 * CollectionDetails::ID_CLASS_NAME will use get_class( object ) for the identifier
+	 * CollectionDetails::ID_CALLBACK_METHOD will use a callback for the identifier
+	 * defaults to using spl_object_hash() so that multiple objects of the same class can be added
+	 *
+	 * @var string $identifier_type
+	 */
+	protected $identifier_type = CollectionDetails::ID_OBJECT_HASH;
+
+	/**
+	 * the pattern applied to paths when searching for class files to add to the collection
+	 * ie: "My_Awesome_*.class.php"
+	 * defaults to "*.php"
+	 *
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '';
+
+	/**
+	 * if the $identifier_type above is set to CollectionDetails::ID_CALLBACK_METHOD,
+	 * then this specifies the method to use on each entity.
+	 * If the callback method does not exist, then an exception will be thrown
+	 *
+	 * @var string $identifier_callback
+	 */
+	protected $identifier_callback = '';
+
+	/**
+	 * an array of Fully Qualified Class Names
+	 *  for example:
+	 *  $FQCNs = array(
+	 *      '/Fully/Qualified/ClassNameA'
+	 *      '/Fully/Qualified/Other/ClassNameB'
+	 *  );
+	 *
+	 * @var array $collection_FQCNs
+	 */
+	protected $collection_FQCNs = array();
+
+	/**
+	 * an array of full server paths to folders containing files to be loaded into collection
+	 *  for example:
+	 *  $paths = array(
+	 *      '/full/server/path/to/ClassNameA.ext.php' // for class ClassNameA
+	 *      '/full/server/path/to/other/ClassNameB.php' // for class ClassNameB
+	 *  );
+	 *
+	 * @var array $collection_paths
+	 */
+	protected $collection_paths = array();
+
+	/**
+	 * @var LocatorInterface $file_locator
+	 */
+	protected $file_locator;
+
+
+	/**
+	 * CollectionDetails constructor.
+	 *
+	 * @access public
+	 * @param string           $collection_name
+	 * @param string           $collection_interface
+	 * @param array            $collection_FQCNs
+	 * @param array            $collection_paths
+	 * @param string           $file_mask
+	 * @param string           $identifier_type
+	 * @param string           $identifier_callback
+	 * @param LocatorInterface $file_locator
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	public function __construct(
+		$collection_name,
+		$collection_interface,
+		$collection_FQCNs = array(),
+		$collection_paths = array(),
+		$file_mask = '',
+		$identifier_type = CollectionDetails::ID_OBJECT_HASH,
+		$identifier_callback = '',
+		LocatorInterface $file_locator = null
+	) {
+		$this->setCollectionName($collection_name);
+		$this->setCollectionInterface($collection_interface);
+		$this->setCollectionFQCNs($collection_FQCNs);
+		$this->setCollectionPaths($collection_paths);
+		$this->setFileMasks($file_mask);
+		$this->setIdentifierType($identifier_type);
+		$this->setIdentifierCallback($identifier_callback);
+		$this->file_locator = $file_locator;
+	}
+
+
+	/**
+	 * @access public
+	 * @return mixed
+	 */
+	public function getCollectionInterface()
+	{
+		return $this->collection_interface;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	protected function setCollectionInterface($collection_interface)
+	{
+		if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+			throw new InvalidInterfaceException($collection_interface);
+		}
+		$this->collection_interface = $collection_interface;
+	}
+
+
+	/**
+	 * the collection name will be used for creating dynamic filters
+	 *
+	 * @access public
+	 * @return string
+	 */
+	public function collectionName()
+	{
+		return $this->collection_name;
+	}
+
+
+	/**
+	 * sanitizes collection name and converts spaces and dashes to underscores
+	 *
+	 * @access protected
+	 * @param string $collection_name
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setCollectionName($collection_name)
+	{
+		if (! is_string($collection_name)) {
+			throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
+		}
+		$this->collection_name = str_replace(
+			'-',
+			'_',
+			sanitize_title_with_dashes($collection_name, '', 'save')
+		);
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierType()
+	{
+		return $this->identifier_type;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_type
+	 * @throws \EventEspresso\core\exceptions\InvalidIdentifierException
+	 */
+	protected function setIdentifierType($identifier_type)
+	{
+		if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+			   || $identifier_type === CollectionDetails::ID_OBJECT_HASH
+			   || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
+		)) {
+			throw new InvalidIdentifierException(
+				$identifier_type,
+				'CollectionDetails::ID_CLASS_NAME or CollectionDetails::ID_OBJECT_HASH or CollectionDetails::ID_CALLBACK_METHOD'
+			);
+		}
+		$this->identifier_type = $identifier_type;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function identifierCallback()
+	{
+		return $this->identifier_callback;
+	}
+
+
+	/**
+	 * @access protected
+	 * @param string $identifier_callback
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setIdentifierCallback($identifier_callback = 'identifier')
+	{
+		if (! is_string($identifier_callback)) {
+			throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
+		}
+		$this->identifier_callback = $identifier_callback;
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getFileMask()
+	{
+		return $this->file_mask;
+	}
+
+
+	/**
+	 * sets the file mask which is then used to filter what files get loaded
+	 * when searching for classes to add to the collection. Defaults to '*.php'
+	 *
+	 * @access protected
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setFileMasks($file_mask)
+	{
+		$this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
+		// we know our default is a string, so if it's not a string now,
+		// then that means the incoming parameter was something else
+		if (! is_string($this->file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
+		}
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getCollectionFQCNs()
+	{
+		return $this->collection_FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_FQCNs
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setCollectionFQCNs($collection_FQCNs)
+	{
+		foreach ((array) $collection_FQCNs as $collection_FQCN) {
+			if (! empty($collection_FQCN)) {
+				if (class_exists($collection_FQCN)) {
+					$this->collection_FQCNs[] = $collection_FQCN;
+				} else {
+					foreach ($this->getFQCNsFromPartialNamespace($collection_FQCN) as $FQCN) {
+						$this->collection_FQCNs[] = $FQCN;
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * @access protected
+	 * @param  string $partial_FQCN
+	 * @return array
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getFQCNsFromPartialNamespace($partial_FQCN)
+	{
+		if (! $this->file_locator instanceof FqcnLocator) {
+			$this->file_locator = new FqcnLocator();
+		}
+		$this->file_locator->locate($partial_FQCN);
+		return $this->file_locator->getFQCNs();
+	}
+
+
+	/**
+	 * @access public
+	 * @return string
+	 */
+	public function getCollectionPaths()
+	{
+		return $this->collection_paths;
+	}
+
+
+	/**
+	 * @access public
+	 * @param string|array $collection_paths
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 */
+	public function setCollectionPaths($collection_paths)
+	{
+		foreach ((array) $collection_paths as $collection_path) {
+			if (! empty($collection_path)) {
+				if (! is_readable($collection_path)) {
+					throw new InvalidFilePathException($collection_path);
+				}
+				$this->collection_paths[] = $collection_path;
+			}
+		}
+	}
 }

Spacing +9 added lines, -9 removed lines

@@ -192,7 +192,7 @@ 
      */
     protected function setCollectionInterface($collection_interface)
     {
-        if (! (interface_exists($collection_interface) || class_exists($collection_interface))) {
+        if ( ! (interface_exists($collection_interface) || class_exists($collection_interface))) {
             throw new InvalidInterfaceException($collection_interface);
         }
         $this->collection_interface = $collection_interface;
@@ -220,7 +220,7 @@ 
      */
     protected function setCollectionName($collection_name)
     {
-        if (! is_string($collection_name)) {
+        if ( ! is_string($collection_name)) {
             throw new InvalidDataTypeException('$collection_name', $collection_name, 'string');
         }
         $this->collection_name = str_replace(
@@ -248,7 +248,7 @@ 
      */
     protected function setIdentifierType($identifier_type)
     {
-        if (! ($identifier_type === CollectionDetails::ID_CLASS_NAME
+        if ( ! ($identifier_type === CollectionDetails::ID_CLASS_NAME
                || $identifier_type === CollectionDetails::ID_OBJECT_HASH
                || $identifier_type === CollectionDetails::ID_CALLBACK_METHOD
         )) {
@@ -278,7 +278,7 @@ 
      */
     protected function setIdentifierCallback($identifier_callback = 'identifier')
     {
-        if (! is_string($identifier_callback)) {
+        if ( ! is_string($identifier_callback)) {
             throw new InvalidDataTypeException('$identifier_callback', $identifier_callback, 'string');
         }
         $this->identifier_callback = $identifier_callback;
@@ -308,7 +308,7 @@ 
         $this->file_mask = ! empty($file_mask) ? $file_mask : '*.php';
         // we know our default is a string, so if it's not a string now,
         // then that means the incoming parameter was something else
-        if (! is_string($this->file_mask)) {
+        if ( ! is_string($this->file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $this->file_mask, 'string');
         }
     }
@@ -333,7 +333,7 @@ 
     public function setCollectionFQCNs($collection_FQCNs)
     {
         foreach ((array) $collection_FQCNs as $collection_FQCN) {
-            if (! empty($collection_FQCN)) {
+            if ( ! empty($collection_FQCN)) {
                 if (class_exists($collection_FQCN)) {
                     $this->collection_FQCNs[] = $collection_FQCN;
                 } else {
@@ -355,7 +355,7 @@ 
      */
     protected function getFQCNsFromPartialNamespace($partial_FQCN)
     {
-        if (! $this->file_locator instanceof FqcnLocator) {
+        if ( ! $this->file_locator instanceof FqcnLocator) {
             $this->file_locator = new FqcnLocator();
         }
         $this->file_locator->locate($partial_FQCN);
@@ -381,8 +381,8 @@ 
     public function setCollectionPaths($collection_paths)
     {
         foreach ((array) $collection_paths as $collection_path) {
-            if (! empty($collection_path)) {
-                if (! is_readable($collection_path)) {
+            if ( ! empty($collection_path)) {
+                if ( ! is_readable($collection_path)) {
                     throw new InvalidFilePathException($collection_path);
                 }
                 $this->collection_paths[] = $collection_path;

core/services/licensing/LicenseService.php

Indentation +90 added lines, -90 removed lines

@@ -15,94 +15,94 @@
  */
 class LicenseService
 {
-    /**
-     * @var Config
-     */
-    private $config;
-
-
-    /**
-     * @var Stats
-     */
-    private $stats_collection;
-
-    public function __construct(Stats $stats_collection, Config $config)
-    {
-        $this->config = $config;
-        $this->stats_collection = $stats_collection;
-        $this->loadPueClient();
-    }
-
-    private function loadPueClient()
-    {
-        // PUE Auto Upgrades stuff
-        if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { // include the file
-            require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
-
-            // $options needs to be an array with the included keys as listed.
-            $options = array(
-                // 'optionName' => '', //(optional) - used as the reference for saving update information in the
-                // clients options table.  Will be automatically set if left blank.
-                'apikey'                => $this->config->siteLicenseKey(),
-                // (required), you will need to obtain the apikey that the client gets from your site and
-                // then saves in their sites options table (see 'getting an api-key' below)
-                'lang_domain'           => $this->config->i18nDomain(),
-                // (optional) - put here whatever reference you are using for the localization of your plugin (if it's
-                // localized).  That way strings in this file will be included in the translation for your plugin.
-                'checkPeriod'           => $this->config->checkPeriod(),
-                // (optional) - use this parameter to indicate how often you want the client's install to ping your
-                // server for update checks.  The integer indicates hours.  If you don't include this parameter it will
-                // default to 12 hours.
-                'option_key'            => $this->config->optionKey(),
-                // this is what is used to reference the api_key in your plugin options.  PUE uses this to trigger
-                // updating your information message whenever this option_key is modified.
-                'options_page_slug'     => $this->config->optionsPageSlug(),
-                'plugin_basename'       => EE_PLUGIN_BASENAME,
-                'use_wp_update'         => true,
-                // if TRUE then you want FREE versions of the plugin to be updated from WP
-                'extra_stats'           => $this->stats_collection->statsCallback(),
-                'turn_on_notices_saved' => true,
-            );
-            // initiate the class and start the plugin update engine!
-            new PluginUpdateEngineChecker(
-                $this->config->hostServerUrl(),
-                $this->config->pluginSlug(),
-                $options
-            );
-        }
-    }
-
-
-    /**
-     * This is a handy helper method for retrieving whether there is an update available for the given plugin.
-     *
-     * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
-     *                          identify plugins. Defaults to core update
-     * @return boolean           True if update available, false if not.
-     */
-    public static function isUpdateAvailable($basename = '')
-    {
-        $basename = ! empty($basename) ? $basename : EE_PLUGIN_BASENAME;
-
-        $update = false;
-
-        // should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
-        $folder = DS . dirname($basename);
-
-        $plugins = get_plugins($folder);
-        $current = get_site_transient('update_plugins');
-
-        foreach ((array) $plugins as $plugin_file => $plugin_data) {
-            if (isset($current->response['plugin_file'])) {
-                $update = true;
-            }
-        }
-
-        // it's possible that there is an update but an invalid site-license-key is in use
-        if (get_site_option('pue_json_error_' . $basename)) {
-            $update = true;
-        }
-
-        return $update;
-    }
+	/**
+	 * @var Config
+	 */
+	private $config;
+
+
+	/**
+	 * @var Stats
+	 */
+	private $stats_collection;
+
+	public function __construct(Stats $stats_collection, Config $config)
+	{
+		$this->config = $config;
+		$this->stats_collection = $stats_collection;
+		$this->loadPueClient();
+	}
+
+	private function loadPueClient()
+	{
+		// PUE Auto Upgrades stuff
+		if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { // include the file
+			require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
+
+			// $options needs to be an array with the included keys as listed.
+			$options = array(
+				// 'optionName' => '', //(optional) - used as the reference for saving update information in the
+				// clients options table.  Will be automatically set if left blank.
+				'apikey'                => $this->config->siteLicenseKey(),
+				// (required), you will need to obtain the apikey that the client gets from your site and
+				// then saves in their sites options table (see 'getting an api-key' below)
+				'lang_domain'           => $this->config->i18nDomain(),
+				// (optional) - put here whatever reference you are using for the localization of your plugin (if it's
+				// localized).  That way strings in this file will be included in the translation for your plugin.
+				'checkPeriod'           => $this->config->checkPeriod(),
+				// (optional) - use this parameter to indicate how often you want the client's install to ping your
+				// server for update checks.  The integer indicates hours.  If you don't include this parameter it will
+				// default to 12 hours.
+				'option_key'            => $this->config->optionKey(),
+				// this is what is used to reference the api_key in your plugin options.  PUE uses this to trigger
+				// updating your information message whenever this option_key is modified.
+				'options_page_slug'     => $this->config->optionsPageSlug(),
+				'plugin_basename'       => EE_PLUGIN_BASENAME,
+				'use_wp_update'         => true,
+				// if TRUE then you want FREE versions of the plugin to be updated from WP
+				'extra_stats'           => $this->stats_collection->statsCallback(),
+				'turn_on_notices_saved' => true,
+			);
+			// initiate the class and start the plugin update engine!
+			new PluginUpdateEngineChecker(
+				$this->config->hostServerUrl(),
+				$this->config->pluginSlug(),
+				$options
+			);
+		}
+	}
+
+
+	/**
+	 * This is a handy helper method for retrieving whether there is an update available for the given plugin.
+	 *
+	 * @param  string $basename Use the equivalent result from plugin_basename() for this param as WP uses that to
+	 *                          identify plugins. Defaults to core update
+	 * @return boolean           True if update available, false if not.
+	 */
+	public static function isUpdateAvailable($basename = '')
+	{
+		$basename = ! empty($basename) ? $basename : EE_PLUGIN_BASENAME;
+
+		$update = false;
+
+		// should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
+		$folder = DS . dirname($basename);
+
+		$plugins = get_plugins($folder);
+		$current = get_site_transient('update_plugins');
+
+		foreach ((array) $plugins as $plugin_file => $plugin_data) {
+			if (isset($current->response['plugin_file'])) {
+				$update = true;
+			}
+		}
+
+		// it's possible that there is an update but an invalid site-license-key is in use
+		if (get_site_option('pue_json_error_' . $basename)) {
+			$update = true;
+		}
+
+		return $update;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -36,8 +36,8 @@ 
     private function loadPueClient()
     {
         // PUE Auto Upgrades stuff
-        if (is_readable(EE_THIRD_PARTY . 'pue/pue-client.php')) { // include the file
-            require_once(EE_THIRD_PARTY . 'pue/pue-client.php');
+        if (is_readable(EE_THIRD_PARTY.'pue/pue-client.php')) { // include the file
+            require_once(EE_THIRD_PARTY.'pue/pue-client.php');
 
             // $options needs to be an array with the included keys as listed.
             $options = array(
@@ -87,7 +87,7 @@ 
         $update = false;
 
         // should take "event-espresso-core/espresso.php" and change to "/event-espresso-core"
-        $folder = DS . dirname($basename);
+        $folder = DS.dirname($basename);
 
         $plugins = get_plugins($folder);
         $current = get_site_transient('update_plugins');
@@ -99,7 +99,7 @@ 
         }
 
         // it's possible that there is an update but an invalid site-license-key is in use
-        if (get_site_option('pue_json_error_' . $basename)) {
+        if (get_site_option('pue_json_error_'.$basename)) {
             $update = true;
         }
 

core/services/address/formatters/MultiLineAddressFormatter.php

Indentation +35 added lines, -35 removed lines

@@ -15,39 +15,39 @@
 {
 
 
-    /**
-     * @param string $address
-     * @param string $address2
-     * @param string $city
-     * @param string $state
-     * @param string $zip
-     * @param string $country
-     * @param string $CNT_ISO
-     * @return string
-     */
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
-    {
-        $address_formats = apply_filters(
-            'FHEE__EE_MultiLine_Address_Formatter__address_formats',
-            array(
-                'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}",
-                'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-            )
-        );
-        // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
-            : $address_formats['ZZ'];
-        return $this->parse_formatted_address(
-            $address,
-            $address2,
-            $city,
-            $state,
-            $zip,
-            $country,
-            $formatted_address,
-            '<br />'
-        );
-    }
+	/**
+	 * @param string $address
+	 * @param string $address2
+	 * @param string $city
+	 * @param string $state
+	 * @param string $zip
+	 * @param string $country
+	 * @param string $CNT_ISO
+	 * @return string
+	 */
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
+	{
+		$address_formats = apply_filters(
+			'FHEE__EE_MultiLine_Address_Formatter__address_formats',
+			array(
+				'CA' => "{address}%{address2}%{city}%{state}%{country}%{zip}",
+				'GB' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'US' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'ZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+			)
+		);
+		// if the incoming country has a set format, use that, else use the default
+		$formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+			: $address_formats['ZZ'];
+		return $this->parse_formatted_address(
+			$address,
+			$address2,
+			$city,
+			$state,
+			$zip,
+			$country,
+			$formatted_address,
+			'<br />'
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -37,7 +37,7 @@
             )
         );
         // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+        $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO]
             : $address_formats['ZZ'];
         return $this->parse_formatted_address(
             $address,

core/services/address/formatters/InlineAddressFormatter.php

Indentation +35 added lines, -35 removed lines

@@ -14,39 +14,39 @@
 class InlineAddressFormatter extends AddressFormatter implements \EEI_Address_Formatter
 {
 
-    /**
-     * @param string $address
-     * @param string $address2
-     * @param string $city
-     * @param string $state
-     * @param string $zip
-     * @param string $country
-     * @param string $CNT_ISO
-     * @return string
-     */
-    public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
-    {
-        $address_formats = apply_filters(
-            'FHEE__EE_Inline_Address_Formatter__address_formats',
-            array(
-                'CA'  => "{address}%{address2}%{city}%{state}%{country}%{zip}",
-                'GB'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'US'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-                'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
-            )
-        );
-        // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
-            : $address_formats['ZZZ'];
-        return $this->parse_formatted_address(
-            $address,
-            $address2,
-            $city,
-            $state,
-            $zip,
-            $country,
-            $formatted_address,
-            ', '
-        );
-    }
+	/**
+	 * @param string $address
+	 * @param string $address2
+	 * @param string $city
+	 * @param string $state
+	 * @param string $zip
+	 * @param string $country
+	 * @param string $CNT_ISO
+	 * @return string
+	 */
+	public function format($address, $address2, $city, $state, $zip, $country, $CNT_ISO)
+	{
+		$address_formats = apply_filters(
+			'FHEE__EE_Inline_Address_Formatter__address_formats',
+			array(
+				'CA'  => "{address}%{address2}%{city}%{state}%{country}%{zip}",
+				'GB'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'US'  => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+				'ZZZ' => "{address}%{address2}%{city}%{state}%{zip}%{country}",
+			)
+		);
+		// if the incoming country has a set format, use that, else use the default
+		$formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+			: $address_formats['ZZZ'];
+		return $this->parse_formatted_address(
+			$address,
+			$address2,
+			$city,
+			$state,
+			$zip,
+			$country,
+			$formatted_address,
+			', '
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -36,7 +36,7 @@
             )
         );
         // if the incoming country has a set format, use that, else use the default
-        $formatted_address = isset($address_formats[ $CNT_ISO ]) ? $address_formats[ $CNT_ISO ]
+        $formatted_address = isset($address_formats[$CNT_ISO]) ? $address_formats[$CNT_ISO]
             : $address_formats['ZZZ'];
         return $this->parse_formatted_address(
             $address,

core/services/notifications/PersistentAdminNoticeManager.php

Indentation +371 added lines, -371 removed lines

@@ -30,375 +30,375 @@
 class PersistentAdminNoticeManager
 {
 
-    const WP_OPTION_KEY = 'ee_pers_admin_notices';
-
-    /**
-     * @var Collection|PersistentAdminNotice[] $notice_collection
-     */
-    private $notice_collection;
-
-    /**
-     * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
-     * persistent admin notice was displayed, and ultimately dismissed from.
-     *
-     * @var string $return_url
-     */
-    private $return_url;
-
-    /**
-     * @var CapabilitiesChecker $capabilities_checker
-     */
-    private $capabilities_checker;
-
-    /**
-     * @var EE_Request $request
-     */
-    private $request;
-
-
-    /**
-     * PersistentAdminNoticeManager constructor
-     *
-     * @param string              $return_url where to  redirect to after dismissing notices
-     * @param CapabilitiesChecker $capabilities_checker
-     * @param EE_Request          $request
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, EE_Request $request)
-    {
-        $this->setReturnUrl($return_url);
-        $this->capabilities_checker = $capabilities_checker;
-        $this->request = $request;
-        // setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
-        // and we want to retrieve and generate any nag notices at the last possible moment
-        add_action('admin_notices', array($this, 'displayNotices'), 9);
-        add_action('network_admin_notices', array($this, 'displayNotices'), 9);
-        add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
-        add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
-    }
-
-
-    /**
-     * @param string $return_url
-     * @throws InvalidDataTypeException
-     */
-    public function setReturnUrl($return_url)
-    {
-        if (! is_string($return_url)) {
-            throw new InvalidDataTypeException('$return_url', $return_url, 'string');
-        }
-        $this->return_url = $return_url;
-    }
-
-
-    /**
-     * @return Collection
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    protected function getPersistentAdminNoticeCollection()
-    {
-        if (! $this->notice_collection instanceof Collection) {
-            $this->notice_collection = new Collection(
-                'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
-            );
-            $this->retrieveStoredNotices();
-            $this->registerNotices();
-        }
-        return $this->notice_collection;
-    }
-
-
-    /**
-     * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
-     *
-     * @return void
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     */
-    protected function retrieveStoredNotices()
-    {
-        $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-        // \EEH_Debug_Tools::printr($persistent_admin_notices, '$persistent_admin_notices', __FILE__, __LINE__);
-        if (! empty($persistent_admin_notices)) {
-            foreach ($persistent_admin_notices as $name => $details) {
-                if (is_array($details)) {
-                    if (! isset(
-                        $details['message'],
-                        $details['capability'],
-                        $details['cap_context'],
-                        $details['dismissed']
-                    )) {
-                        throw new DomainException(
-                            sprintf(
-                                esc_html__(
-                                    'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
-                                    'event_espresso'
-                                ),
-                                $name
-                            )
-                        );
-                    }
-                    // new format for nag notices
-                    $this->notice_collection->add(
-                        new PersistentAdminNotice(
-                            $name,
-                            $details['message'],
-                            false,
-                            $details['capability'],
-                            $details['cap_context'],
-                            $details['dismissed']
-                        ),
-                        $name
-                    );
-                } else {
-                    try {
-                        // old nag notices, that we want to convert to the new format
-                        $this->notice_collection->add(
-                            new PersistentAdminNotice(
-                                $name,
-                                (string) $details,
-                                false,
-                                '',
-                                '',
-                                empty($details)
-                            ),
-                            $name
-                        );
-                    } catch (Exception $e) {
-                        EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-                    }
-                }
-                // each notice will self register when the action hook in registerNotices is triggered
-            }
-        }
-    }
-
-
-    /**
-     * exposes the Persistent Admin Notice Collection via an action
-     * so that PersistentAdminNotice objects can be added and/or removed
-     * without compromising the actual collection like a filter would
-     */
-    protected function registerNotices()
-    {
-        do_action(
-            'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
-            $this->notice_collection
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidClassException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     */
-    public function displayNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $enqueue_assets = false;
-            // and display notices
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                /** @var PersistentAdminNotice $persistent_admin_notice */
-                // don't display notices that have already been dismissed
-                if ($persistent_admin_notice->getDismissed()) {
-                    continue;
-                }
-                try {
-                    $this->capabilities_checker->processCapCheck(
-                        $persistent_admin_notice->getCapCheck()
-                    );
-                } catch (InsufficientPermissionsException $e) {
-                    // user does not have required cap, so skip to next notice
-                    // and just eat the exception - nom nom nom nom
-                    continue;
-                }
-                if ($persistent_admin_notice->getMessage() === '') {
-                    continue;
-                }
-                $this->displayPersistentAdminNotice($persistent_admin_notice);
-                $enqueue_assets = true;
-            }
-            if ($enqueue_assets) {
-                $this->enqueueAssets();
-            }
-        }
-    }
-
-
-    /**
-     * does what it's named
-     *
-     * @return void
-     */
-    public function enqueueAssets()
-    {
-        wp_register_script(
-            'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
-            array('jquery'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_register_script(
-            'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
-            array('espresso_core'),
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_localize_script(
-            'ee_error_js',
-            'ee_dismiss',
-            array(
-                'return_url'    => urlencode($this->return_url),
-                'ajax_url'      => WP_AJAX_URL,
-                'unknown_error' => esc_html__(
-                    'An unknown error has occurred on the server while attempting to dismiss this notice.',
-                    'event_espresso'
-                ),
-            )
-        );
-        wp_enqueue_script('ee_error_js');
-    }
-
-
-    /**
-     * displayPersistentAdminNoticeHtml
-     *
-     * @param  PersistentAdminNotice $persistent_admin_notice
-     */
-    protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
-    {
-        // used in template
-        $persistent_admin_notice_name = $persistent_admin_notice->getName();
-        $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . DS . 'notifications' . DS . 'persistent_admin_notice.template.php';
-    }
-
-
-    /**
-     * dismissNotice
-     *
-     * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
-     * @param bool   $purge    if true, then delete it from the db
-     * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
-     * @return void
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     */
-    public function dismissNotice($pan_name = '', $purge = false, $return = false)
-    {
-        $pan_name = $this->request->get('ee_nag_notice', $pan_name);
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
-            /** @var PersistentAdminNotice $persistent_admin_notice */
-            $persistent_admin_notice = $this->notice_collection->get($pan_name);
-            $persistent_admin_notice->setDismissed(true);
-            $persistent_admin_notice->setPurge($purge);
-            $this->saveNotices();
-        }
-        if ($return) {
-            return;
-        }
-        if ($this->request->ajax) {
-            // grab any notices and concatenate into string
-            echo wp_json_encode(
-                array(
-                    'errors' => implode('<br />', EE_Error::get_notices(false)),
-                )
-            );
-            exit();
-        }
-        // save errors to a transient to be displayed on next request (after redirect)
-        EE_Error::get_notices(false, true);
-        wp_safe_redirect(
-            urldecode(
-                $this->request->get('return_url', '')
-            )
-        );
-    }
-
-
-    /**
-     * saveNotices
-     *
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidEntityException
-     */
-    public function saveNotices()
-    {
-        $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if ($this->notice_collection->hasObjects()) {
-            $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
-            // maybe initialize persistent_admin_notices
-            if (empty($persistent_admin_notices)) {
-                add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
-            }
-            foreach ($this->notice_collection as $persistent_admin_notice) {
-                // are we deleting this notice ?
-                if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
-                } else {
-                    /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
-                        'message'     => $persistent_admin_notice->getMessage(),
-                        'capability'  => $persistent_admin_notice->getCapability(),
-                        'cap_context' => $persistent_admin_notice->getCapContext(),
-                        'dismissed'   => $persistent_admin_notice->getDismissed(),
-                    );
-                }
-            }
-            update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
-        }
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     */
-    public function registerAndSaveNotices()
-    {
-        $this->getPersistentAdminNoticeCollection();
-        $this->registerNotices();
-        $this->saveNotices();
-        add_filter(
-            'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function loadRegisterAndSaveNotices()
-    {
-        /** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
-        $persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
-        );
-        // if shutdown has already run, then call registerAndSaveNotices() manually
-        if (did_action('shutdown')) {
-            $persistent_admin_notice_manager->registerAndSaveNotices();
-        }
-    }
+	const WP_OPTION_KEY = 'ee_pers_admin_notices';
+
+	/**
+	 * @var Collection|PersistentAdminNotice[] $notice_collection
+	 */
+	private $notice_collection;
+
+	/**
+	 * if AJAX is not enabled, then the return URL will be used for redirecting back to the admin page where the
+	 * persistent admin notice was displayed, and ultimately dismissed from.
+	 *
+	 * @var string $return_url
+	 */
+	private $return_url;
+
+	/**
+	 * @var CapabilitiesChecker $capabilities_checker
+	 */
+	private $capabilities_checker;
+
+	/**
+	 * @var EE_Request $request
+	 */
+	private $request;
+
+
+	/**
+	 * PersistentAdminNoticeManager constructor
+	 *
+	 * @param string              $return_url where to  redirect to after dismissing notices
+	 * @param CapabilitiesChecker $capabilities_checker
+	 * @param EE_Request          $request
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($return_url = '', CapabilitiesChecker $capabilities_checker, EE_Request $request)
+	{
+		$this->setReturnUrl($return_url);
+		$this->capabilities_checker = $capabilities_checker;
+		$this->request = $request;
+		// setup up notices at priority 9 because `EE_Admin::display_admin_notices()` runs at priority 10,
+		// and we want to retrieve and generate any nag notices at the last possible moment
+		add_action('admin_notices', array($this, 'displayNotices'), 9);
+		add_action('network_admin_notices', array($this, 'displayNotices'), 9);
+		add_action('wp_ajax_dismiss_ee_nag_notice', array($this, 'dismissNotice'));
+		add_action('shutdown', array($this, 'registerAndSaveNotices'), 998);
+	}
+
+
+	/**
+	 * @param string $return_url
+	 * @throws InvalidDataTypeException
+	 */
+	public function setReturnUrl($return_url)
+	{
+		if (! is_string($return_url)) {
+			throw new InvalidDataTypeException('$return_url', $return_url, 'string');
+		}
+		$this->return_url = $return_url;
+	}
+
+
+	/**
+	 * @return Collection
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	protected function getPersistentAdminNoticeCollection()
+	{
+		if (! $this->notice_collection instanceof Collection) {
+			$this->notice_collection = new Collection(
+				'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
+			);
+			$this->retrieveStoredNotices();
+			$this->registerNotices();
+		}
+		return $this->notice_collection;
+	}
+
+
+	/**
+	 * generates PersistentAdminNotice objects for all non-dismissed notices saved to the db
+	 *
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function retrieveStoredNotices()
+	{
+		$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+		// \EEH_Debug_Tools::printr($persistent_admin_notices, '$persistent_admin_notices', __FILE__, __LINE__);
+		if (! empty($persistent_admin_notices)) {
+			foreach ($persistent_admin_notices as $name => $details) {
+				if (is_array($details)) {
+					if (! isset(
+						$details['message'],
+						$details['capability'],
+						$details['cap_context'],
+						$details['dismissed']
+					)) {
+						throw new DomainException(
+							sprintf(
+								esc_html__(
+									'The "%1$s" PersistentAdminNotice could not be retrieved from the database.',
+									'event_espresso'
+								),
+								$name
+							)
+						);
+					}
+					// new format for nag notices
+					$this->notice_collection->add(
+						new PersistentAdminNotice(
+							$name,
+							$details['message'],
+							false,
+							$details['capability'],
+							$details['cap_context'],
+							$details['dismissed']
+						),
+						$name
+					);
+				} else {
+					try {
+						// old nag notices, that we want to convert to the new format
+						$this->notice_collection->add(
+							new PersistentAdminNotice(
+								$name,
+								(string) $details,
+								false,
+								'',
+								'',
+								empty($details)
+							),
+							$name
+						);
+					} catch (Exception $e) {
+						EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+					}
+				}
+				// each notice will self register when the action hook in registerNotices is triggered
+			}
+		}
+	}
+
+
+	/**
+	 * exposes the Persistent Admin Notice Collection via an action
+	 * so that PersistentAdminNotice objects can be added and/or removed
+	 * without compromising the actual collection like a filter would
+	 */
+	protected function registerNotices()
+	{
+		do_action(
+			'AHEE__EventEspresso_core_services_notifications_PersistentAdminNoticeManager__registerNotices',
+			$this->notice_collection
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidClassException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 */
+	public function displayNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$enqueue_assets = false;
+			// and display notices
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				/** @var PersistentAdminNotice $persistent_admin_notice */
+				// don't display notices that have already been dismissed
+				if ($persistent_admin_notice->getDismissed()) {
+					continue;
+				}
+				try {
+					$this->capabilities_checker->processCapCheck(
+						$persistent_admin_notice->getCapCheck()
+					);
+				} catch (InsufficientPermissionsException $e) {
+					// user does not have required cap, so skip to next notice
+					// and just eat the exception - nom nom nom nom
+					continue;
+				}
+				if ($persistent_admin_notice->getMessage() === '') {
+					continue;
+				}
+				$this->displayPersistentAdminNotice($persistent_admin_notice);
+				$enqueue_assets = true;
+			}
+			if ($enqueue_assets) {
+				$this->enqueueAssets();
+			}
+		}
+	}
+
+
+	/**
+	 * does what it's named
+	 *
+	 * @return void
+	 */
+	public function enqueueAssets()
+	{
+		wp_register_script(
+			'espresso_core',
+			EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+			array('jquery'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_register_script(
+			'ee_error_js',
+			EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+			array('espresso_core'),
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_localize_script(
+			'ee_error_js',
+			'ee_dismiss',
+			array(
+				'return_url'    => urlencode($this->return_url),
+				'ajax_url'      => WP_AJAX_URL,
+				'unknown_error' => esc_html__(
+					'An unknown error has occurred on the server while attempting to dismiss this notice.',
+					'event_espresso'
+				),
+			)
+		);
+		wp_enqueue_script('ee_error_js');
+	}
+
+
+	/**
+	 * displayPersistentAdminNoticeHtml
+	 *
+	 * @param  PersistentAdminNotice $persistent_admin_notice
+	 */
+	protected function displayPersistentAdminNotice(PersistentAdminNotice $persistent_admin_notice)
+	{
+		// used in template
+		$persistent_admin_notice_name = $persistent_admin_notice->getName();
+		$persistent_admin_notice_message = $persistent_admin_notice->getMessage();
+		require EE_TEMPLATES . DS . 'notifications' . DS . 'persistent_admin_notice.template.php';
+	}
+
+
+	/**
+	 * dismissNotice
+	 *
+	 * @param string $pan_name the name, or key of the Persistent Admin Notice to be dismissed
+	 * @param bool   $purge    if true, then delete it from the db
+	 * @param bool   $return   forget all of this AJAX or redirect nonsense, and just return
+	 * @return void
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 */
+	public function dismissNotice($pan_name = '', $purge = false, $return = false)
+	{
+		$pan_name = $this->request->get('ee_nag_notice', $pan_name);
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+			/** @var PersistentAdminNotice $persistent_admin_notice */
+			$persistent_admin_notice = $this->notice_collection->get($pan_name);
+			$persistent_admin_notice->setDismissed(true);
+			$persistent_admin_notice->setPurge($purge);
+			$this->saveNotices();
+		}
+		if ($return) {
+			return;
+		}
+		if ($this->request->ajax) {
+			// grab any notices and concatenate into string
+			echo wp_json_encode(
+				array(
+					'errors' => implode('<br />', EE_Error::get_notices(false)),
+				)
+			);
+			exit();
+		}
+		// save errors to a transient to be displayed on next request (after redirect)
+		EE_Error::get_notices(false, true);
+		wp_safe_redirect(
+			urldecode(
+				$this->request->get('return_url', '')
+			)
+		);
+	}
+
+
+	/**
+	 * saveNotices
+	 *
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidEntityException
+	 */
+	public function saveNotices()
+	{
+		$this->notice_collection = $this->getPersistentAdminNoticeCollection();
+		if ($this->notice_collection->hasObjects()) {
+			$persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
+			// maybe initialize persistent_admin_notices
+			if (empty($persistent_admin_notices)) {
+				add_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array(), '', 'no');
+			}
+			foreach ($this->notice_collection as $persistent_admin_notice) {
+				// are we deleting this notice ?
+				if ($persistent_admin_notice->getPurge()) {
+					unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+				} else {
+					/** @var PersistentAdminNotice $persistent_admin_notice */
+					$persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
+						'message'     => $persistent_admin_notice->getMessage(),
+						'capability'  => $persistent_admin_notice->getCapability(),
+						'cap_context' => $persistent_admin_notice->getCapContext(),
+						'dismissed'   => $persistent_admin_notice->getDismissed(),
+					);
+				}
+			}
+			update_option(PersistentAdminNoticeManager::WP_OPTION_KEY, $persistent_admin_notices);
+		}
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 */
+	public function registerAndSaveNotices()
+	{
+		$this->getPersistentAdminNoticeCollection();
+		$this->registerNotices();
+		$this->saveNotices();
+		add_filter(
+			'PersistentAdminNoticeManager__registerAndSaveNotices__complete',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function loadRegisterAndSaveNotices()
+	{
+		/** @var PersistentAdminNoticeManager $persistent_admin_notice_manager */
+		$persistent_admin_notice_manager = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\notifications\PersistentAdminNoticeManager'
+		);
+		// if shutdown has already run, then call registerAndSaveNotices() manually
+		if (did_action('shutdown')) {
+			$persistent_admin_notice_manager->registerAndSaveNotices();
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -84,7 +84,7 @@ 
      */
     public function setReturnUrl($return_url)
     {
-        if (! is_string($return_url)) {
+        if ( ! is_string($return_url)) {
             throw new InvalidDataTypeException('$return_url', $return_url, 'string');
         }
         $this->return_url = $return_url;
@@ -100,7 +100,7 @@ 
      */
     protected function getPersistentAdminNoticeCollection()
     {
-        if (! $this->notice_collection instanceof Collection) {
+        if ( ! $this->notice_collection instanceof Collection) {
             $this->notice_collection = new Collection(
                 'EventEspresso\core\domain\entities\notifications\PersistentAdminNotice'
             );
@@ -123,10 +123,10 @@ 
     {
         $persistent_admin_notices = get_option(PersistentAdminNoticeManager::WP_OPTION_KEY, array());
         // \EEH_Debug_Tools::printr($persistent_admin_notices, '$persistent_admin_notices', __FILE__, __LINE__);
-        if (! empty($persistent_admin_notices)) {
+        if ( ! empty($persistent_admin_notices)) {
             foreach ($persistent_admin_notices as $name => $details) {
                 if (is_array($details)) {
-                    if (! isset(
+                    if ( ! isset(
                         $details['message'],
                         $details['capability'],
                         $details['cap_context'],
@@ -242,14 +242,14 @@ 
     {
         wp_register_script(
             'espresso_core',
-            EE_GLOBAL_ASSETS_URL . 'scripts/espresso_core.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/espresso_core.js',
             array('jquery'),
             EVENT_ESPRESSO_VERSION,
             true
         );
         wp_register_script(
             'ee_error_js',
-            EE_GLOBAL_ASSETS_URL . 'scripts/EE_Error.js',
+            EE_GLOBAL_ASSETS_URL.'scripts/EE_Error.js',
             array('espresso_core'),
             EVENT_ESPRESSO_VERSION,
             true
@@ -280,7 +280,7 @@ 
         // used in template
         $persistent_admin_notice_name = $persistent_admin_notice->getName();
         $persistent_admin_notice_message = $persistent_admin_notice->getMessage();
-        require EE_TEMPLATES . DS . 'notifications' . DS . 'persistent_admin_notice.template.php';
+        require EE_TEMPLATES.DS.'notifications'.DS.'persistent_admin_notice.template.php';
     }
 
 
@@ -300,7 +300,7 @@ 
     {
         $pan_name = $this->request->get('ee_nag_notice', $pan_name);
         $this->notice_collection = $this->getPersistentAdminNoticeCollection();
-        if (! empty($pan_name) && $this->notice_collection->has($pan_name)) {
+        if ( ! empty($pan_name) && $this->notice_collection->has($pan_name)) {
             /** @var PersistentAdminNotice $persistent_admin_notice */
             $persistent_admin_notice = $this->notice_collection->get($pan_name);
             $persistent_admin_notice->setDismissed(true);
@@ -349,10 +349,10 @@ 
             foreach ($this->notice_collection as $persistent_admin_notice) {
                 // are we deleting this notice ?
                 if ($persistent_admin_notice->getPurge()) {
-                    unset($persistent_admin_notices[ $persistent_admin_notice->getName() ]);
+                    unset($persistent_admin_notices[$persistent_admin_notice->getName()]);
                 } else {
                     /** @var PersistentAdminNotice $persistent_admin_notice */
-                    $persistent_admin_notices[ $persistent_admin_notice->getName() ] = array(
+                    $persistent_admin_notices[$persistent_admin_notice->getName()] = array(
                         'message'     => $persistent_admin_notice->getMessage(),
                         'capability'  => $persistent_admin_notice->getCapability(),
                         'cap_context' => $persistent_admin_notice->getCapContext(),

core/services/locators/FileLocator.php

Indentation +73 added lines, -73 removed lines

@@ -17,88 +17,88 @@
 class FileLocator extends Locator
 {
 
-    /**
-     * @var string $file_mask
-     */
-    protected $file_mask = '*.php';
+	/**
+	 * @var string $file_mask
+	 */
+	protected $file_mask = '*.php';
 
-    /**
-     * @var array $filepaths
-     */
-    protected $filepaths = array();
+	/**
+	 * @var array $filepaths
+	 */
+	protected $filepaths = array();
 
 
-    /**
-     * @param string $file_mask
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function setFileMask($file_mask)
-    {
-        if (! is_string($file_mask)) {
-            throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
-        }
-        $this->file_mask = $file_mask;
-    }
+	/**
+	 * @param string $file_mask
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function setFileMask($file_mask)
+	{
+		if (! is_string($file_mask)) {
+			throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
+		}
+		$this->file_mask = $file_mask;
+	}
 
 
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFilePaths()
-    {
-        return $this->filepaths;
-    }
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFilePaths()
+	{
+		return $this->filepaths;
+	}
 
 
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->filepaths);
-    }
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->filepaths);
+	}
 
 
-    /**
-     * given a path to a valid directory, or an array of valid paths,
-     * will find all files that match the provided mask
-     *
-     * @access public
-     * @param array|string $directory_paths
-     * @return \FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($directory_paths)
-    {
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
-            throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
-        }
-        foreach ((array) $directory_paths as $directory_path) {
-            foreach ($this->findFilesByPath($directory_path) as $key => $file) {
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
-            }
-        }
-        return $this->filepaths;
-    }
+	/**
+	 * given a path to a valid directory, or an array of valid paths,
+	 * will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param array|string $directory_paths
+	 * @return \FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($directory_paths)
+	{
+		if (! (is_string($directory_paths) || is_array($directory_paths))) {
+			throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
+		}
+		foreach ((array) $directory_paths as $directory_path) {
+			foreach ($this->findFilesByPath($directory_path) as $key => $file) {
+				$this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
+			}
+		}
+		return $this->filepaths;
+	}
 
 
-    /**
-     * given a path to a valid directory, will find all files that match the provided mask
-     *
-     * @access protected
-     * @param string $directory_path
-     * @return \FilesystemIterator
-     */
-    protected function findFilesByPath($directory_path = '')
-    {
-        $iterator = new GlobIterator(
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        return $iterator;
-    }
+	/**
+	 * given a path to a valid directory, will find all files that match the provided mask
+	 *
+	 * @access protected
+	 * @param string $directory_path
+	 * @return \FilesystemIterator
+	 */
+	protected function findFilesByPath($directory_path = '')
+	{
+		$iterator = new GlobIterator(
+			\EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		return $iterator;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
      */
     public function setFileMask($file_mask)
     {
-        if (! is_string($file_mask)) {
+        if ( ! is_string($file_mask)) {
             throw new InvalidDataTypeException('$file_mask', $file_mask, 'string');
         }
         $this->file_mask = $file_mask;
@@ -72,12 +72,12 @@ 
      */
     public function locate($directory_paths)
     {
-        if (! (is_string($directory_paths) || is_array($directory_paths))) {
+        if ( ! (is_string($directory_paths) || is_array($directory_paths))) {
             throw new InvalidDataTypeException('$directory_paths', $directory_paths, 'string or array');
         }
         foreach ((array) $directory_paths as $directory_path) {
             foreach ($this->findFilesByPath($directory_path) as $key => $file) {
-                $this->filepaths[ $key ] = \EEH_File::standardise_directory_separators($file);
+                $this->filepaths[$key] = \EEH_File::standardise_directory_separators($file);
             }
         }
         return $this->filepaths;
@@ -94,7 +94,7 @@ 
     protected function findFilesByPath($directory_path = '')
     {
         $iterator = new GlobIterator(
-            \EEH_File::end_with_directory_separator($directory_path) . $this->file_mask
+            \EEH_File::end_with_directory_separator($directory_path).$this->file_mask
         );
         foreach ($this->flags as $flag) {
             $iterator->setFlags($flag);