eventespresso / event-espresso-core

core/services/commands/CommandFactory.php

Indentation +34 added lines, -34 removed lines

@@ -24,40 +24,40 @@
 
 
 
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-
-
-    /**
-     * CommandFactory constructor
-     *
-     * @param LoaderInterface $loader
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function __construct(LoaderInterface $loader = null)
-    {
-       $this->loader = $loader;
-    }
-
-
-
-    /**
-     * @param string $command_fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getNew($command_fqcn, $arguments = array())
-    {
-        return $this->loader->getNew($command_fqcn, $arguments);
-    }
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+
+
+	/**
+	 * CommandFactory constructor
+	 *
+	 * @param LoaderInterface $loader
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function __construct(LoaderInterface $loader = null)
+	{
+	   $this->loader = $loader;
+	}
+
+
+
+	/**
+	 * @param string $command_fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getNew($command_fqcn, $arguments = array())
+	{
+		return $this->loader->getNew($command_fqcn, $arguments);
+	}
 
 
 

core/services/commands/CommandFactoryInterface.php

Indentation +9 added lines, -9 removed lines

@@ -13,15 +13,15 @@
 interface CommandFactoryInterface
 {
 
-    /**
-     * @param string $command_fqcn
-     * @param array  $arguments
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function getNew($command_fqcn, $arguments = array());
+	/**
+	 * @param string $command_fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function getNew($command_fqcn, $arguments = array());
 
 }
 // End of file CommandFactoryInterface.php

core/services/commands/CommandHandlerManager.php

Indentation +104 added lines, -104 removed lines

@@ -6,7 +6,7 @@ 
 use EventEspresso\core\services\loaders\LoaderInterface;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,109 +24,109 @@ 
 class CommandHandlerManager implements CommandHandlerManagerInterface
 {
 
-    /**
-     * @var CommandHandlerInterface[] $command_handlers
-     */
-    protected $command_handlers;
-
-    /**
-     * @type LoaderInterface $loader
-     */
-    private $loader;
-
-
-
-    /**
-     * CommandHandlerManager constructor
-     *
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
-
-
-
-    /**
-     * By default, Commands and CommandHandlers would normally
-     * reside in the same folder under the same namespace,
-     * and the names of the two classes would only differ in that
-     * one ends in "Command" and the other ends in "CommandHandler".
-     * However, if you wanted to utilize a CommandHandler from somewhere else,
-     * then this method allows you to add that CommandHandler and specify the FQCN
-     * (Fully Qualified ClassName) for the Command class that it should be used for.
-     * For example:
-     *      by default the "Vendor\some\namespace\DoSomethingCommand"
-     *      would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler"
-     *      but if you wanted to instead process that commend using:
-     *      "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler"
-     *      then the following code:
-     *      $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' );
-     *      $CommandHandlerManager->addCommandHandler(
-     *          new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(),
-     *          'Vendor\some\namespace\DoSomethingCommand'
-     *      );
-     *      would result in the alternate CommandHandler being used to process that Command
-     *
-     * @param CommandHandlerInterface $command_handler
-     * @param string                  $fqcn_for_command Fully Qualified ClassName for Command
-     * @return void
-     * @throws InvalidCommandHandlerException
-     */
-    public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '')
-    {
-        $command = ! empty($fqcn_for_command)
-            ? $fqcn_for_command
-            : str_replace('CommandHandler', 'Command', get_class($command_handler));
-        if (empty($command)) {
-            throw new InvalidCommandHandlerException($command);
-        }
-        $this->command_handlers[$command] = $command_handler;
-    }
-
-
-
-    /**
-     * @param CommandInterface $command
-     * @param CommandBusInterface       $command_bus
-     * @return mixed
-     * @throws DomainException
-     * @throws CommandHandlerNotFoundException
-     */
-    public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null)
-    {
-        $command_name = get_class($command);
-        $command_handler = apply_filters(
-            'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler',
-            str_replace('Command', 'CommandHandler', $command_name),
-            $command
-        );
-        $handler = null;
-        // has a command handler already been set for this class ?
-        // if not, can we find one via the FQCN ?
-        if (isset($this->command_handlers[$command_name])) {
-            $handler = $this->command_handlers[$command_name];
-        } else if (class_exists($command_handler)) {
-            $handler = $this->loader->getShared($command_handler);
-        }
-        // if Handler requires an instance of the CommandBus, but that has not yet been set
-        if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
-            if (! $command_bus instanceof CommandBusInterface) {
-                throw new DomainException(
-                    esc_html__(
-                        'CompositeCommandHandler classes require an instance of the CommandBus.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $handler->setCommandBus($command_bus);
-        }
-        if ($handler instanceof CommandHandlerInterface) {
-            return $handler;
-        }
-        throw new CommandHandlerNotFoundException($command_handler);
-    }
+	/**
+	 * @var CommandHandlerInterface[] $command_handlers
+	 */
+	protected $command_handlers;
+
+	/**
+	 * @type LoaderInterface $loader
+	 */
+	private $loader;
+
+
+
+	/**
+	 * CommandHandlerManager constructor
+	 *
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
+
+
+
+	/**
+	 * By default, Commands and CommandHandlers would normally
+	 * reside in the same folder under the same namespace,
+	 * and the names of the two classes would only differ in that
+	 * one ends in "Command" and the other ends in "CommandHandler".
+	 * However, if you wanted to utilize a CommandHandler from somewhere else,
+	 * then this method allows you to add that CommandHandler and specify the FQCN
+	 * (Fully Qualified ClassName) for the Command class that it should be used for.
+	 * For example:
+	 *      by default the "Vendor\some\namespace\DoSomethingCommand"
+	 *      would resolve to using "Vendor\some\namespace\DoSomethingCommandHandler"
+	 *      but if you wanted to instead process that commend using:
+	 *      "Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler"
+	 *      then the following code:
+	 *      $CommandHandlerManager = $this->loader->getShared( 'CommandHandlerManagerInterface' );
+	 *      $CommandHandlerManager->addCommandHandler(
+	 *          new Vendor\a\totally\different\namespace\for\DoSomethingCommandHandler(),
+	 *          'Vendor\some\namespace\DoSomethingCommand'
+	 *      );
+	 *      would result in the alternate CommandHandler being used to process that Command
+	 *
+	 * @param CommandHandlerInterface $command_handler
+	 * @param string                  $fqcn_for_command Fully Qualified ClassName for Command
+	 * @return void
+	 * @throws InvalidCommandHandlerException
+	 */
+	public function addCommandHandler(CommandHandlerInterface $command_handler, $fqcn_for_command = '')
+	{
+		$command = ! empty($fqcn_for_command)
+			? $fqcn_for_command
+			: str_replace('CommandHandler', 'Command', get_class($command_handler));
+		if (empty($command)) {
+			throw new InvalidCommandHandlerException($command);
+		}
+		$this->command_handlers[$command] = $command_handler;
+	}
+
+
+
+	/**
+	 * @param CommandInterface $command
+	 * @param CommandBusInterface       $command_bus
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws CommandHandlerNotFoundException
+	 */
+	public function getCommandHandler(CommandInterface $command, CommandBusInterface $command_bus = null)
+	{
+		$command_name = get_class($command);
+		$command_handler = apply_filters(
+			'FHEE__EventEspresso_core_services_commands_CommandHandlerManager__getCommandHandler__command_handler',
+			str_replace('Command', 'CommandHandler', $command_name),
+			$command
+		);
+		$handler = null;
+		// has a command handler already been set for this class ?
+		// if not, can we find one via the FQCN ?
+		if (isset($this->command_handlers[$command_name])) {
+			$handler = $this->command_handlers[$command_name];
+		} else if (class_exists($command_handler)) {
+			$handler = $this->loader->getShared($command_handler);
+		}
+		// if Handler requires an instance of the CommandBus, but that has not yet been set
+		if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
+			if (! $command_bus instanceof CommandBusInterface) {
+				throw new DomainException(
+					esc_html__(
+						'CompositeCommandHandler classes require an instance of the CommandBus.',
+						'event_espresso'
+					)
+				);
+			}
+			$handler->setCommandBus($command_bus);
+		}
+		if ($handler instanceof CommandHandlerInterface) {
+			return $handler;
+		}
+		throw new CommandHandlerNotFoundException($command_handler);
+	}
 
 
 }

