eventespresso / event-espresso-core

core/services/loaders/Loader.php

Doc Comments +1 added lines, -1 removed lines

@@ -101,7 +101,7 @@
 
 
     /**
-     * @param FullyQualifiedName|string $fqcn
+     * @param string $fqcn
      * @param array                     $arguments
      * @return mixed
      */

Indentation +111 added lines, -111 removed lines

@@ -15,115 +15,115 @@
 class Loader implements LoaderInterface
 {
 
-    /**
-     * @var LoaderDecoratorInterface $new_loader
-     */
-    private $new_loader;
-
-    /**
-     * @var LoaderDecoratorInterface $shared_loader
-     */
-    private $shared_loader;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * Loader constructor.
-     *
-     * @param LoaderDecoratorInterface        $new_loader
-     * @param CachingLoaderDecoratorInterface $shared_loader
-     * @param ClassInterfaceCache             $class_cache
-     */
-    public function __construct(
-        LoaderDecoratorInterface $new_loader,
-        CachingLoaderDecoratorInterface $shared_loader,
-        ClassInterfaceCache $class_cache
-    ) {
-        $this->new_loader    = $new_loader;
-        $this->shared_loader = $shared_loader;
-        $this->class_cache   = $class_cache;
-    }
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    public function getNewLoader()
-    {
-        return $this->new_loader;
-    }
-
-
-    /**
-     * @return CachingLoaderDecoratorInterface
-     */
-    public function getSharedLoader()
-    {
-        return $this->shared_loader;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = array(), $shared = true)
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) {
-            $shared = true;
-        }
-        return $shared
-            ? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
-            : $this->getNewLoader()->load($fqcn, $arguments, $shared);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, array $arguments = array())
-    {
-        return $this->load($fqcn, $arguments, false);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, array $arguments = array())
-    {
-        return $this->load($fqcn, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object)
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->share($fqcn, $object);
-    }
-
-
-    /**
-     * calls reset() on loaders if that method exists
-     */
-    public function reset()
-    {
-        $this->shared_loader->reset();
-    }
+	/**
+	 * @var LoaderDecoratorInterface $new_loader
+	 */
+	private $new_loader;
+
+	/**
+	 * @var LoaderDecoratorInterface $shared_loader
+	 */
+	private $shared_loader;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * Loader constructor.
+	 *
+	 * @param LoaderDecoratorInterface        $new_loader
+	 * @param CachingLoaderDecoratorInterface $shared_loader
+	 * @param ClassInterfaceCache             $class_cache
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $new_loader,
+		CachingLoaderDecoratorInterface $shared_loader,
+		ClassInterfaceCache $class_cache
+	) {
+		$this->new_loader    = $new_loader;
+		$this->shared_loader = $shared_loader;
+		$this->class_cache   = $class_cache;
+	}
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	public function getNewLoader()
+	{
+		return $this->new_loader;
+	}
+
+
+	/**
+	 * @return CachingLoaderDecoratorInterface
+	 */
+	public function getSharedLoader()
+	{
+		return $this->shared_loader;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = array(), $shared = true)
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		if ($this->class_cache->hasInterface($fqcn, 'EventEspresso\core\interfaces\ReservedInstanceInterface')) {
+			$shared = true;
+		}
+		return $shared
+			? $this->getSharedLoader()->load($fqcn, $arguments, $shared)
+			: $this->getNewLoader()->load($fqcn, $arguments, $shared);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, array $arguments = array())
+	{
+		return $this->load($fqcn, $arguments, false);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, array $arguments = array())
+	{
+		return $this->load($fqcn, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object)
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->share($fqcn, $object);
+	}
+
+
+	/**
+	 * calls reset() on loaders if that method exists
+	 */
+	public function reset()
+	{
+		$this->shared_loader->reset();
+	}
 }

core/services/bootstrap/BootstrapDependencyInjectionContainer.php

Spacing +2 added lines, -2 removed lines

