eventespresso / event-espresso-core

core/services/loaders/CoreLoader.php

Doc Comments +1 added lines, -1 removed lines

@@ -33,7 +33,7 @@
     /**
      * CoreLoader constructor.
      *
-     * @param EE_Registry|CoffeeShop $generator
+     * @param EE_Registry $generator
      * @throws InvalidArgumentException
      */
     public function __construct($generator)

Indentation +52 added lines, -52 removed lines

@@ -23,58 +23,58 @@
 class CoreLoader implements LoaderInterface
 {
 
-    /**
-     * @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;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws ServiceNotFoundException
-     */
-    public function load($fqcn, $arguments = array())
-    {
-        return $this->generator instanceof EE_Registry
-            ? $this->generator->create($fqcn, $arguments)
-            : $this->generator->brew($fqcn, $arguments);
-    }
-
-
-
-    /**
-     * calls reset() on generator if method exists
-     */
-    public function reset()
-    {
-        if (method_exists($this->generator, 'reset')) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * @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;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws ServiceNotFoundException
+	 */
+	public function load($fqcn, $arguments = array())
+	{
+		return $this->generator instanceof EE_Registry
+			? $this->generator->create($fqcn, $arguments)
+			: $this->generator->brew($fqcn, $arguments);
+	}
+
+
+
+	/**
+	 * calls reset() on generator if method exists
+	 */
+	public function reset()
+	{
+		if (method_exists($this->generator, 'reset')) {
+			$this->generator->reset();
+		}
+	}
 
 }
 // End of file CoreLoader.php

core/services/collections/CollectionInterface.php

Indentation +10 added lines, -10 removed lines

@@ -113,12 +113,12 @@ 
 	public function previous();
 
 		/**
-	 * Returns the index of a given object, or false if not found
-	 *
-	 * @see http://stackoverflow.com/a/8736013
-	 * @param $object
-	 * @return boolean|int|string
-	 */
+		 * 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 );
 
 
@@ -160,10 +160,10 @@ 
 
 
 
-    /**
-     * detaches ALL objects from the Collection
-     */
-    public function detachAll();
+	/**
+	 * detaches ALL objects from the Collection
+	 */
+	public function detachAll();
 
 }
 // End of file CollectionInterface.php

core/services/collections/Collection.php

Indentation +12 added lines, -13 removed lines

@@ -83,7 +83,6 @@ 
 
 	 /**
 	  * setIdentifier
-
 	  * Sets the data associated with an object in the Collection
 	  * if no $identifier is supplied, then the spl_object_hash() is used
 	  *
@@ -352,18 +351,18 @@ 
 
 
 
-     /**
-      * detaches ALL objects from the Collection
-      */
-     public function detachAll()
-     {
-         $this->rewind();
-         while ($this->valid()) {
-             $object = $this->current();
-             $this->next();
-             $this->detach($object);
-         }
-     }
+	 /**
+	  * detaches ALL objects from the Collection
+	  */
+	 public function detachAll()
+	 {
+		 $this->rewind();
+		 while ($this->valid()) {
+			 $object = $this->current();
+			 $this->next();
+			 $this->detach($object);
+		 }
+	 }
 
 
 

core/services/loaders/Loader.php

Indentation +134 added lines, -134 removed lines

