eventespresso / event-espresso-core

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/CollectionLoader.php

Indentation +255 added lines, -255 removed lines

@@ -21,282 +21,282 @@
 class CollectionLoader
 {
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was NOT ADDED to the collection
-     */
-    const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was NOT ADDED to the collection
+	 */
+	const ENTITY_NOT_ADDED = 'entity-not-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was SUCCESSFULLY ADDED to the collection
-     */
-    const ENTITY_ADDED = 'entity-added-to-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was SUCCESSFULLY ADDED to the collection
+	 */
+	const ENTITY_ADDED = 'entity-added-to-collection';
 
-    /**
-     * possible return value when adding entities to a collection.
-     * denotes that the entity was ALREADY ADDED to the collection,
-     * and therefore could not be added again.
-     */
-    const ENTITY_EXISTS = 'entity-already-in-collection';
+	/**
+	 * possible return value when adding entities to a collection.
+	 * denotes that the entity was ALREADY ADDED to the collection,
+	 * and therefore could not be added again.
+	 */
+	const ENTITY_EXISTS = 'entity-already-in-collection';
 
 
-    /**
-     * @var CollectionDetailsInterface $collection_details
-     */
-    protected $collection_details;
+	/**
+	 * @var CollectionDetailsInterface $collection_details
+	 */
+	protected $collection_details;
 
-    /**
-     * @var CollectionInterface $collection
-     */
-    protected $collection;
+	/**
+	 * @var CollectionInterface $collection
+	 */
+	protected $collection;
 
-    /**
-     * @var FileLocator $file_locator
-     */
-    protected $file_locator;
+	/**
+	 * @var FileLocator $file_locator
+	 */
+	protected $file_locator;
 
 
-    /**
-     * CollectionLoader constructor.
-     *
-     * @param CollectionDetailsInterface $collection_details
-     * @param CollectionInterface        $collection
-     * @param LocatorInterface           $file_locator
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    public function __construct(
-        CollectionDetailsInterface $collection_details,
-        CollectionInterface $collection = null,
-        LocatorInterface $file_locator = null
-    ) {
-        $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
-            $collection = new Collection($this->collection_details->getCollectionInterface());
-        }
-        $this->collection = $collection;
-        $this->file_locator = $file_locator;
-        $this->loadAllFromFilepaths();
-        $this->loadFromFQCNs();
-    }
+	/**
+	 * CollectionLoader constructor.
+	 *
+	 * @param CollectionDetailsInterface $collection_details
+	 * @param CollectionInterface        $collection
+	 * @param LocatorInterface           $file_locator
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	public function __construct(
+		CollectionDetailsInterface $collection_details,
+		CollectionInterface $collection = null,
+		LocatorInterface $file_locator = null
+	) {
+		$this->collection_details = $collection_details;
+		if (! $collection instanceof CollectionInterface) {
+			$collection = new Collection($this->collection_details->getCollectionInterface());
+		}
+		$this->collection = $collection;
+		$this->file_locator = $file_locator;
+		$this->loadAllFromFilepaths();
+		$this->loadFromFQCNs();
+	}
 
 
-    /**
-     * @access public
-     * @return \EventEspresso\core\services\collections\CollectionInterface
-     */
-    public function getCollection()
-    {
-        return $this->collection;
-    }
+	/**
+	 * @access public
+	 * @return \EventEspresso\core\services\collections\CollectionInterface
+	 */
+	public function getCollection()
+	{
+		return $this->collection;
+	}
 
 
-    /**
-     * @access protected
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    protected function loadAllFromFilepaths()
-    {
-        if (! $this->file_locator instanceof FileLocator) {
-            $this->file_locator = new FileLocator();
-        }
-        $this->file_locator->setFileMask($this->collection_details->getFileMask());
-        // find all of the files that match the file mask in the specified folder
-        $this->file_locator->locate($this->collection_details->getCollectionPaths());
-        // filter the results
-        $filepaths = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
-            $this->file_locator->getFilePaths(),
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        if (empty($filepaths)) {
-            return;
-        }
-        foreach ($filepaths as $filepath) {
-            $this->loadClassFromFilepath($filepath);
-        }
-    }
+	/**
+	 * @access protected
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	protected function loadAllFromFilepaths()
+	{
+		if (! $this->file_locator instanceof FileLocator) {
+			$this->file_locator = new FileLocator();
+		}
+		$this->file_locator->setFileMask($this->collection_details->getFileMask());
+		// find all of the files that match the file mask in the specified folder
+		$this->file_locator->locate($this->collection_details->getCollectionPaths());
+		// filter the results
+		$filepaths = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFilepath__filepaths',
+			$this->file_locator->getFilePaths(),
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		if (empty($filepaths)) {
+			return;
+		}
+		foreach ($filepaths as $filepath) {
+			$this->loadClassFromFilepath($filepath);
+		}
+	}
 
 
-    /**
-     * loadClassFromFilepath
-     *
-     * @access protected
-     * @param  string $filepath
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidFilePathException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function loadClassFromFilepath($filepath)
-    {
-        if (! is_string($filepath)) {
-            throw new InvalidDataTypeException('$filepath', $filepath, 'string');
-        }
-        if (! is_readable($filepath)) {
-            throw new InvalidFilePathException($filepath);
-        }
-        require_once($filepath);
-        // extract filename from path
-        $file_name = basename($filepath);
-        // now remove any file extensions
-        $class_name = \EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
-            throw new InvalidClassException($class_name);
-        }
-        return $this->addEntityToCollection(new $class_name(), $file_name);
-    }
+	/**
+	 * loadClassFromFilepath
+	 *
+	 * @access protected
+	 * @param  string $filepath
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidFilePathException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function loadClassFromFilepath($filepath)
+	{
+		if (! is_string($filepath)) {
+			throw new InvalidDataTypeException('$filepath', $filepath, 'string');
+		}
+		if (! is_readable($filepath)) {
+			throw new InvalidFilePathException($filepath);
+		}
+		require_once($filepath);
+		// extract filename from path
+		$file_name = basename($filepath);
+		// now remove any file extensions
+		$class_name = \EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
+		if (! class_exists($class_name)) {
+			throw new InvalidClassException($class_name);
+		}
+		return $this->addEntityToCollection(new $class_name(), $file_name);
+	}
 
 
-    /**
-     * addEntityToCollection
-     *
-     * @access protected
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    protected function addEntityToCollection($entity, $identifier)
-    {
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity',
-            $entity,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        $identifier = $this->setIdentifier($entity, $identifier);
-        if ($this->collection->has($identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_EXISTS;
-        }
-        if ($this->collection->add($entity, $identifier)) {
-            do_action(
-                'FHEE__CollectionLoader__addEntityToCollection__entity_added',
-                $this,
-                $this->collection_details->collectionName(),
-                $this->collection_details
-            );
-            return CollectionLoader::ENTITY_ADDED;
-        }
-        do_action(
-            'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
-            $this,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        return CollectionLoader::ENTITY_NOT_ADDED;
-    }
+	/**
+	 * addEntityToCollection
+	 *
+	 * @access protected
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	protected function addEntityToCollection($entity, $identifier)
+	{
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity',
+			$entity,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		$identifier = $this->setIdentifier($entity, $identifier);
+		if ($this->collection->has($identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_already_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_EXISTS;
+		}
+		if ($this->collection->add($entity, $identifier)) {
+			do_action(
+				'FHEE__CollectionLoader__addEntityToCollection__entity_added',
+				$this,
+				$this->collection_details->collectionName(),
+				$this->collection_details
+			);
+			return CollectionLoader::ENTITY_ADDED;
+		}
+		do_action(
+			'FHEE__CollectionLoader__addEntityToCollection__entity_not_added',
+			$this,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		return CollectionLoader::ENTITY_NOT_ADDED;
+	}
 
 
-    /**
-     * setIdentifier
-     *
-     * @access protected
-     * @param        $entity
-     * @param  mixed $identifier
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    protected function setIdentifier($entity, $identifier)
-    {
-        switch ($this->collection_details->identifierType()) {
-            // every unique object gets added to the collection, but not duplicates of the exact same object
-            case CollectionDetails::ID_OBJECT_HASH:
-                $identifier = spl_object_hash($entity);
-                break;
-            // only one entity per class can be added to collection, like a singleton
-            case CollectionDetails::ID_CLASS_NAME:
-                $identifier = get_class($entity);
-                break;
-            // objects added to the collection based on entity callback, so the entity itself decides
-            case CollectionDetails::ID_CALLBACK_METHOD:
-                $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
-                    throw new InvalidEntityException(
-                        $entity,
-                        $this->collection_details->getCollectionInterface(),
-                        sprintf(
-                            __(
-                                'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
+	/**
+	 * setIdentifier
+	 *
+	 * @access protected
+	 * @param        $entity
+	 * @param  mixed $identifier
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	protected function setIdentifier($entity, $identifier)
+	{
+		switch ($this->collection_details->identifierType()) {
+			// every unique object gets added to the collection, but not duplicates of the exact same object
+			case CollectionDetails::ID_OBJECT_HASH:
+				$identifier = spl_object_hash($entity);
+				break;
+			// only one entity per class can be added to collection, like a singleton
+			case CollectionDetails::ID_CLASS_NAME:
+				$identifier = get_class($entity);
+				break;
+			// objects added to the collection based on entity callback, so the entity itself decides
+			case CollectionDetails::ID_CALLBACK_METHOD:
+				$identifier_callback = $this->collection_details->identifierCallback();
+				if (! method_exists($entity, $identifier_callback)) {
+					throw new InvalidEntityException(
+						$entity,
+						$this->collection_details->getCollectionInterface(),
+						sprintf(
+							__(
+								'The current collection is configured to use a method named "%1$s" when setting or retrieving objects. The supplied entity is an instance
                                 of "%2$s", but does not contain this method.',
-                                'event_espresso'
-                            ),
-                            $identifier_callback,
-                            get_class($entity)
-                        )
-                    );
-                }
-                $identifier = $entity->{$identifier_callback}();
-                break;
-        }
-        return apply_filters(
-            'FHEE__CollectionLoader__addEntityToCollection__identifier',
-            $identifier,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-    }
+								'event_espresso'
+							),
+							$identifier_callback,
+							get_class($entity)
+						)
+					);
+				}
+				$identifier = $entity->{$identifier_callback}();
+				break;
+		}
+		return apply_filters(
+			'FHEE__CollectionLoader__addEntityToCollection__identifier',
+			$identifier,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+	}
 
 
-    /**
-     * loadFromFQCNs
-     *
-     * @access protected
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    protected function loadFromFQCNs()
-    {
-        $FQCNs = $this->collection_details->getCollectionFQCNs();
-        $FQCNs = (array) apply_filters(
-            'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
-            $FQCNs,
-            $this->collection_details->collectionName(),
-            $this->collection_details
-        );
-        foreach ($FQCNs as $FQCN) {
-            $this->loadClassFromFQCN($FQCN);
-        }
-    }
+	/**
+	 * loadFromFQCNs
+	 *
+	 * @access protected
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	protected function loadFromFQCNs()
+	{
+		$FQCNs = $this->collection_details->getCollectionFQCNs();
+		$FQCNs = (array) apply_filters(
+			'FHEE__CollectionLoader__loadAllFromFQCNs__FQCNs',
+			$FQCNs,
+			$this->collection_details->collectionName(),
+			$this->collection_details
+		);
+		foreach ($FQCNs as $FQCN) {
+			$this->loadClassFromFQCN($FQCN);
+		}
+	}
 
 
-    /**
-     * loadClassFromFQCN
-     *
-     * @access protected
-     * @param  string $FQCN Fully Qualified Class Name
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function loadClassFromFQCN($FQCN)
-    {
-        if (! is_string($FQCN)) {
-            throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
-        }
-        if (! class_exists($FQCN)) {
-            throw new InvalidClassException($FQCN);
-        }
-        return $this->addEntityToCollection(
-            \EE_Registry::instance()->create($FQCN),
-            $FQCN
-        );
-    }
+	/**
+	 * loadClassFromFQCN
+	 *
+	 * @access protected
+	 * @param  string $FQCN Fully Qualified Class Name
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function loadClassFromFQCN($FQCN)
+	{
+		if (! is_string($FQCN)) {
+			throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
+		}
+		if (! class_exists($FQCN)) {
+			throw new InvalidClassException($FQCN);
+		}
+		return $this->addEntityToCollection(
+			\EE_Registry::instance()->create($FQCN),
+			$FQCN
+		);
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -75,7 +75,7 @@ 
         LocatorInterface $file_locator = null
     ) {
         $this->collection_details = $collection_details;
-        if (! $collection instanceof CollectionInterface) {
+        if ( ! $collection instanceof CollectionInterface) {
             $collection = new Collection($this->collection_details->getCollectionInterface());
         }
         $this->collection = $collection;
@@ -104,7 +104,7 @@ 
      */
     protected function loadAllFromFilepaths()
     {
-        if (! $this->file_locator instanceof FileLocator) {
+        if ( ! $this->file_locator instanceof FileLocator) {
             $this->file_locator = new FileLocator();
         }
         $this->file_locator->setFileMask($this->collection_details->getFileMask());
@@ -139,10 +139,10 @@ 
      */
     protected function loadClassFromFilepath($filepath)
     {
-        if (! is_string($filepath)) {
+        if ( ! is_string($filepath)) {
             throw new InvalidDataTypeException('$filepath', $filepath, 'string');
         }
-        if (! is_readable($filepath)) {
+        if ( ! is_readable($filepath)) {
             throw new InvalidFilePathException($filepath);
         }
         require_once($filepath);
@@ -150,7 +150,7 @@ 
         $file_name = basename($filepath);
         // now remove any file extensions
         $class_name = \EEH_File::get_classname_from_filepath_with_standard_filename($file_name);
-        if (! class_exists($class_name)) {
+        if ( ! class_exists($class_name)) {
             throw new InvalidClassException($class_name);
         }
         return $this->addEntityToCollection(new $class_name(), $file_name);
@@ -226,7 +226,7 @@ 
             // objects added to the collection based on entity callback, so the entity itself decides
             case CollectionDetails::ID_CALLBACK_METHOD:
                 $identifier_callback = $this->collection_details->identifierCallback();
-                if (! method_exists($entity, $identifier_callback)) {
+                if ( ! method_exists($entity, $identifier_callback)) {
                     throw new InvalidEntityException(
                         $entity,
                         $this->collection_details->getCollectionInterface(),
@@ -288,10 +288,10 @@ 
      */
     protected function loadClassFromFQCN($FQCN)
     {
-        if (! is_string($FQCN)) {
+        if ( ! is_string($FQCN)) {
             throw new InvalidDataTypeException('$FQCN', $FQCN, 'string');
         }
-        if (! class_exists($FQCN)) {
+        if ( ! class_exists($FQCN)) {
             throw new InvalidClassException($FQCN);
         }
         return $this->addEntityToCollection(

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/request/Request.php

Spacing +14 added lines, -14 removed lines

@@ -163,7 +163,7 @@ 
             || ($key === 'ee' && empty($this->request['ee']))
             || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
         ) {
-            $this->request[ $key ] = $value;
+            $this->request[$key] = $value;
         }
     }
 
@@ -254,10 +254,10 @@ 
             preg_quote($pattern, '/')
         );
         foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
+            if (preg_match('/^'.$pattern.'$/is', $key)) {
                 // return value for request param
                 if ($return === 'value') {
-                    return $request_params[ $key ];
+                    return $request_params[$key];
                 }
                 // or actual key or true just to indicate it was found
                 return $return === 'key' ? $key : true;
@@ -314,29 +314,29 @@ 
                 $key = $real_key ? $real_key : $key;
             }
             // check if top level key exists
-            if (isset($request_params[ $key ])) {
+            if (isset($request_params[$key])) {
                 // build a new key to pass along like: 'second[third]'
                 // or just 'second' depending on depth of keys
                 $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
+                if ( ! empty($keys)) {
+                    $key_string .= '['.implode('][', $keys).']';
                 }
                 return $this->requestParameterDrillDown(
                     $key_string,
                     $default,
                     $callback,
-                    $request_params[ $key ]
+                    $request_params[$key]
                 );
             }
         }
         if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
+            return isset($request_params[$key]);
         }
         if ($callback === 'match') {
             return $this->match($key, $request_params, $default);
         }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
+        return isset($request_params[$key])
+            ? $request_params[$key]
             : $default;
     }
 
@@ -349,9 +349,9 @@ 
      */
     public function unSetRequestParam($key, $unset_from_global_too = false)
     {
-        unset($this->request[ $key ]);
+        unset($this->request[$key]);
         if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
+            unset($_REQUEST[$key]);
         }
     }
 
@@ -385,8 +385,8 @@ 
             'REMOTE_ADDR',
         );
         foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+            if (isset($this->server[$key])) {
+                foreach (array_map('trim', explode(',', $this->server[$key])) as $ip) {
                     if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
                         $visitor_ip = $ip;
                     }

Indentation +573 added lines, -573 removed lines

@@ -17,577 +17,577 @@
 class Request implements InterminableInterface, RequestInterface, ReservedInstanceInterface
 {
 
-    /**
-     * $_GET parameters
-     *
-     * @var array $get
-     */
-    private $get;
-
-    /**
-     * $_POST parameters
-     *
-     * @var array $post
-     */
-    private $post;
-
-    /**
-     * $_COOKIE parameters
-     *
-     * @var array $cookie
-     */
-    private $cookie;
-
-    /**
-     * $_SERVER parameters
-     *
-     * @var array $server
-     */
-    private $server;
-
-    /**
-     * $_REQUEST parameters
-     *
-     * @var array $request
-     */
-    private $request;
-
-    /**
-     * @var RequestTypeContextCheckerInterface
-     */
-    private $request_type;
-
-    /**
-     * IP address for request
-     *
-     * @var string $ip_address
-     */
-    private $ip_address;
-
-    /**
-     * @var string $user_agent
-     */
-    private $user_agent;
-
-    /**
-     * true if current user appears to be some kind of bot
-     *
-     * @var bool $is_bot
-     */
-    private $is_bot;
-
-
-    /**
-     * @param array $get
-     * @param array $post
-     * @param array $cookie
-     * @param array $server
-     */
-    public function __construct(array $get, array $post, array $cookie, array $server)
-    {
-        // grab request vars
-        $this->get = $get;
-        $this->post = $post;
-        $this->cookie = $cookie;
-        $this->server = $server;
-        $this->request = array_merge($this->get, $this->post);
-        $this->ip_address = $this->visitorIp();
-    }
-
-
-    /**
-     * @param RequestTypeContextCheckerInterface $type
-     */
-    public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
-    {
-        $this->request_type = $type;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getParams()
-    {
-        return $this->get;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function postParams()
-    {
-        return $this->post;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function cookieParams()
-    {
-        return $this->cookie;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function serverParams()
-    {
-        return $this->server;
-    }
-
-
-    /**
-     * returns contents of $_REQUEST
-     *
-     * @return array
-     */
-    public function requestParams()
-    {
-        return $this->request;
-    }
-
-
-    /**
-     * @param      $key
-     * @param      $value
-     * @param bool $override_ee
-     * @return    void
-     */
-    public function setRequestParam($key, $value, $override_ee = false)
-    {
-        // don't allow "ee" to be overwritten unless explicitly instructed to do so
-        if ($key !== 'ee'
-            || ($key === 'ee' && empty($this->request['ee']))
-            || ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
-        ) {
-            $this->request[ $key ] = $value;
-        }
-    }
-
-
-    /**
-     * returns   the value for a request param if the given key exists
-     *
-     * @param       $key
-     * @param null  $default
-     * @return mixed
-     */
-    public function getRequestParam($key, $default = null)
-    {
-        return $this->requestParameterDrillDown($key, $default, 'get');
-    }
-
-
-    /**
-     * check if param exists
-     *
-     * @param       $key
-     * @return bool
-     */
-    public function requestParamIsSet($key)
-    {
-        return $this->requestParameterDrillDown($key);
-    }
-
-
-    /**
-     * check if a request parameter exists whose key that matches the supplied wildcard pattern
-     * and return the value for the first match found
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     *
-     * @param string     $pattern
-     * @param null|mixed $default
-     * @return false|int
-     */
-    public function getMatch($pattern, $default = null)
-    {
-        return $this->requestParameterDrillDown($pattern, $default, 'match');
-    }
-
-
-    /**
-     * check if a request parameter exists whose key matches the supplied wildcard pattern
-     * wildcards can be either of the following:
-     *      ? to represent a single character of any type
-     *      * to represent one or more characters of any type
-     * returns true if a match is found or false if not
-     *
-     * @param string $pattern
-     * @return false|int
-     */
-    public function matches($pattern)
-    {
-        return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
-    }
-
-
-    /**
-     * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
-     * @param string $pattern               A string including wildcards to be converted to a regex pattern
-     *                                      and used to search through the current request's parameter keys
-     * @param array  $request_params        The array of request parameters to search through
-     * @param mixed  $default               [optional] The value to be returned if no match is found.
-     *                                      Default is null
-     * @param string $return                [optional] Controls what kind of value is returned.
-     *                                      Options are:
-     *                                      'bool' will return true or false if match is found or not
-     *                                      'key' will return the first key found that matches the supplied pattern
-     *                                      'value' will return the value for the first request parameter
-     *                                      whose key matches the supplied pattern
-     *                                      Default is 'value'
-     * @return boolean|string
-     */
-    private function match($pattern, array $request_params, $default = null, $return = 'value')
-    {
-        $return = in_array($return, array('bool', 'key', 'value'), true)
-            ? $return
-            : 'is_set';
-        // replace wildcard chars with regex chars
-        $pattern = str_replace(
-            array("\*", "\?"),
-            array('.*', '.'),
-            preg_quote($pattern, '/')
-        );
-        foreach ($request_params as $key => $request_param) {
-            if (preg_match('/^' . $pattern . '$/is', $key)) {
-                // return value for request param
-                if ($return === 'value') {
-                    return $request_params[ $key ];
-                }
-                // or actual key or true just to indicate it was found
-                return $return === 'key' ? $key : true;
-            }
-        }
-        // match not found so return default value or false
-        return $return === 'value' ? $default : false;
-    }
-
-
-    /**
-     * the supplied key can be a simple string to represent a "top-level" request parameter
-     * or represent a key for a request parameter that is nested deeper within the request parameter array,
-     * by using square brackets to surround keys for deeper array elements.
-     * For example :
-     * if the supplied $key was: "first[second][third]"
-     * then this will attempt to drill down into the request parameter array to find a value.
-     * Given the following request parameters:
-     *  array(
-     *      'first' => array(
-     *          'second' => array(
-     *              'third' => 'has a value'
-     *          )
-     *      )
-     *  )
-     * would return true if default parameters were set
-     *
-     * @param string $callback
-     * @param        $key
-     * @param null   $default
-     * @param array  $request_params
-     * @return bool|mixed|null
-     */
-    private function requestParameterDrillDown(
-        $key,
-        $default = null,
-        $callback = 'is_set',
-        array $request_params = array()
-    ) {
-        $callback = in_array($callback, array('is_set', 'get', 'match'), true)
-            ? $callback
-            : 'is_set';
-        $request_params = ! empty($request_params)
-            ? $request_params
-            : $this->request;
-        // does incoming key represent an array like 'first[second][third]'  ?
-        if (strpos($key, '[') !== false) {
-            // turn it into an actual array
-            $key = str_replace(']', '', $key);
-            $keys = explode('[', $key);
-            $key = array_shift($keys);
-            if ($callback === 'match') {
-                $real_key = $this->match($key, $request_params, $default, 'key');
-                $key = $real_key ? $real_key : $key;
-            }
-            // check if top level key exists
-            if (isset($request_params[ $key ])) {
-                // build a new key to pass along like: 'second[third]'
-                // or just 'second' depending on depth of keys
-                $key_string = array_shift($keys);
-                if (! empty($keys)) {
-                    $key_string .= '[' . implode('][', $keys) . ']';
-                }
-                return $this->requestParameterDrillDown(
-                    $key_string,
-                    $default,
-                    $callback,
-                    $request_params[ $key ]
-                );
-            }
-        }
-        if ($callback === 'is_set') {
-            return isset($request_params[ $key ]);
-        }
-        if ($callback === 'match') {
-            return $this->match($key, $request_params, $default);
-        }
-        return isset($request_params[ $key ])
-            ? $request_params[ $key ]
-            : $default;
-    }
-
-
-    /**
-     * remove param
-     *
-     * @param      $key
-     * @param bool $unset_from_global_too
-     */
-    public function unSetRequestParam($key, $unset_from_global_too = false)
-    {
-        unset($this->request[ $key ]);
-        if ($unset_from_global_too) {
-            unset($_REQUEST[ $key ]);
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function ipAddress()
-    {
-        return $this->ip_address;
-    }
-
-
-    /**
-     * attempt to get IP address of current visitor from server
-     * plz see: http://stackoverflow.com/a/2031935/1475279
-     *
-     * @access public
-     * @return string
-     */
-    private function visitorIp()
-    {
-        $visitor_ip = '0.0.0.0';
-        $server_keys = array(
-            'HTTP_CLIENT_IP',
-            'HTTP_X_FORWARDED_FOR',
-            'HTTP_X_FORWARDED',
-            'HTTP_X_CLUSTER_CLIENT_IP',
-            'HTTP_FORWARDED_FOR',
-            'HTTP_FORWARDED',
-            'REMOTE_ADDR',
-        );
-        foreach ($server_keys as $key) {
-            if (isset($this->server[ $key ])) {
-                foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
-                    if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
-                        $visitor_ip = $ip;
-                    }
-                }
-            }
-        }
-        return $visitor_ip;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function requestUri()
-    {
-        $request_uri = filter_input(
-            INPUT_SERVER,
-            'REQUEST_URI',
-            FILTER_SANITIZE_URL,
-            FILTER_NULL_ON_FAILURE
-        );
-        if (empty($request_uri)) {
-            // fallback sanitization if the above fails
-            $request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
-        }
-        return $request_uri;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function userAgent()
-    {
-        return $this->user_agent;
-    }
-
-
-    /**
-     * @param string $user_agent
-     */
-    public function setUserAgent($user_agent = '')
-    {
-        if ($user_agent === '' || ! is_string($user_agent)) {
-            $user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
-        }
-        $this->user_agent = $user_agent;
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isBot()
-    {
-        return $this->is_bot;
-    }
-
-
-    /**
-     * @param bool $is_bot
-     */
-    public function setIsBot($is_bot)
-    {
-        $this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isActivation()
-    {
-        return $this->request_type->isActivation();
-    }
-
-
-    /**
-     * @param $is_activation
-     * @return bool
-     */
-    public function setIsActivation($is_activation)
-    {
-        return $this->request_type->setIsActivation($is_activation);
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdmin()
-    {
-        return $this->request_type->isAdmin();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAdminAjax()
-    {
-        return $this->request_type->isAdminAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isAjax()
-    {
-        return $this->request_type->isAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isEeAjax()
-    {
-        return $this->request_type->isEeAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isOtherAjax()
-    {
-        return $this->request_type->isOtherAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isApi()
-    {
-        return $this->request_type->isApi();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCli()
-    {
-        return $this->request_type->isCli();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isCron()
-    {
-        return $this->request_type->isCron();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFeed()
-    {
-        return $this->request_type->isFeed();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontend()
-    {
-        return $this->request_type->isFrontend();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isFrontAjax()
-    {
-        return $this->request_type->isFrontAjax();
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function isIframe()
-    {
-        return $this->request_type->isIframe();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function slug()
-    {
-        return $this->request_type->slug();
-    }
+	/**
+	 * $_GET parameters
+	 *
+	 * @var array $get
+	 */
+	private $get;
+
+	/**
+	 * $_POST parameters
+	 *
+	 * @var array $post
+	 */
+	private $post;
+
+	/**
+	 * $_COOKIE parameters
+	 *
+	 * @var array $cookie
+	 */
+	private $cookie;
+
+	/**
+	 * $_SERVER parameters
+	 *
+	 * @var array $server
+	 */
+	private $server;
+
+	/**
+	 * $_REQUEST parameters
+	 *
+	 * @var array $request
+	 */
+	private $request;
+
+	/**
+	 * @var RequestTypeContextCheckerInterface
+	 */
+	private $request_type;
+
+	/**
+	 * IP address for request
+	 *
+	 * @var string $ip_address
+	 */
+	private $ip_address;
+
+	/**
+	 * @var string $user_agent
+	 */
+	private $user_agent;
+
+	/**
+	 * true if current user appears to be some kind of bot
+	 *
+	 * @var bool $is_bot
+	 */
+	private $is_bot;
+
+
+	/**
+	 * @param array $get
+	 * @param array $post
+	 * @param array $cookie
+	 * @param array $server
+	 */
+	public function __construct(array $get, array $post, array $cookie, array $server)
+	{
+		// grab request vars
+		$this->get = $get;
+		$this->post = $post;
+		$this->cookie = $cookie;
+		$this->server = $server;
+		$this->request = array_merge($this->get, $this->post);
+		$this->ip_address = $this->visitorIp();
+	}
+
+
+	/**
+	 * @param RequestTypeContextCheckerInterface $type
+	 */
+	public function setRequestTypeContextChecker(RequestTypeContextCheckerInterface $type)
+	{
+		$this->request_type = $type;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getParams()
+	{
+		return $this->get;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function postParams()
+	{
+		return $this->post;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function cookieParams()
+	{
+		return $this->cookie;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function serverParams()
+	{
+		return $this->server;
+	}
+
+
+	/**
+	 * returns contents of $_REQUEST
+	 *
+	 * @return array
+	 */
+	public function requestParams()
+	{
+		return $this->request;
+	}
+
+
+	/**
+	 * @param      $key
+	 * @param      $value
+	 * @param bool $override_ee
+	 * @return    void
+	 */
+	public function setRequestParam($key, $value, $override_ee = false)
+	{
+		// don't allow "ee" to be overwritten unless explicitly instructed to do so
+		if ($key !== 'ee'
+			|| ($key === 'ee' && empty($this->request['ee']))
+			|| ($key === 'ee' && ! empty($this->request['ee']) && $override_ee)
+		) {
+			$this->request[ $key ] = $value;
+		}
+	}
+
+
+	/**
+	 * returns   the value for a request param if the given key exists
+	 *
+	 * @param       $key
+	 * @param null  $default
+	 * @return mixed
+	 */
+	public function getRequestParam($key, $default = null)
+	{
+		return $this->requestParameterDrillDown($key, $default, 'get');
+	}
+
+
+	/**
+	 * check if param exists
+	 *
+	 * @param       $key
+	 * @return bool
+	 */
+	public function requestParamIsSet($key)
+	{
+		return $this->requestParameterDrillDown($key);
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key that matches the supplied wildcard pattern
+	 * and return the value for the first match found
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 *
+	 * @param string     $pattern
+	 * @param null|mixed $default
+	 * @return false|int
+	 */
+	public function getMatch($pattern, $default = null)
+	{
+		return $this->requestParameterDrillDown($pattern, $default, 'match');
+	}
+
+
+	/**
+	 * check if a request parameter exists whose key matches the supplied wildcard pattern
+	 * wildcards can be either of the following:
+	 *      ? to represent a single character of any type
+	 *      * to represent one or more characters of any type
+	 * returns true if a match is found or false if not
+	 *
+	 * @param string $pattern
+	 * @return false|int
+	 */
+	public function matches($pattern)
+	{
+		return $this->requestParameterDrillDown($pattern, null, 'match') !== null;
+	}
+
+
+	/**
+	 * @see https://stackoverflow.com/questions/6163055/php-string-matching-with-wildcard
+	 * @param string $pattern               A string including wildcards to be converted to a regex pattern
+	 *                                      and used to search through the current request's parameter keys
+	 * @param array  $request_params        The array of request parameters to search through
+	 * @param mixed  $default               [optional] The value to be returned if no match is found.
+	 *                                      Default is null
+	 * @param string $return                [optional] Controls what kind of value is returned.
+	 *                                      Options are:
+	 *                                      'bool' will return true or false if match is found or not
+	 *                                      'key' will return the first key found that matches the supplied pattern
+	 *                                      'value' will return the value for the first request parameter
+	 *                                      whose key matches the supplied pattern
+	 *                                      Default is 'value'
+	 * @return boolean|string
+	 */
+	private function match($pattern, array $request_params, $default = null, $return = 'value')
+	{
+		$return = in_array($return, array('bool', 'key', 'value'), true)
+			? $return
+			: 'is_set';
+		// replace wildcard chars with regex chars
+		$pattern = str_replace(
+			array("\*", "\?"),
+			array('.*', '.'),
+			preg_quote($pattern, '/')
+		);
+		foreach ($request_params as $key => $request_param) {
+			if (preg_match('/^' . $pattern . '$/is', $key)) {
+				// return value for request param
+				if ($return === 'value') {
+					return $request_params[ $key ];
+				}
+				// or actual key or true just to indicate it was found
+				return $return === 'key' ? $key : true;
+			}
+		}
+		// match not found so return default value or false
+		return $return === 'value' ? $default : false;
+	}
+
+
+	/**
+	 * the supplied key can be a simple string to represent a "top-level" request parameter
+	 * or represent a key for a request parameter that is nested deeper within the request parameter array,
+	 * by using square brackets to surround keys for deeper array elements.
+	 * For example :
+	 * if the supplied $key was: "first[second][third]"
+	 * then this will attempt to drill down into the request parameter array to find a value.
+	 * Given the following request parameters:
+	 *  array(
+	 *      'first' => array(
+	 *          'second' => array(
+	 *              'third' => 'has a value'
+	 *          )
+	 *      )
+	 *  )
+	 * would return true if default parameters were set
+	 *
+	 * @param string $callback
+	 * @param        $key
+	 * @param null   $default
+	 * @param array  $request_params
+	 * @return bool|mixed|null
+	 */
+	private function requestParameterDrillDown(
+		$key,
+		$default = null,
+		$callback = 'is_set',
+		array $request_params = array()
+	) {
+		$callback = in_array($callback, array('is_set', 'get', 'match'), true)
+			? $callback
+			: 'is_set';
+		$request_params = ! empty($request_params)
+			? $request_params
+			: $this->request;
+		// does incoming key represent an array like 'first[second][third]'  ?
+		if (strpos($key, '[') !== false) {
+			// turn it into an actual array
+			$key = str_replace(']', '', $key);
+			$keys = explode('[', $key);
+			$key = array_shift($keys);
+			if ($callback === 'match') {
+				$real_key = $this->match($key, $request_params, $default, 'key');
+				$key = $real_key ? $real_key : $key;
+			}
+			// check if top level key exists
+			if (isset($request_params[ $key ])) {
+				// build a new key to pass along like: 'second[third]'
+				// or just 'second' depending on depth of keys
+				$key_string = array_shift($keys);
+				if (! empty($keys)) {
+					$key_string .= '[' . implode('][', $keys) . ']';
+				}
+				return $this->requestParameterDrillDown(
+					$key_string,
+					$default,
+					$callback,
+					$request_params[ $key ]
+				);
+			}
+		}
+		if ($callback === 'is_set') {
+			return isset($request_params[ $key ]);
+		}
+		if ($callback === 'match') {
+			return $this->match($key, $request_params, $default);
+		}
+		return isset($request_params[ $key ])
+			? $request_params[ $key ]
+			: $default;
+	}
+
+
+	/**
+	 * remove param
+	 *
+	 * @param      $key
+	 * @param bool $unset_from_global_too
+	 */
+	public function unSetRequestParam($key, $unset_from_global_too = false)
+	{
+		unset($this->request[ $key ]);
+		if ($unset_from_global_too) {
+			unset($_REQUEST[ $key ]);
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function ipAddress()
+	{
+		return $this->ip_address;
+	}
+
+
+	/**
+	 * attempt to get IP address of current visitor from server
+	 * plz see: http://stackoverflow.com/a/2031935/1475279
+	 *
+	 * @access public
+	 * @return string
+	 */
+	private function visitorIp()
+	{
+		$visitor_ip = '0.0.0.0';
+		$server_keys = array(
+			'HTTP_CLIENT_IP',
+			'HTTP_X_FORWARDED_FOR',
+			'HTTP_X_FORWARDED',
+			'HTTP_X_CLUSTER_CLIENT_IP',
+			'HTTP_FORWARDED_FOR',
+			'HTTP_FORWARDED',
+			'REMOTE_ADDR',
+		);
+		foreach ($server_keys as $key) {
+			if (isset($this->server[ $key ])) {
+				foreach (array_map('trim', explode(',', $this->server[ $key ])) as $ip) {
+					if ($ip === '127.0.0.1' || filter_var($ip, FILTER_VALIDATE_IP) !== false) {
+						$visitor_ip = $ip;
+					}
+				}
+			}
+		}
+		return $visitor_ip;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function requestUri()
+	{
+		$request_uri = filter_input(
+			INPUT_SERVER,
+			'REQUEST_URI',
+			FILTER_SANITIZE_URL,
+			FILTER_NULL_ON_FAILURE
+		);
+		if (empty($request_uri)) {
+			// fallback sanitization if the above fails
+			$request_uri = wp_sanitize_redirect($this->server['REQUEST_URI']);
+		}
+		return $request_uri;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function userAgent()
+	{
+		return $this->user_agent;
+	}
+
+
+	/**
+	 * @param string $user_agent
+	 */
+	public function setUserAgent($user_agent = '')
+	{
+		if ($user_agent === '' || ! is_string($user_agent)) {
+			$user_agent = isset($_SERVER['HTTP_USER_AGENT']) ? (string) esc_attr($_SERVER['HTTP_USER_AGENT']) : '';
+		}
+		$this->user_agent = $user_agent;
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isBot()
+	{
+		return $this->is_bot;
+	}
+
+
+	/**
+	 * @param bool $is_bot
+	 */
+	public function setIsBot($is_bot)
+	{
+		$this->is_bot = filter_var($is_bot, FILTER_VALIDATE_BOOLEAN);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isActivation()
+	{
+		return $this->request_type->isActivation();
+	}
+
+
+	/**
+	 * @param $is_activation
+	 * @return bool
+	 */
+	public function setIsActivation($is_activation)
+	{
+		return $this->request_type->setIsActivation($is_activation);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdmin()
+	{
+		return $this->request_type->isAdmin();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAdminAjax()
+	{
+		return $this->request_type->isAdminAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isAjax()
+	{
+		return $this->request_type->isAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isEeAjax()
+	{
+		return $this->request_type->isEeAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isOtherAjax()
+	{
+		return $this->request_type->isOtherAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isApi()
+	{
+		return $this->request_type->isApi();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCli()
+	{
+		return $this->request_type->isCli();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isCron()
+	{
+		return $this->request_type->isCron();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFeed()
+	{
+		return $this->request_type->isFeed();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontend()
+	{
+		return $this->request_type->isFrontend();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isFrontAjax()
+	{
+		return $this->request_type->isFrontAjax();
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function isIframe()
+	{
+		return $this->request_type->isIframe();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function slug()
+	{
+		return $this->request_type->slug();
+	}
 }

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/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);

core/services/locators/FqcnLocator.php

Indentation +143 added lines, -143 removed lines

@@ -17,147 +17,147 @@
 class FqcnLocator extends Locator
 {
 
-    /**
-     * @var array $FQCNs
-     */
-    protected $FQCNs = array();
-
-    /**
-     * @var array $namespaces
-     */
-    protected $namespaces = array();
-
-
-    /**
-     * @access protected
-     * @param string $namespace
-     * @param string $namespace_base_dir
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function setNamespace($namespace, $namespace_base_dir)
-    {
-        if (! is_string($namespace)) {
-            throw new InvalidDataTypeException('$namespace', $namespace, 'string');
-        }
-        if (! is_string($namespace_base_dir)) {
-            throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
-        }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
-    }
-
-
-    /**
-     * @access public
-     * @return array
-     */
-    public function getFQCNs()
-    {
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * @access public
-     * @return int
-     */
-    public function count()
-    {
-        return count($this->FQCNs);
-    }
-
-
-    /**
-     * given a valid namespace, will find all files that match the provided mask
-     *
-     * @access public
-     * @param string|array $namespaces
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    public function locate($namespaces)
-    {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
-            throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
-        }
-        foreach ((array) $namespaces as $namespace) {
-            foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * given a partial namespace, will find all files in that folder
-     * ** PLZ NOTE **
-     * This assumes that all files within the specified folder should be loaded
-     *
-     * @access protected
-     * @param array $partial_namespace
-     * @return FilesystemIterator
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     */
-    protected function FindFQCNsByNamespace($partial_namespace)
-    {
-        $iterator = new FilesystemIterator(
-            $this->getDirectoryFromPartialNamespace($partial_namespace)
-        );
-        foreach ($this->flags as $flag) {
-            $iterator->setFlags($flag);
-        }
-        if (iterator_count($iterator) === 0) {
-            return array();
-        }
-        foreach ($iterator as $file) {
-            $file = \EEH_File::standardise_directory_separators($file);
-            foreach ($this->namespaces as $namespace => $base_dir) {
-                $namespace .= Psr4Autoloader::NS;
-                if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
-                        array($base_dir, DS, '.php'),
-                        array($namespace, Psr4Autoloader::NS, ''),
-                        $file
-                    );
-                }
-            }
-        }
-        return $this->FQCNs;
-    }
-
-
-    /**
-     * getDirectoryFromPartialNamespace
-     *
-     * @access protected
-     * @param  string $partial_namespace almost fully qualified class name ?
-     * @return string
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidClassException
-     */
-    protected function getDirectoryFromPartialNamespace($partial_namespace)
-    {
-        if (empty($partial_namespace)) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        // load our PSR-4 Autoloader so we can get the list of registered namespaces from it
-        $psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
-        // breakup the incoming namespace into segments then loop thru them
-        $namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
-        // we're only interested in the first element, so pull that from the array
-        $namespace = array_shift($namespace_segments);
-        // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
-        // nope? then the incoming namespace is invalid
-        if (empty($prefix) || empty($prefix[0])) {
-            throw new InvalidClassException($partial_namespace);
-        }
-        $this->setNamespace($namespace, $prefix[0]);
-        // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
-    }
+	/**
+	 * @var array $FQCNs
+	 */
+	protected $FQCNs = array();
+
+	/**
+	 * @var array $namespaces
+	 */
+	protected $namespaces = array();
+
+
+	/**
+	 * @access protected
+	 * @param string $namespace
+	 * @param string $namespace_base_dir
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function setNamespace($namespace, $namespace_base_dir)
+	{
+		if (! is_string($namespace)) {
+			throw new InvalidDataTypeException('$namespace', $namespace, 'string');
+		}
+		if (! is_string($namespace_base_dir)) {
+			throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
+		}
+		$this->namespaces[ $namespace ] = $namespace_base_dir;
+	}
+
+
+	/**
+	 * @access public
+	 * @return array
+	 */
+	public function getFQCNs()
+	{
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * @access public
+	 * @return int
+	 */
+	public function count()
+	{
+		return count($this->FQCNs);
+	}
+
+
+	/**
+	 * given a valid namespace, will find all files that match the provided mask
+	 *
+	 * @access public
+	 * @param string|array $namespaces
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	public function locate($namespaces)
+	{
+		if (! (is_string($namespaces) || is_array($namespaces))) {
+			throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
+		}
+		foreach ((array) $namespaces as $namespace) {
+			foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
+				$this->FQCNs[ $key ] = $file;
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * given a partial namespace, will find all files in that folder
+	 * ** PLZ NOTE **
+	 * This assumes that all files within the specified folder should be loaded
+	 *
+	 * @access protected
+	 * @param array $partial_namespace
+	 * @return FilesystemIterator
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 */
+	protected function FindFQCNsByNamespace($partial_namespace)
+	{
+		$iterator = new FilesystemIterator(
+			$this->getDirectoryFromPartialNamespace($partial_namespace)
+		);
+		foreach ($this->flags as $flag) {
+			$iterator->setFlags($flag);
+		}
+		if (iterator_count($iterator) === 0) {
+			return array();
+		}
+		foreach ($iterator as $file) {
+			$file = \EEH_File::standardise_directory_separators($file);
+			foreach ($this->namespaces as $namespace => $base_dir) {
+				$namespace .= Psr4Autoloader::NS;
+				if (strpos($file, $base_dir) === 0) {
+					$this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+						array($base_dir, DS, '.php'),
+						array($namespace, Psr4Autoloader::NS, ''),
+						$file
+					);
+				}
+			}
+		}
+		return $this->FQCNs;
+	}
+
+
+	/**
+	 * getDirectoryFromPartialNamespace
+	 *
+	 * @access protected
+	 * @param  string $partial_namespace almost fully qualified class name ?
+	 * @return string
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidClassException
+	 */
+	protected function getDirectoryFromPartialNamespace($partial_namespace)
+	{
+		if (empty($partial_namespace)) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		// load our PSR-4 Autoloader so we can get the list of registered namespaces from it
+		$psr4_loader = \EE_Psr4AutoloaderInit::psr4_loader();
+		// breakup the incoming namespace into segments then loop thru them
+		$namespace_segments = explode(Psr4Autoloader::NS, trim($partial_namespace, Psr4Autoloader::NS));
+		// we're only interested in the first element, so pull that from the array
+		$namespace = array_shift($namespace_segments);
+		// check if there's a base directory registered for that namespace
+		$prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+		// nope? then the incoming namespace is invalid
+		if (empty($prefix) || empty($prefix[0])) {
+			throw new InvalidClassException($partial_namespace);
+		}
+		$this->setNamespace($namespace, $prefix[0]);
+		// but if it's good, add that base directory to the rest of the path, and return it
+		return $prefix[0] . implode(DS, $namespace_segments) . DS;
+	}
 }

Spacing +8 added lines, -8 removed lines

@@ -36,13 +36,13 @@ 
      */
     protected function setNamespace($namespace, $namespace_base_dir)
     {
-        if (! is_string($namespace)) {
+        if ( ! is_string($namespace)) {
             throw new InvalidDataTypeException('$namespace', $namespace, 'string');
         }
-        if (! is_string($namespace_base_dir)) {
+        if ( ! is_string($namespace_base_dir)) {
             throw new InvalidDataTypeException('$namespace_base_dir', $namespace_base_dir, 'string');
         }
-        $this->namespaces[ $namespace ] = $namespace_base_dir;
+        $this->namespaces[$namespace] = $namespace_base_dir;
     }
 
 
@@ -77,12 +77,12 @@ 
      */
     public function locate($namespaces)
     {
-        if (! (is_string($namespaces) || is_array($namespaces))) {
+        if ( ! (is_string($namespaces) || is_array($namespaces))) {
             throw new InvalidDataTypeException('$namespaces', $namespaces, 'string or array');
         }
         foreach ((array) $namespaces as $namespace) {
             foreach ($this->FindFQCNsByNamespace($namespace) as $key => $file) {
-                $this->FQCNs[ $key ] = $file;
+                $this->FQCNs[$key] = $file;
             }
         }
         return $this->FQCNs;
@@ -118,7 +118,7 @@ 
             foreach ($this->namespaces as $namespace => $base_dir) {
                 $namespace .= Psr4Autoloader::NS;
                 if (strpos($file, $base_dir) === 0) {
-                    $this->FQCNs[] = Psr4Autoloader::NS . str_replace(
+                    $this->FQCNs[] = Psr4Autoloader::NS.str_replace(
                         array($base_dir, DS, '.php'),
                         array($namespace, Psr4Autoloader::NS, ''),
                         $file
@@ -151,13 +151,13 @@ 
         // we're only interested in the first element, so pull that from the array
         $namespace = array_shift($namespace_segments);
         // check if there's a base directory registered for that namespace
-        $prefix = $psr4_loader->prefixes($namespace . Psr4Autoloader::NS);
+        $prefix = $psr4_loader->prefixes($namespace.Psr4Autoloader::NS);
         // nope? then the incoming namespace is invalid
         if (empty($prefix) || empty($prefix[0])) {
             throw new InvalidClassException($partial_namespace);
         }
         $this->setNamespace($namespace, $prefix[0]);
         // but if it's good, add that base directory to the rest of the path, and return it
-        return $prefix[0] . implode(DS, $namespace_segments) . DS;
+        return $prefix[0].implode(DS, $namespace_segments).DS;
     }
 }