@@ -78,13 +78,13 @@
         // EE_Dependency_Map: info about how to load classes required by other classes
         espresso_load_required(
             'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
+            EE_CORE.'EE_Dependency_Map.core.php'
         );
         $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
         // EE_Registry: central repository for classes (legacy)
         espresso_load_required(
             'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
+            EE_CORE.'EE_Registry.core.php'
         );
         $this->registry = EE_Registry::instance(
             $this->dependency_map,

Indentation +120 added lines, -120 removed lines

@@ -25,124 +25,124 @@
 class BootstrapDependencyInjectionContainer
 {
 
-    /**
-     * @var EE_Dependency_Map $dependency_map
-     */
-    protected $dependency_map;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    protected $loader;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    protected $registry;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * Can't use this just yet until we exorcise some more of our singleton usage from core
-     */
-    public function buildDependencyInjectionContainer()
-    {
-        // build DI container
-        // $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
-        // $OpenCoffeeShop->addRecipes();
-        // $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
-    }
-
-
-    /**
-     * Setups  EE_Registry and EE_Dependency_Map
-     *
-     * @throws EE_Error
-     */
-    public function buildLegacyDependencyInjectionContainer()
-    {
-        $this->class_cache = new ClassInterfaceCache();
-        $this->object_identifier = new ObjectIdentifier($this->class_cache);
-        $this->mirror = new Mirror();
-        // EE_Dependency_Map: info about how to load classes required by other classes
-        espresso_load_required(
-            'EE_Dependency_Map',
-            EE_CORE . 'EE_Dependency_Map.core.php'
-        );
-        $this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
-        // EE_Registry: central repository for classes (legacy)
-        espresso_load_required(
-            'EE_Registry',
-            EE_CORE . 'EE_Registry.core.php'
-        );
-        $this->registry = EE_Registry::instance(
-            $this->dependency_map,
-            $this->mirror,
-            $this->class_cache,
-            $this->object_identifier
-        );
-
-    }
-
-
-    /**
-     * Performs initial setup for the generic Loader
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function buildLoader()
-    {
-        $this->loader = LoaderFactory::getLoader(
-            $this->registry,
-            $this->class_cache,
-            $this->object_identifier
-        );
-        $this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
-        $this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
-        $this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
-        $this->dependency_map->setLoader($this->loader);
-    }
-
-
-    /**
-     * @return EE_Dependency_Map
-     */
-    public function getDependencyMap()
-    {
-        return $this->dependency_map;
-    }
-
-
-    /**
-     * @return EE_Registry
-     */
-    public function getRegistry()
-    {
-        return $this->registry;
-    }
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getLoader()
-    {
-        return $this->loader;
-    }
+	/**
+	 * @var EE_Dependency_Map $dependency_map
+	 */
+	protected $dependency_map;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	protected $loader;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	protected $registry;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * Can't use this just yet until we exorcise some more of our singleton usage from core
+	 */
+	public function buildDependencyInjectionContainer()
+	{
+		// build DI container
+		// $OpenCoffeeShop = new EventEspresso\core\services\container\OpenCoffeeShop();
+		// $OpenCoffeeShop->addRecipes();
+		// $CoffeeShop = $OpenCoffeeShop->CoffeeShop();
+	}
+
+
+	/**
+	 * Setups  EE_Registry and EE_Dependency_Map
+	 *
+	 * @throws EE_Error
+	 */
+	public function buildLegacyDependencyInjectionContainer()
+	{
+		$this->class_cache = new ClassInterfaceCache();
+		$this->object_identifier = new ObjectIdentifier($this->class_cache);
+		$this->mirror = new Mirror();
+		// EE_Dependency_Map: info about how to load classes required by other classes
+		espresso_load_required(
+			'EE_Dependency_Map',
+			EE_CORE . 'EE_Dependency_Map.core.php'
+		);
+		$this->dependency_map = EE_Dependency_Map::instance($this->class_cache);
+		// EE_Registry: central repository for classes (legacy)
+		espresso_load_required(
+			'EE_Registry',
+			EE_CORE . 'EE_Registry.core.php'
+		);
+		$this->registry = EE_Registry::instance(
+			$this->dependency_map,
+			$this->mirror,
+			$this->class_cache,
+			$this->object_identifier
+		);
+
+	}
+
+
+	/**
+	 * Performs initial setup for the generic Loader
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function buildLoader()
+	{
+		$this->loader = LoaderFactory::getLoader(
+			$this->registry,
+			$this->class_cache,
+			$this->object_identifier
+		);
+		$this->loader->share('EventEspresso\core\services\loaders\ClassInterfaceCache', $this->class_cache);
+		$this->loader->share('EventEspresso\core\services\loaders\ObjectIdentifier', $this->object_identifier);
+		$this->loader->share('EventEspresso\core\services\container\Mirror', $this->mirror);
+		$this->dependency_map->setLoader($this->loader);
+	}
+
+
+	/**
+	 * @return EE_Dependency_Map
+	 */
+	public function getDependencyMap()
+	{
+		return $this->dependency_map;
+	}
+
+
+	/**
+	 * @return EE_Registry
+	 */
+	public function getRegistry()
+	{
+		return $this->registry;
+	}
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getLoader()
+	{
+		return $this->loader;
+	}
 }

core/domain/values/FullyQualifiedName.php

Indentation +43 added lines, -43 removed lines

@@ -21,54 +21,54 @@
 class FullyQualifiedName
 {
 
-    /**
-     * @var string $fully_qualified_name
-     */
-    private $fully_qualified_name;
+	/**
+	 * @var string $fully_qualified_name
+	 */
+	private $fully_qualified_name;
 
 
-    /**
-     * FullyQualifiedName constructor.
-     *
-     * @param string $fully_qualified_name
-     * @throws InvalidClassException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct($fully_qualified_name)
-    {
-        if (! is_string($fully_qualified_name)) {
-            throw new InvalidDataTypeException(
-                '$fully_qualified_name',
-                $fully_qualified_name,
-                'string'
-            );
-        }
-        if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
-            if (strpos($fully_qualified_name, 'Interface') !== false) {
-                throw new InvalidInterfaceException($fully_qualified_name);
-            }
-            throw new InvalidClassException($fully_qualified_name);
-        }
-        $this->fully_qualified_name = $fully_qualified_name;
-    }
+	/**
+	 * FullyQualifiedName constructor.
+	 *
+	 * @param string $fully_qualified_name
+	 * @throws InvalidClassException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct($fully_qualified_name)
+	{
+		if (! is_string($fully_qualified_name)) {
+			throw new InvalidDataTypeException(
+				'$fully_qualified_name',
+				$fully_qualified_name,
+				'string'
+			);
+		}
+		if (! class_exists($fully_qualified_name) && ! interface_exists($fully_qualified_name)) {
+			if (strpos($fully_qualified_name, 'Interface') !== false) {
+				throw new InvalidInterfaceException($fully_qualified_name);
+			}
+			throw new InvalidClassException($fully_qualified_name);
+		}
+		$this->fully_qualified_name = $fully_qualified_name;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function string()
-    {
-        return $this->fully_qualified_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function string()
+	{
+		return $this->fully_qualified_name;
+	}
 
 
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->fully_qualified_name;
-    }
+	/**
+	 * @return string
+	 */
+	public function __toString()
+	{
+		return $this->fully_qualified_name;
+	}
 
 }

core/services/loaders/CoreLoader.php

Spacing +1 added lines, -1 removed lines

@@ -47,7 +47,7 @@
      */
     public function __construct($generator)
     {
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+        if ( ! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
             throw new InvalidArgumentException(
                 esc_html__(
                     'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',

Indentation +98 added lines, -98 removed lines

@@ -29,108 +29,108 @@
 class CoreLoader implements LoaderDecoratorInterface
 {
 
-    /**
-     * @var EE_Registry|CoffeeShop $generator
-     */
-    private $generator;
+	/**
+	 * @var EE_Registry|CoffeeShop $generator
+	 */
+	private $generator;
 
 
-    /**
-     * CoreLoader constructor.
-     *
-     * @param EE_Registry|CoffeeShop $generator
-     * @throws InvalidArgumentException
-     */
-    public function __construct($generator)
-    {
-        if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->generator = $generator;
-    }
+	/**
+	 * CoreLoader constructor.
+	 *
+	 * @param EE_Registry|CoffeeShop $generator
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct($generator)
+	{
+		if (! ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The CoreLoader class must receive an instance of EE_Registry or the CoffeeShop DI container.',
+					'event_espresso'
+				)
+			);
+		}
+		$this->generator = $generator;
+	}
 
 
-    /**
-     * Calls the appropriate loading method from the installed generator;
-     * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
-     * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
-     * but NOT to the class being instantiated.
-     * This is done by adding the parameters to the $arguments array as follows:
-     *  array(
-     *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
-     *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
-     *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
-     *  )
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     * @throws OutOfBoundsException
-     * @throws ServiceExistsException
-     * @throws InstantiationException
-     * @throws InvalidIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidClassException
-     * @throws EE_Error
-     * @throws ServiceNotFoundException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        $shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
-        if ($this->generator instanceof EE_Registry) {
-            // check if additional EE_Registry::create() arguments have been passed
-            // from_db
-            $from_db = isset($arguments['EE_Registry::create(from_db)'])
-                ? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            // load_only
-            $load_only = isset($arguments['EE_Registry::create(load_only)'])
-                ? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            // addon
-            $addon = isset($arguments['EE_Registry::create(addon)'])
-                ? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
-                : false;
-            unset(
-                $arguments['EE_Registry::create(from_db)'],
-                $arguments['EE_Registry::create(load_only)'],
-                $arguments['EE_Registry::create(addon)']
-            );
-            // addons need to be cached on EE_Registry
-            $shared = $addon ? true : $shared;
-            return $this->generator->create(
-                $fqcn,
-                $arguments,
-                $shared,
-                $from_db,
-                $load_only,
-                $addon
-            );
-        }
-        return $this->generator->brew(
-            $fqcn,
-            $arguments,
-            $shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
-        );
-    }
+	/**
+	 * Calls the appropriate loading method from the installed generator;
+	 * If EE_Registry is being used, then the additional parameters for the EE_Registry::create() method
+	 * can be added to the $arguments array and they will be extracted and passed to EE_Registry::create(),
+	 * but NOT to the class being instantiated.
+	 * This is done by adding the parameters to the $arguments array as follows:
+	 *  array(
+	 *      'EE_Registry::create(from_db)'   => true, // boolean value, default = false
+	 *      'EE_Registry::create(load_only)' => true, // boolean value, default = false
+	 *      'EE_Registry::create(addon)'     => true, // boolean value, default = false
+	 *  )
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 * @throws OutOfBoundsException
+	 * @throws ServiceExistsException
+	 * @throws InstantiationException
+	 * @throws InvalidIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidClassException
+	 * @throws EE_Error
+	 * @throws ServiceNotFoundException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		$shared = filter_var($shared, FILTER_VALIDATE_BOOLEAN);
+		if ($this->generator instanceof EE_Registry) {
+			// check if additional EE_Registry::create() arguments have been passed
+			// from_db
+			$from_db = isset($arguments['EE_Registry::create(from_db)'])
+				? filter_var($arguments['EE_Registry::create(from_db)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			// load_only
+			$load_only = isset($arguments['EE_Registry::create(load_only)'])
+				? filter_var($arguments['EE_Registry::create(load_only)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			// addon
+			$addon = isset($arguments['EE_Registry::create(addon)'])
+				? filter_var($arguments['EE_Registry::create(addon)'], FILTER_VALIDATE_BOOLEAN)
+				: false;
+			unset(
+				$arguments['EE_Registry::create(from_db)'],
+				$arguments['EE_Registry::create(load_only)'],
+				$arguments['EE_Registry::create(addon)']
+			);
+			// addons need to be cached on EE_Registry
+			$shared = $addon ? true : $shared;
+			return $this->generator->create(
+				$fqcn,
+				$arguments,
+				$shared,
+				$from_db,
+				$load_only,
+				$addon
+			);
+		}
+		return $this->generator->brew(
+			$fqcn,
+			$arguments,
+			$shared ? CoffeeMaker::BREW_SHARED : CoffeeMaker::BREW_NEW
+		);
+	}
 
 
-    /**
-     * calls reset() on generator if method exists
-     */
-    public function reset()
-    {
-        if ($this->generator instanceof ResettableInterface) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * calls reset() on generator if method exists
+	 */
+	public function reset()
+	{
+		if ($this->generator instanceof ResettableInterface) {
+			$this->generator->reset();
+		}
+	}
 }

core/services/loaders/CachingLoader.php

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
         $identifier = ''
     ) {
         parent::__construct($loader);
-        $this->cache       = $cache;
+        $this->cache = $cache;
         $this->object_identifier = $object_identifier;
         $this->setIdentifier($identifier);
         if ($this->identifier !== '') {
@@ -89,7 +89,7 @@ 
      */
     private function setIdentifier($identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;

Indentation +150 added lines, -150 removed lines

@@ -17,154 +17,154 @@
 class CachingLoader extends CachingLoaderDecorator
 {
 
-    /**
-     * @var string $identifier
-     */
-    protected $identifier;
-
-    /**
-     * @var CollectionInterface $cache
-     */
-    protected $cache;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param ObjectIdentifier         $object_identifier
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(
-        LoaderDecoratorInterface $loader,
-        CollectionInterface $cache,
-        ObjectIdentifier $object_identifier,
-        $identifier = ''
-    ) {
-        parent::__construct($loader);
-        $this->cache       = $cache;
-        $this->object_identifier = $object_identifier;
-        $this->setIdentifier($identifier);
-        if ($this->identifier !== '') {
-            // to only clear this cache, and assuming an identifier has been set, simply do the following:
-            // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
-            // where "IDENTIFIER" = the string that was set during construction
-            add_action(
-                "AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
-                array($this, 'reset')
-            );
-        }
-        // to clear ALL caches, simply do the following:
-        // do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
-        add_action(
-            'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
-            array($this, 'reset')
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier()
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier($identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object)
-    {
-        if ($object instanceof $fqcn) {
-            return $this->cache->add($object, md5($fqcn));
-        }
-        throw new InvalidArgumentException(
-            sprintf(
-                esc_html__(
-                    'The supplied class name "%1$s" must match the class of the supplied object.',
-                    'event_espresso'
-                ),
-                $fqcn
-            )
-        );
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @param array                     $interfaces
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
-    {
-        $fqcn = ltrim($fqcn, '\\');
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        if (apply_filters(
-            'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-            false,
-            $this
-        )) {
-            // even though $shared might be true, caching could be bypassed for whatever reason,
-            // so we don't want the core loader to cache anything, therefore caching is turned off
-            return $this->loader->load($fqcn, $arguments, false);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        if ($this->cache->has($object_identifier)) {
-            return $this->cache->get($object_identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments, $shared);
-        if ($object instanceof $fqcn) {
-            $this->cache->add($object, $object_identifier);
-        }
-        return $object;
-    }
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->clearCache();
-        $this->loader->reset();
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the cache
-     *
-     * @since $VID:$
-     */
-    public function clearCache()
-    {
-        $this->cache->trashAndDetachAll();
-    }
+	/**
+	 * @var string $identifier
+	 */
+	protected $identifier;
+
+	/**
+	 * @var CollectionInterface $cache
+	 */
+	protected $cache;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param ObjectIdentifier         $object_identifier
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(
+		LoaderDecoratorInterface $loader,
+		CollectionInterface $cache,
+		ObjectIdentifier $object_identifier,
+		$identifier = ''
+	) {
+		parent::__construct($loader);
+		$this->cache       = $cache;
+		$this->object_identifier = $object_identifier;
+		$this->setIdentifier($identifier);
+		if ($this->identifier !== '') {
+			// to only clear this cache, and assuming an identifier has been set, simply do the following:
+			// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__IDENTIFIER');
+			// where "IDENTIFIER" = the string that was set during construction
+			add_action(
+				"AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache__{$identifier}",
+				array($this, 'reset')
+			);
+		}
+		// to clear ALL caches, simply do the following:
+		// do_action('AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache');
+		add_action(
+			'AHEE__EventEspresso_core_services_loaders_CachingLoader__resetCache',
+			array($this, 'reset')
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier()
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier($identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object)
+	{
+		if ($object instanceof $fqcn) {
+			return $this->cache->add($object, md5($fqcn));
+		}
+		throw new InvalidArgumentException(
+			sprintf(
+				esc_html__(
+					'The supplied class name "%1$s" must match the class of the supplied object.',
+					'event_espresso'
+				),
+				$fqcn
+			)
+		);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @param array                     $interfaces
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true, array $interfaces = array())
+	{
+		$fqcn = ltrim($fqcn, '\\');
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		if (apply_filters(
+			'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+			false,
+			$this
+		)) {
+			// even though $shared might be true, caching could be bypassed for whatever reason,
+			// so we don't want the core loader to cache anything, therefore caching is turned off
+			return $this->loader->load($fqcn, $arguments, false);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		if ($this->cache->has($object_identifier)) {
+			return $this->cache->get($object_identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments, $shared);
+		if ($object instanceof $fqcn) {
+			$this->cache->add($object, $object_identifier);
+		}
+		return $object;
+	}
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->clearCache();
+		$this->loader->reset();
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the cache
+	 *
+	 * @since $VID:$
+	 */
+	public function clearCache()
+	{
+		$this->cache->trashAndDetachAll();
+	}
 }

core/services/loaders/LoaderFactory.php

Indentation +39 added lines, -39 removed lines

@@ -80,47 +80,47 @@
 class LoaderFactory
 {
 
-    /**
-     * @var LoaderInterface $loader ;
-     */
-    private static $loader;
+	/**
+	 * @var LoaderInterface $loader ;
+	 */
+	private static $loader;
 
 
-    /**
-     * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
-     *                                              BootstrapDependencyInjectionContainer::buildLoader()
-     *                                              otherwise can be left null
-     * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
-     * @param ObjectIdentifier|null    $object_identifier
-     * @return LoaderInterface
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getLoader(
-        $generator = null,
-        ClassInterfaceCache $class_cache = null,
-        ObjectIdentifier $object_identifier = null
-    ) {
-        if (
-            ! LoaderFactory::$loader instanceof LoaderInterface
-            && ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
-            && $class_cache instanceof ClassInterfaceCache
-            && $object_identifier instanceof ObjectIdentifier
-        ) {
-            $core_loader = new CoreLoader($generator);
-            LoaderFactory::$loader = new Loader(
-                $core_loader,
-                new CachingLoader(
-                    $core_loader,
-                    new LooseCollection(''),
-                    $object_identifier
-                ),
-                $class_cache
-            );
-        }
-        return LoaderFactory::$loader;
-    }
+	/**
+	 * @param EE_Registry|CoffeeShop   $generator   provided during very first instantiation in
+	 *                                              BootstrapDependencyInjectionContainer::buildLoader()
+	 *                                              otherwise can be left null
+	 * @param ClassInterfaceCache|null $class_cache also provided during first instantiation
+	 * @param ObjectIdentifier|null    $object_identifier
+	 * @return LoaderInterface
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getLoader(
+		$generator = null,
+		ClassInterfaceCache $class_cache = null,
+		ObjectIdentifier $object_identifier = null
+	) {
+		if (
+			! LoaderFactory::$loader instanceof LoaderInterface
+			&& ($generator instanceof EE_Registry || $generator instanceof CoffeeShop)
+			&& $class_cache instanceof ClassInterfaceCache
+			&& $object_identifier instanceof ObjectIdentifier
+		) {
+			$core_loader = new CoreLoader($generator);
+			LoaderFactory::$loader = new Loader(
+				$core_loader,
+				new CachingLoader(
+					$core_loader,
+					new LooseCollection(''),
+					$object_identifier
+				),
+				$class_cache
+			);
+		}
+		return LoaderFactory::$loader;
+	}
 
 
 }

core/domain/DomainFactory.php

Indentation +55 added lines, -55 removed lines

@@ -28,63 +28,63 @@
 class DomainFactory
 {
 
-    /**
-     * @param FullyQualifiedName $domain_fqcn   [required] Fully Qualified Class Name for the Domain class
-     * @param array $arguments                  [required] array of arguments to be passed to the Domain class
-     *                                          constructor. Must at least include the following two value objects:
-     *                                          array(
-     *                                              EventEspresso\core\domain\values\FilePath $plugin_file
-     *                                              EventEspresso\core\domain\values\Version $version
-     *                                          )
-     * @return mixed
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
-    {
-        if (! isset($arguments[0], $arguments[1])) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
-                    'event_espresso'
-                )
-            );
-        }
-        $domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
-        if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The requested Domain class "%1$s" could not be loaded.',
-                        'event_espresso'
-                    ),
-                    $domain_fqcn
-                )
-            );
-        }
-        return $domain;
-    }
+	/**
+	 * @param FullyQualifiedName $domain_fqcn   [required] Fully Qualified Class Name for the Domain class
+	 * @param array $arguments                  [required] array of arguments to be passed to the Domain class
+	 *                                          constructor. Must at least include the following two value objects:
+	 *                                          array(
+	 *                                              EventEspresso\core\domain\values\FilePath $plugin_file
+	 *                                              EventEspresso\core\domain\values\Version $version
+	 *                                          )
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getShared(FullyQualifiedName $domain_fqcn, array $arguments)
+	{
+		if (! isset($arguments[0], $arguments[1])) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'You need to pass at least two arguments, representing the addon plugin file and version, in order to generate a Domain class',
+					'event_espresso'
+				)
+			);
+		}
+		$domain = LoaderFactory::getLoader()->getShared($domain_fqcn, $arguments);
+		if (! $domain instanceof $domain_fqcn && ! $domain instanceof DomainBase) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The requested Domain class "%1$s" could not be loaded.',
+						'event_espresso'
+					),
+					$domain_fqcn
+				)
+			);
+		}
+		return $domain;
+	}
 
 
-    /**
-     * @return Domain
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidFilePathException
-     * @throws InvalidInterfaceException
-     */
-    public static function getEventEspressoCoreDomain()
-    {
-        $domain = new Domain(
-            new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-            Version::fromString(espresso_version())
-        );
-        LoaderFactory::getLoader()->share('EventEspresso\core\domain\Domain', $domain);
-        return $domain;
-    }
+	/**
+	 * @return Domain
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidFilePathException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function getEventEspressoCoreDomain()
+	{
+		$domain = new Domain(
+			new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+			Version::fromString(espresso_version())
+		);
+		LoaderFactory::getLoader()->share('EventEspresso\core\domain\Domain', $domain);
+		return $domain;
+	}
 }
 
 

core/services/collections/Collection.php

Doc Comments +3 added lines, -3 removed lines

@@ -156,7 +156,7 @@ 
      *
      * @access public
      * @param mixed $identifier
-     * @return mixed
+     * @return boolean
      */
     public function get($identifier)
     {
@@ -278,7 +278,7 @@ 
      * advances pointer to the provided object
      *
      * @access public
-     * @param $object
+     * @param \EventEspresso\core\libraries\form_sections\form_handlers\SequentialStepForm $object
      * @return boolean
      */
     public function setCurrentUsingObject($object)
@@ -316,7 +316,7 @@ 
      *
      * @see http://stackoverflow.com/a/8736013
      * @param $object
-     * @return boolean|int|string
+     * @return integer
      */
     public function indexOf($object)
     {

Indentation +383 added lines, -383 removed lines

@@ -19,387 +19,387 @@
 {
 
 
-    /**
-     * an interface (or class) name to be used for restricting the type of objects added to the storage
-     * this should be set from within the child class constructor
-     *
-     * @type string $interface
-     */
-    protected $collection_interface;
-
-
-    /**
-     * Collection constructor
-     *
-     * @param string $collection_interface
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function __construct($collection_interface)
-    {
-        $this->setCollectionInterface($collection_interface);
-    }
-
-
-    /**
-     * setCollectionInterface
-     *
-     * @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;
-    }
-
-
-    /**
-     * add
-     * attaches an object to the Collection
-     * and sets any supplied data associated with the current iterator entry
-     * by calling EE_Object_Collection::set_identifier()
-     *
-     * @access public
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     * @throws \EventEspresso\core\exceptions\InvalidEntityException
-     */
-    public function add($object, $identifier = null)
-    {
-        if (! $object instanceof $this->collection_interface) {
-            throw new InvalidEntityException($object, $this->collection_interface);
-        }
-        $this->attach($object);
-        $this->setIdentifier($object, $identifier);
-        return $this->contains($object);
-    }
-
-
-    /**
-     * setIdentifier
-     * Sets the data associated with an object in the Collection
-     * if no $identifier is supplied, then the spl_object_hash() is used
-     *
-     * @access public
-     * @param        $object
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function setIdentifier($object, $identifier = null)
-    {
-        $identifier = ! empty($identifier) ? $identifier : spl_object_hash($object);
-        $this->rewind();
-        while ($this->valid()) {
-            if ($object === $this->current()) {
-                $this->setInfo($identifier);
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * get
-     * finds and returns an object in the Collection based on the identifier that was set using addObject()
-     * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
-     *
-     * @access public
-     * @param mixed $identifier
-     * @return mixed
-     */
-    public function get($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $object = $this->current();
-                $this->rewind();
-                return $object;
-            }
-            $this->next();
-        }
-        return null;
-    }
-
-
-    /**
-     * has
-     * returns TRUE or FALSE
-     * depending on whether the object is within the Collection
-     * based on the supplied $identifier
-     *
-     * @access public
-     * @param  mixed $identifier
-     * @return bool
-     */
-    public function has($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                $this->rewind();
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * hasObject
-     * returns TRUE or FALSE depending on whether the supplied object is within the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function hasObject($object)
-    {
-        return $this->contains($object);
-    }
-
-
-    /**
-     * hasObjects
-     * returns true if there are objects within the Collection, and false if it is empty
-     *
-     * @access public
-     * @return bool
-     */
-    public function hasObjects()
-    {
-        return $this->count() !== 0;
-    }
-
-
-    /**
-     * isEmpty
-     * returns true if there are no objects within the Collection, and false if there are
-     *
-     * @access public
-     * @return bool
-     */
-    public function isEmpty()
-    {
-        return $this->count() === 0;
-    }
-
-
-    /**
-     * remove
-     * detaches an object from the Collection
-     *
-     * @access public
-     * @param $object
-     * @return bool
-     */
-    public function remove($object)
-    {
-        $this->detach($object);
-        return true;
-    }
-
-
-    /**
-     * setCurrent
-     * advances pointer to the object whose identifier matches that which was provided
-     *
-     * @access public
-     * @param mixed $identifier
-     * @return boolean
-     */
-    public function setCurrent($identifier)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($identifier === $this->getInfo()) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * setCurrentUsingObject
-     * advances pointer to the provided object
-     *
-     * @access public
-     * @param $object
-     * @return boolean
-     */
-    public function setCurrentUsingObject($object)
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            if ($this->current() === $object) {
-                return true;
-            }
-            $this->next();
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object occupying the index before the current object,
-     * unless this is already the first object, in which case it just returns the first object
-     *
-     * @return mixed
-     */
-    public function previous()
-    {
-        $index = $this->indexOf($this->current());
-        if ($index === 0) {
-            return $this->current();
-        }
-        $index--;
-        return $this->objectAtIndex($index);
-    }
-
-
-    /**
-     * Returns the index of a given object, or false if not found
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param $object
-     * @return boolean|int|string
-     */
-    public function indexOf($object)
-    {
-        if (! $this->contains($object)) {
-            return false;
-        }
-        foreach ($this as $index => $obj) {
-            if ($obj === $object) {
-                return $index;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     * @return mixed
-     */
-    public function objectAtIndex($index)
-    {
-        $iterator = new LimitIterator($this, $index, 1);
-        $iterator->rewind();
-        return $iterator->current();
-    }
-
-
-    /**
-     * Returns the sequence of objects as specified by the offset and length
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $offset
-     * @param int $length
-     * @return array
-     */
-    public function slice($offset, $length)
-    {
-        $slice = array();
-        $iterator = new LimitIterator($this, $offset, $length);
-        foreach ($iterator as $object) {
-            $slice[] = $object;
-        }
-        return $slice;
-    }
-
-
-    /**
-     * Inserts an object (or an array of objects) at a certain point
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param mixed $objects A single object or an array of objects
-     * @param int   $index
-     */
-    public function insertAt($objects, $index)
-    {
-        if (! is_array($objects)) {
-            $objects = array($objects);
-        }
-        // check to ensure that objects don't already exist in the collection
-        foreach ($objects as $key => $object) {
-            if ($this->contains($object)) {
-                unset($objects[ $key ]);
-            }
-        }
-        // do we have any objects left?
-        if (! $objects) {
-            return;
-        }
-        // detach any objects at or past this index
-        $remaining = array();
-        if ($index < $this->count()) {
-            $remaining = $this->slice($index, $this->count() - $index);
-            foreach ($remaining as $object) {
-                $this->detach($object);
-            }
-        }
-        // add the new objects we're splicing in
-        foreach ($objects as $object) {
-            $this->attach($object);
-        }
-        // attach the objects we previously detached
-        foreach ($remaining as $object) {
-            $this->attach($object);
-        }
-    }
-
-
-    /**
-     * Removes the object at the given index
-     *
-     * @see http://stackoverflow.com/a/8736013
-     * @param int $index
-     */
-    public function removeAt($index)
-    {
-        $this->detach($this->objectAtIndex($index));
-    }
-
-
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-        }
-    }
-
-
-    /**
-     * unsets and detaches ALL objects from the Collection
-     */
-    public function trashAndDetachAll()
-    {
-        $this->rewind();
-        while ($this->valid()) {
-            $object = $this->current();
-            $this->next();
-            $this->detach($object);
-            unset($object);
-        }
-    }
+	/**
+	 * an interface (or class) name to be used for restricting the type of objects added to the storage
+	 * this should be set from within the child class constructor
+	 *
+	 * @type string $interface
+	 */
+	protected $collection_interface;
+
+
+	/**
+	 * Collection constructor
+	 *
+	 * @param string $collection_interface
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function __construct($collection_interface)
+	{
+		$this->setCollectionInterface($collection_interface);
+	}
+
+
+	/**
+	 * setCollectionInterface
+	 *
+	 * @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;
+	}
+
+
+	/**
+	 * add
+	 * attaches an object to the Collection
+	 * and sets any supplied data associated with the current iterator entry
+	 * by calling EE_Object_Collection::set_identifier()
+	 *
+	 * @access public
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 * @throws \EventEspresso\core\exceptions\InvalidEntityException
+	 */
+	public function add($object, $identifier = null)
+	{
+		if (! $object instanceof $this->collection_interface) {
+			throw new InvalidEntityException($object, $this->collection_interface);
+		}
+		$this->attach($object);
+		$this->setIdentifier($object, $identifier);
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * setIdentifier
+	 * Sets the data associated with an object in the Collection
+	 * if no $identifier is supplied, then the spl_object_hash() is used
+	 *
+	 * @access public
+	 * @param        $object
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function setIdentifier($object, $identifier = null)
+	{
+		$identifier = ! empty($identifier) ? $identifier : spl_object_hash($object);
+		$this->rewind();
+		while ($this->valid()) {
+			if ($object === $this->current()) {
+				$this->setInfo($identifier);
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * get
+	 * finds and returns an object in the Collection based on the identifier that was set using addObject()
+	 * PLZ NOTE: the pointer is reset to the beginning of the collection before returning
+	 *
+	 * @access public
+	 * @param mixed $identifier
+	 * @return mixed
+	 */
+	public function get($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$object = $this->current();
+				$this->rewind();
+				return $object;
+			}
+			$this->next();
+		}
+		return null;
+	}
+
+
+	/**
+	 * has
+	 * returns TRUE or FALSE
+	 * depending on whether the object is within the Collection
+	 * based on the supplied $identifier
+	 *
+	 * @access public
+	 * @param  mixed $identifier
+	 * @return bool
+	 */
+	public function has($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				$this->rewind();
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * hasObject
+	 * returns TRUE or FALSE depending on whether the supplied object is within the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function hasObject($object)
+	{
+		return $this->contains($object);
+	}
+
+
+	/**
+	 * hasObjects
+	 * returns true if there are objects within the Collection, and false if it is empty
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function hasObjects()
+	{
+		return $this->count() !== 0;
+	}
+
+
+	/**
+	 * isEmpty
+	 * returns true if there are no objects within the Collection, and false if there are
+	 *
+	 * @access public
+	 * @return bool
+	 */
+	public function isEmpty()
+	{
+		return $this->count() === 0;
+	}
+
+
+	/**
+	 * remove
+	 * detaches an object from the Collection
+	 *
+	 * @access public
+	 * @param $object
+	 * @return bool
+	 */
+	public function remove($object)
+	{
+		$this->detach($object);
+		return true;
+	}
+
+
+	/**
+	 * setCurrent
+	 * advances pointer to the object whose identifier matches that which was provided
+	 *
+	 * @access public
+	 * @param mixed $identifier
+	 * @return boolean
+	 */
+	public function setCurrent($identifier)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($identifier === $this->getInfo()) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * setCurrentUsingObject
+	 * advances pointer to the provided object
+	 *
+	 * @access public
+	 * @param $object
+	 * @return boolean
+	 */
+	public function setCurrentUsingObject($object)
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			if ($this->current() === $object) {
+				return true;
+			}
+			$this->next();
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object occupying the index before the current object,
+	 * unless this is already the first object, in which case it just returns the first object
+	 *
+	 * @return mixed
+	 */
+	public function previous()
+	{
+		$index = $this->indexOf($this->current());
+		if ($index === 0) {
+			return $this->current();
+		}
+		$index--;
+		return $this->objectAtIndex($index);
+	}
+
+
+	/**
+	 * Returns the index of a given object, or false if not found
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param $object
+	 * @return boolean|int|string
+	 */
+	public function indexOf($object)
+	{
+		if (! $this->contains($object)) {
+			return false;
+		}
+		foreach ($this as $index => $obj) {
+			if ($obj === $object) {
+				return $index;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 * @return mixed
+	 */
+	public function objectAtIndex($index)
+	{
+		$iterator = new LimitIterator($this, $index, 1);
+		$iterator->rewind();
+		return $iterator->current();
+	}
+
+
+	/**
+	 * Returns the sequence of objects as specified by the offset and length
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $offset
+	 * @param int $length
+	 * @return array
+	 */
+	public function slice($offset, $length)
+	{
+		$slice = array();
+		$iterator = new LimitIterator($this, $offset, $length);
+		foreach ($iterator as $object) {
+			$slice[] = $object;
+		}
+		return $slice;
+	}
+
+
+	/**
+	 * Inserts an object (or an array of objects) at a certain point
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param mixed $objects A single object or an array of objects
+	 * @param int   $index
+	 */
+	public function insertAt($objects, $index)
+	{
+		if (! is_array($objects)) {
+			$objects = array($objects);
+		}
+		// check to ensure that objects don't already exist in the collection
+		foreach ($objects as $key => $object) {
+			if ($this->contains($object)) {
+				unset($objects[ $key ]);
+			}
+		}
+		// do we have any objects left?
+		if (! $objects) {
+			return;
+		}
+		// detach any objects at or past this index
+		$remaining = array();
+		if ($index < $this->count()) {
+			$remaining = $this->slice($index, $this->count() - $index);
+			foreach ($remaining as $object) {
+				$this->detach($object);
+			}
+		}
+		// add the new objects we're splicing in
+		foreach ($objects as $object) {
+			$this->attach($object);
+		}
+		// attach the objects we previously detached
+		foreach ($remaining as $object) {
+			$this->attach($object);
+		}
+	}
+
+
+	/**
+	 * Removes the object at the given index
+	 *
+	 * @see http://stackoverflow.com/a/8736013
+	 * @param int $index
+	 */
+	public function removeAt($index)
+	{
+		$this->detach($this->objectAtIndex($index));
+	}
+
+
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+		}
+	}
+
+
+	/**
+	 * unsets and detaches ALL objects from the Collection
+	 */
+	public function trashAndDetachAll()
+	{
+		$this->rewind();
+		while ($this->valid()) {
+			$object = $this->current();
+			$this->next();
+			$this->detach($object);
+			unset($object);
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -49,7 +49,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;
@@ -70,7 +70,7 @@ 
      */
     public function add($object, $identifier = null)
     {
-        if (! $object instanceof $this->collection_interface) {
+        if ( ! $object instanceof $this->collection_interface) {
             throw new InvalidEntityException($object, $this->collection_interface);
         }
         $this->attach($object);
@@ -276,7 +276,7 @@ 
      */
     public function indexOf($object)
     {
-        if (! $this->contains($object)) {
+        if ( ! $this->contains($object)) {
             return false;
         }
         foreach ($this as $index => $obj) {
@@ -331,17 +331,17 @@ 
      */
     public function insertAt($objects, $index)
     {
-        if (! is_array($objects)) {
+        if ( ! is_array($objects)) {
             $objects = array($objects);
         }
         // check to ensure that objects don't already exist in the collection
         foreach ($objects as $key => $object) {
             if ($this->contains($object)) {
-                unset($objects[ $key ]);
+                unset($objects[$key]);
             }
         }
         // do we have any objects left?
-        if (! $objects) {
+        if ( ! $objects) {
             return;
         }
         // detach any objects at or past this index

core/domain/entities/GenericAddress.php

Doc Comments +4 added lines, -2 removed lines

@@ -37,6 +37,8 @@ 
      * @param \EE_State | string   $state
      * @param string               $zip
      * @param \EE_Country | string $country
+     * @param integer $state
+     * @param string $country
      * @return GenericAddress
      */
     public function __construct($address, $address2, $city, $state, $zip, $country)
@@ -130,7 +132,7 @@ 
 
 
     /**
-     * @return \EE_State
+     * @return string
      */
     public function state_obj()
     {
@@ -183,7 +185,7 @@ 
 
 
     /**
-     * @return \EE_Country
+     * @return string
      */
     public function country_obj()
     {

Indentation +201 added lines, -201 removed lines

@@ -12,205 +12,205 @@
  */
 class GenericAddress implements \EEI_Address
 {
-    // phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
-    private $_address = '';
-
-    private $_address2 = '';
-
-    private $_city = '';
-
-    private $_state_ID = '';
-
-    private $_state_obj = '';
-
-    private $_zip = '';
-
-    private $_country_ID = '';
-
-    private $_country_obj = '';
-    // phpcs:enable
-
-    // phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
-    /**
-     * @param string               $address
-     * @param string               $address2
-     * @param string               $city
-     * @param \EE_State | string   $state
-     * @param string               $zip
-     * @param \EE_Country | string $country
-     * @return GenericAddress
-     */
-    public function __construct($address, $address2, $city, $state, $zip, $country)
-    {
-        $this->_address = $address;
-        $this->_address2 = $address2;
-        $this->_city = $city;
-        if ($state instanceof \EE_State) {
-            $this->_state_obj = $state;
-        } else {
-            $this->_state_ID = $state;
-            $this->_state_obj = $this->_get_state_obj();
-        }
-        $this->_zip = $zip;
-        if ($country instanceof \EE_Country) {
-            $this->_country_obj = $country;
-        } else {
-            $this->_country_ID = $country;
-            $this->_country_obj = $this->_get_country_obj();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address()
-    {
-        return $this->_address;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function address2()
-    {
-        return $this->_address2;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function city()
-    {
-        return $this->_city;
-    }
-
-    // phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
-
-    /**
-     * @return \EE_State
-     */
-    private function _get_state_obj()
-    {
-        return $this->_state_obj instanceof \EE_State
-            ? $this->_state_obj
-            : \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_ID()
-    {
-        return $this->_state_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_abbrev()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->abbrev()
-            : '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state_name()
-    {
-        return $this->state_obj() instanceof \EE_State
-            ? $this->state_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_State
-     */
-    public function state_obj()
-    {
-        return $this->_state_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function state()
-    {
-        if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
-            return $this->state_obj()->abbrev();
-        } else {
-            return $this->state_name();
-        }
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    private function _get_country_obj()
-    {
-        return $this->_country_obj instanceof \EE_Country
-            ? $this->_country_obj
-            : \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_ID()
-    {
-        return $this->_country_ID;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country_name()
-    {
-        return $this->country_obj() instanceof \EE_Country
-            ? $this->country_obj()->name()
-            : '';
-    }
-
-
-    /**
-     * @return \EE_Country
-     */
-    public function country_obj()
-    {
-        return $this->_country_obj;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function country()
-    {
-        if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
-            return $this->country_ID();
-        } else {
-            return $this->country_name();
-        }
-    }
-
-
-    /**
-     * @return string
-     */
-    public function zip()
-    {
-        return $this->_zip;
-    }
+	// phpcs:disable PSR2.Classes.PropertyDeclaration.Underscore
+	private $_address = '';
+
+	private $_address2 = '';
+
+	private $_city = '';
+
+	private $_state_ID = '';
+
+	private $_state_obj = '';
+
+	private $_zip = '';
+
+	private $_country_ID = '';
+
+	private $_country_obj = '';
+	// phpcs:enable
+
+	// phpcs:disable PSR2.Methods.MethodDeclaration.Underscore
+	/**
+	 * @param string               $address
+	 * @param string               $address2
+	 * @param string               $city
+	 * @param \EE_State | string   $state
+	 * @param string               $zip
+	 * @param \EE_Country | string $country
+	 * @return GenericAddress
+	 */
+	public function __construct($address, $address2, $city, $state, $zip, $country)
+	{
+		$this->_address = $address;
+		$this->_address2 = $address2;
+		$this->_city = $city;
+		if ($state instanceof \EE_State) {
+			$this->_state_obj = $state;
+		} else {
+			$this->_state_ID = $state;
+			$this->_state_obj = $this->_get_state_obj();
+		}
+		$this->_zip = $zip;
+		if ($country instanceof \EE_Country) {
+			$this->_country_obj = $country;
+		} else {
+			$this->_country_ID = $country;
+			$this->_country_obj = $this->_get_country_obj();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address()
+	{
+		return $this->_address;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function address2()
+	{
+		return $this->_address2;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function city()
+	{
+		return $this->_city;
+	}
+
+	// phpcs:disable PSR1.Methods.CamelCapsMethodName.NotCamelCaps
+
+	/**
+	 * @return \EE_State
+	 */
+	private function _get_state_obj()
+	{
+		return $this->_state_obj instanceof \EE_State
+			? $this->_state_obj
+			: \EE_Registry::instance()->load_model('State')->get_one_by_ID($this->_state_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_ID()
+	{
+		return $this->_state_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_abbrev()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->abbrev()
+			: '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state_name()
+	{
+		return $this->state_obj() instanceof \EE_State
+			? $this->state_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_State
+	 */
+	public function state_obj()
+	{
+		return $this->_state_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function state()
+	{
+		if (apply_filters('FHEE__EEI_Address__state__use_abbreviation', true, $this->state_obj())) {
+			return $this->state_obj()->abbrev();
+		} else {
+			return $this->state_name();
+		}
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	private function _get_country_obj()
+	{
+		return $this->_country_obj instanceof \EE_Country
+			? $this->_country_obj
+			: \EE_Registry::instance()->load_model('Country')->get_one_by_ID($this->_country_ID);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_ID()
+	{
+		return $this->_country_ID;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country_name()
+	{
+		return $this->country_obj() instanceof \EE_Country
+			? $this->country_obj()->name()
+			: '';
+	}
+
+
+	/**
+	 * @return \EE_Country
+	 */
+	public function country_obj()
+	{
+		return $this->_country_obj;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function country()
+	{
+		if (apply_filters('FHEE__EEI_Address__country__use_abbreviation', true, $this->country_obj())) {
+			return $this->country_ID();
+		} else {
+			return $this->country_name();
+		}
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function zip()
+	{
+		return $this->_zip;
+	}
 }