@@ -24,140 +24,140 @@
 {
 
 
-    /**
-     * @var LoaderInterface $new_loader
-     */
-    private $new_loader;
-
-
-    /**
-     * @var LoaderInterface $shared_loader
-     */
-    private $shared_loader;
-
-
-
-    /**
-     * Loader constructor.
-     *
-     * @param LoaderInterface|null $new_loader
-     * @param LoaderInterface|null $shared_loader
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderInterface $new_loader = null, LoaderInterface $shared_loader = null)
-    {
-        $this->new_loader = $this->setupNewLoader($new_loader);
-        $this->shared_loader = $this->setupSharedLoader($shared_loader);
-    }
-
-
-
-    /**
-     * @param LoaderInterface|null $new_loader
-     * @return CoreLoader|LoaderInterface
-     * @throws InvalidArgumentException
-     */
-    private function setupNewLoader(LoaderInterface $new_loader = null)
-    {
-        // if not already generated, create a standard loader
-        if (! $new_loader instanceof LoaderInterface) {
-            $new_loader = new CoreLoader(EE_Registry::instance());
-        }
-        return $new_loader;
-    }
-
-
-
-    /**
-     * @param LoaderInterface|null $shared_loader
-     * @return CoreLoader|LoaderInterface
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function setupSharedLoader(LoaderInterface $shared_loader = null)
-    {
-        // if not already generated, create a caching loader
-        if (! $shared_loader instanceof LoaderInterface) {
-            $shared_loader = new CachingLoader(
-                new CoreLoader(EE_Registry::instance()),
-                new LooseCollection('')
-            );
-        }
-        return $shared_loader;
-    }
-
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getNewLoader()
-    {
-        return $this->new_loader;
-    }
-
-
-
-    /**
-     * @return LoaderInterface
-     */
-    public function getSharedLoader()
-    {
-        return $this->shared_loader;
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true)
-    {
-        return $shared
-            ? $this->getSharedLoader()->load($fqcn, $arguments)
-            : $this->getNewLoader()->load($fqcn, $arguments);
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, $arguments = array())
-    {
-        return $this->getNewLoader()->load($fqcn, $arguments);
-    }
-
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, $arguments = array())
-    {
-        return $this->getSharedLoader()->load($fqcn, $arguments);
-    }
-
-
-
-    /**
-     * calls reset() on loaders if that method exists
-     */
-    public function reset()
-    {
-        $this->new_loader->reset();
-        $this->shared_loader->reset();
-    }
+	/**
+	 * @var LoaderInterface $new_loader
+	 */
+	private $new_loader;
+
+
+	/**
+	 * @var LoaderInterface $shared_loader
+	 */
+	private $shared_loader;
+
+
+
+	/**
+	 * Loader constructor.
+	 *
+	 * @param LoaderInterface|null $new_loader
+	 * @param LoaderInterface|null $shared_loader
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderInterface $new_loader = null, LoaderInterface $shared_loader = null)
+	{
+		$this->new_loader = $this->setupNewLoader($new_loader);
+		$this->shared_loader = $this->setupSharedLoader($shared_loader);
+	}
+
+
+
+	/**
+	 * @param LoaderInterface|null $new_loader
+	 * @return CoreLoader|LoaderInterface
+	 * @throws InvalidArgumentException
+	 */
+	private function setupNewLoader(LoaderInterface $new_loader = null)
+	{
+		// if not already generated, create a standard loader
+		if (! $new_loader instanceof LoaderInterface) {
+			$new_loader = new CoreLoader(EE_Registry::instance());
+		}
+		return $new_loader;
+	}
+
+
+
+	/**
+	 * @param LoaderInterface|null $shared_loader
+	 * @return CoreLoader|LoaderInterface
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function setupSharedLoader(LoaderInterface $shared_loader = null)
+	{
+		// if not already generated, create a caching loader
+		if (! $shared_loader instanceof LoaderInterface) {
+			$shared_loader = new CachingLoader(
+				new CoreLoader(EE_Registry::instance()),
+				new LooseCollection('')
+			);
+		}
+		return $shared_loader;
+	}
+
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getNewLoader()
+	{
+		return $this->new_loader;
+	}
+
+
+
+	/**
+	 * @return LoaderInterface
+	 */
+	public function getSharedLoader()
+	{
+		return $this->shared_loader;
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true)
+	{
+		return $shared
+			? $this->getSharedLoader()->load($fqcn, $arguments)
+			: $this->getNewLoader()->load($fqcn, $arguments);
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, $arguments = array())
+	{
+		return $this->getNewLoader()->load($fqcn, $arguments);
+	}
+
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, $arguments = array())
+	{
+		return $this->getSharedLoader()->load($fqcn, $arguments);
+	}
+
+
+
+	/**
+	 * calls reset() on loaders if that method exists
+	 */
+	public function reset()
+	{
+		$this->new_loader->reset();
+		$this->shared_loader->reset();
+	}
 
 }
 // End of file Loader.php

Spacing +2 added lines, -2 removed lines