Spacing +2 added lines, -2 removed lines

@@ -5,7 +5,7 @@ 
 use DomainException;
 use EventEspresso\core\services\loaders\LoaderInterface;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -112,7 +112,7 @@ 
         }
         // if Handler requires an instance of the CommandBus, but that has not yet been set
         if ($handler instanceof CompositeCommandHandler && ! $handler->commandBus() instanceof CommandBusInterface) {
-            if (! $command_bus instanceof CommandBusInterface) {
+            if ( ! $command_bus instanceof CommandBusInterface) {
                 throw new DomainException(
                     esc_html__(
                         'CompositeCommandHandler classes require an instance of the CommandBus.',

core/services/loaders/Loader.php

Indentation +134 added lines, -134 removed lines

@@ -24,140 +24,140 @@
 {
 
 
-    /**
-     * @var LoaderDecoratorInterface $new_loader
-     */
-    private $new_loader;
-
-
-    /**
-     * @var LoaderDecoratorInterface $shared_loader
-     */
-    private $shared_loader;
-
-
-
-    /**
-     * Loader constructor.
-     *
-     * @param LoaderDecoratorInterface|null $new_loader
-     * @param LoaderDecoratorInterface|null $shared_loader
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderDecoratorInterface $new_loader = null, LoaderDecoratorInterface $shared_loader = null)
-    {
-        $this->new_loader = $this->setupNewLoader($new_loader);
-        $this->shared_loader = $this->setupSharedLoader($shared_loader);
-    }
-
-
-
-    /**
-     * @param LoaderDecoratorInterface|null $new_loader
-     * @return CoreLoader|LoaderDecoratorInterface
-     * @throws InvalidArgumentException
-     */
-    private function setupNewLoader(LoaderDecoratorInterface $new_loader = null)
-    {
-        // if not already generated, create a standard loader
-        if (! $new_loader instanceof LoaderDecoratorInterface) {
-            $new_loader = new CoreLoader(EE_Registry::instance());
-        }
-        return $new_loader;
-    }
-
-
-
-    /**
-     * @param LoaderDecoratorInterface|null $shared_loader
-     * @return CoreLoader|LoaderDecoratorInterface
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function setupSharedLoader(LoaderDecoratorInterface $shared_loader = null)
-    {
-        // if not already generated, create a caching loader
-        if (! $shared_loader instanceof LoaderDecoratorInterface) {
-            $shared_loader = new CachingLoader(
-                new CoreLoader(EE_Registry::instance()),
-                new LooseCollection('')
-            );
-        }
-        return $shared_loader;
-    }
-
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    public function getNewLoader()
-    {
-        return $this->new_loader;
-    }
-
-
-
-    /**
-     * @return LoaderDecoratorInterface
-     */
-    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 LoaderDecoratorInterface $new_loader
+	 */
+	private $new_loader;
+
+
+	/**
+	 * @var LoaderDecoratorInterface $shared_loader
+	 */
+	private $shared_loader;
+
+
+
+	/**
+	 * Loader constructor.
+	 *
+	 * @param LoaderDecoratorInterface|null $new_loader
+	 * @param LoaderDecoratorInterface|null $shared_loader
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderDecoratorInterface $new_loader = null, LoaderDecoratorInterface $shared_loader = null)
+	{
+		$this->new_loader = $this->setupNewLoader($new_loader);
+		$this->shared_loader = $this->setupSharedLoader($shared_loader);
+	}
+
+
+
+	/**
+	 * @param LoaderDecoratorInterface|null $new_loader
+	 * @return CoreLoader|LoaderDecoratorInterface
+	 * @throws InvalidArgumentException
+	 */
+	private function setupNewLoader(LoaderDecoratorInterface $new_loader = null)
+	{
+		// if not already generated, create a standard loader
+		if (! $new_loader instanceof LoaderDecoratorInterface) {
+			$new_loader = new CoreLoader(EE_Registry::instance());
+		}
+		return $new_loader;
+	}
+
+
+
+	/**
+	 * @param LoaderDecoratorInterface|null $shared_loader
+	 * @return CoreLoader|LoaderDecoratorInterface
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function setupSharedLoader(LoaderDecoratorInterface $shared_loader = null)
+	{
+		// if not already generated, create a caching loader
+		if (! $shared_loader instanceof LoaderDecoratorInterface) {
+			$shared_loader = new CachingLoader(
+				new CoreLoader(EE_Registry::instance()),
+				new LooseCollection('')
+			);
+		}
+		return $shared_loader;
+	}
+
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	public function getNewLoader()
+	{
+		return $this->new_loader;
+	}
+
+
+
+	/**
+	 * @return LoaderDecoratorInterface
+	 */
+	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(LoaderDecoratorInterface $new_loader = null)
     {
         // if not already generated, create a standard loader
-        if (! $new_loader instanceof LoaderDecoratorInterface) {
+        if ( ! $new_loader instanceof LoaderDecoratorInterface) {
             $new_loader = new CoreLoader(EE_Registry::instance());
         }
         return $new_loader;
@@ -80,7 +80,7 @@ 
     private function setupSharedLoader(LoaderDecoratorInterface $shared_loader = null)
     {
         // if not already generated, create a caching loader
-        if (! $shared_loader instanceof LoaderDecoratorInterface) {
+        if ( ! $shared_loader instanceof LoaderDecoratorInterface) {
             $shared_loader = new CachingLoader(
                 new CoreLoader(EE_Registry::instance()),
                 new LooseCollection('')

core/services/loaders/LoaderDecoratorInterface.php

Indentation +10 added lines, -10 removed lines

@@ -9,19 +9,19 @@
 interface LoaderDecoratorInterface
 {
 
-    /**
-     * @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

core/services/loaders/LoaderInterface.php

Indentation +33 added lines, -33 removed lines

@@ -9,39 +9,39 @@
 interface LoaderInterface
 {
 
-    /**
-     * Can be for instantiating a new instance of a class,
-     * or for getting a shared instance of a class (default)
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @param bool   $shared
-     * @return mixed
-     */
-    public function load($fqcn, $arguments = array(), $shared = true);
-
-    /**
-     * Used for instantiating a new instance of a class
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, $arguments = array());
-
-    /**
-     * Used for getting a shared instance of a class
-     *
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, $arguments = array());
-
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * Can be for instantiating a new instance of a class,
+	 * or for getting a shared instance of a class (default)
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @param bool   $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, $arguments = array(), $shared = true);
+
+	/**
+	 * Used for instantiating a new instance of a class
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, $arguments = array());
+
+	/**
+	 * Used for getting a shared instance of a class
+	 *
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, $arguments = array());
+
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 
 }
 // End of file LoaderInterface.php

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 LoaderDecoratorInterface $loader
-     * @param CollectionInterface      $cache
-     * @param string                   $identifier
-     * @throws InvalidDataTypeException
-     */
-    public function __construct(LoaderDecoratorInterface $loader, CollectionInterface $cache, $identifier = '')
-    {
-        parent::__construct($loader);
-        $this->cache = $cache;
-        $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 LoaderDecoratorInterface $loader
+	 * @param CollectionInterface      $cache
+	 * @param string                   $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	public function __construct(LoaderDecoratorInterface $loader, CollectionInterface $cache, $identifier = '')
+	{
+		parent::__construct($loader);
+		$this->cache = $cache;
+		$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();
+	}
 
 
 }

core/services/loaders/LoaderDecorator.php

Indentation +16 added lines, -16 removed lines

@@ -19,22 +19,22 @@
 {
 
 
-    /**
-     * @var LoaderDecoratorInterface $loader
-     */
-    protected $loader;
-
-
-
-    /**
-     * LoaderDecorator constructor.
-     *
-     * @param LoaderDecoratorInterface $loader
-     */
-    public function __construct(LoaderDecoratorInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * @var LoaderDecoratorInterface $loader
+	 */
+	protected $loader;
+
+
+
+	/**
+	 * LoaderDecorator constructor.
+	 *
+	 * @param LoaderDecoratorInterface $loader
+	 */
+	public function __construct(LoaderDecoratorInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
 
 

core/services/loaders/CoreLoader.php

Indentation +52 added lines, -52 removed lines

@@ -23,58 +23,58 @@
 class CoreLoader implements LoaderDecoratorInterface
 {
 
-    /**
-     * @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