@@ -62,7 +62,7 @@ 
     private function setupNewLoader(LoaderInterface $new_loader = null)
     {
         // if not already generated, create a standard loader
-        if (! $new_loader instanceof LoaderInterface) {
+        if ( ! $new_loader instanceof LoaderInterface) {
             $new_loader = new CoreLoader(EE_Registry::instance());
         }
         return $new_loader;
@@ -80,7 +80,7 @@ 
     private function setupSharedLoader(LoaderInterface $shared_loader = null)
     {
         // if not already generated, create a caching loader
-        if (! $shared_loader instanceof LoaderInterface) {
+        if ( ! $shared_loader instanceof LoaderInterface) {
             $shared_loader = new CachingLoader(
                 new CoreLoader(EE_Registry::instance()),
                 new LooseCollection('')

core/services/loaders/CachingLoader.php

Indentation +108 added lines, -108 removed lines

@@ -22,114 +22,114 @@
 class CachingLoader extends LoaderDecorator
 {
 
-    /**
-     * @var CollectionInterface $cache
-     */
-    protected $cache;
-
-    /**
-     * @var string $identifier
-     */
-    protected $identifier;
-
-
-
-    /**
-     * CachingLoader constructor.
-     *
-     * @param LoaderInterface     $loader
-     * @param CollectionInterface $cache
-     * @param string              $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderInterface $loader, CollectionInterface $cache, $identifier = '')
-    {
-        parent::__construct($loader);
-        $this->cache = $cache;
-        $this->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 string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws InvalidEntityException
-     * @throws ServiceNotFoundException
-     */
-    public function load($fqcn, $arguments = 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
-            )
-        ){
-            return $this->loader->load($fqcn, $arguments);
-        }
-        $identifier = md5($fqcn . serialize($arguments));
-        if($this->cache->has($identifier)){
-            return $this->cache->get($identifier);
-        }
-        $object = $this->loader->load($fqcn, $arguments);
-        $this->cache->add($object, $identifier);
-        return $object;
-    }
-
-
-
-    /**
-     * empties cache and calls reset() on loader if method exists
-     */
-    public function reset()
-    {
-        $this->cache->detachAll();
-        $this->loader->reset();
-    }
+	/**
+	 * @var CollectionInterface $cache
+	 */
+	protected $cache;
+
+	/**
+	 * @var string $identifier
+	 */
+	protected $identifier;
+
+
+
+	/**
+	 * CachingLoader constructor.
+	 *
+	 * @param LoaderInterface     $loader
+	 * @param CollectionInterface $cache
+	 * @param string              $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderInterface $loader, CollectionInterface $cache, $identifier = '')
+	{
+		parent::__construct($loader);
+		$this->cache = $cache;
+		$this->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 string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InvalidEntityException
+	 * @throws ServiceNotFoundException
+	 */
+	public function load($fqcn, $arguments = 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
+			)
+		){
+			return $this->loader->load($fqcn, $arguments);
+		}
+		$identifier = md5($fqcn . serialize($arguments));
+		if($this->cache->has($identifier)){
+			return $this->cache->get($identifier);
+		}
+		$object = $this->loader->load($fqcn, $arguments);
+		$this->cache->add($object, $identifier);
+		return $object;
+	}
+
+
+
+	/**
+	 * empties cache and calls reset() on loader if method exists
+	 */
+	public function reset()
+	{
+		$this->cache->detachAll();
+		$this->loader->reset();
+	}
 
 
 }

Spacing +4 added lines, -4 removed lines

@@ -102,17 +102,17 @@
         $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(
+        if (
             apply_filters(
                 'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
                 false,
                 $this
             )
-        ){
+        ) {
             return $this->loader->load($fqcn, $arguments);
         }
-        $identifier = md5($fqcn . serialize($arguments));
-        if($this->cache->has($identifier)){
+        $identifier = md5($fqcn.serialize($arguments));
+        if ($this->cache->has($identifier)) {
             return $this->cache->get($identifier);
         }
         $object = $this->loader->load($fqcn, $arguments);

core/services/loaders/LoaderInterface.php

Indentation +10 added lines, -10 removed lines

@@ -9,19 +9,19 @@
 interface LoaderInterface
 {
 
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array());
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array());
 
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 
 }
 // End of file LoaderInterface.php