eventespresso / event-espresso-core

core/services/i18n/LegacyTextDomainOptions.php

Indentation +42 added lines, -42 removed lines

@@ -14,50 +14,50 @@
  */
 class LegacyTextDomainOptions
 {
-    private LoadedTextDomains $loaded_text_domains;
+	private LoadedTextDomains $loaded_text_domains;
 
 
-    /**
-     * @param LoadedTextDomains|null $loaded_text_domains
-     */
-    public function __construct(?LoadedTextDomains $loaded_text_domains = null)
-    {
-        $this->loaded_text_domains = $loaded_text_domains ?? new LoadedTextDomains();
-    }
+	/**
+	 * @param LoadedTextDomains|null $loaded_text_domains
+	 */
+	public function __construct(?LoadedTextDomains $loaded_text_domains = null)
+	{
+		$this->loaded_text_domains = $loaded_text_domains ?? new LoadedTextDomains();
+	}
 
 
-    /**
-     * attempts to collect all the ee_lang_check_* options stored in the database
-     * and add them to one single option handled by EventEspresso\core\services\i18n\LoadedTextDomains
-     *
-     * @since   5.0.0.p
-     */
-    public function convertToConsolidatedFormat()
-    {
-        $options = wp_load_alloptions();
-        foreach ($options as $slug => $values) {
-            if (strpos($slug, 'ee_lang_check_') === 0) {
-                // convert something like "ee_lang_check_en_CA_4.10.39.rc.018" to 'en_CA_4.10.39.rc.018'
-                $locale_version = str_replace('ee_lang_check_', '', $slug);
-                // split 'en_CA_4.10.39.rc.018' into [ 'en', 'CA', '4.10.39.rc.018' ]
-                $locale_version = explode('_', $locale_version);
-                $locale         = null;
-                $version        = null;
-                switch (count($locale_version)) {
-                    case 3:
-                        $locale  = "$locale_version[0]_$locale_version[1]";
-                        $version = $locale_version[2];
-                        break;
-                    case 2:
-                        $locale  = $locale_version[0];
-                        $version = $locale_version[1];
-                        break;
-                }
-                if ($locale && $version) {
-                    $this->loaded_text_domains->versionLoaded($locale, $version);
-                    delete_option($slug);
-                }
-            }
-        }
-    }
+	/**
+	 * attempts to collect all the ee_lang_check_* options stored in the database
+	 * and add them to one single option handled by EventEspresso\core\services\i18n\LoadedTextDomains
+	 *
+	 * @since   5.0.0.p
+	 */
+	public function convertToConsolidatedFormat()
+	{
+		$options = wp_load_alloptions();
+		foreach ($options as $slug => $values) {
+			if (strpos($slug, 'ee_lang_check_') === 0) {
+				// convert something like "ee_lang_check_en_CA_4.10.39.rc.018" to 'en_CA_4.10.39.rc.018'
+				$locale_version = str_replace('ee_lang_check_', '', $slug);
+				// split 'en_CA_4.10.39.rc.018' into [ 'en', 'CA', '4.10.39.rc.018' ]
+				$locale_version = explode('_', $locale_version);
+				$locale         = null;
+				$version        = null;
+				switch (count($locale_version)) {
+					case 3:
+						$locale  = "$locale_version[0]_$locale_version[1]";
+						$version = $locale_version[2];
+						break;
+					case 2:
+						$locale  = $locale_version[0];
+						$version = $locale_version[1];
+						break;
+				}
+				if ($locale && $version) {
+					$this->loaded_text_domains->versionLoaded($locale, $version);
+					delete_option($slug);
+				}
+			}
+		}
+	}
 }

core/services/loaders/Loader.php

Indentation +127 added lines, -127 removed lines

@@ -13,131 +13,131 @@
  */
 class Loader implements LoaderInterface
 {
-    private LoaderDecoratorInterface $new_loader;
-
-    private CachingLoaderDecoratorInterface $shared_loader;
-
-    private ClassInterfaceCache $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(): LoaderDecoratorInterface
-    {
-        return $this->new_loader;
-    }
-
-
-    /**
-     * @return CachingLoaderDecoratorInterface
-     */
-    public function getSharedLoader(): CachingLoaderDecoratorInterface
-    {
-        return $this->shared_loader;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = [], bool $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 = [])
-    {
-        return $this->load($fqcn, $arguments, false);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, array $arguments = [])
-    {
-        return $this->load($fqcn, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return bool
-     */
-    public function isShared($fqcn, array $arguments = []): bool
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->isShared($fqcn, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     */
-    public function share($fqcn, $object, array $arguments = []): bool
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->share($fqcn, $object, $arguments);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return bool
-     */
-    public function remove($fqcn, array $arguments = []): bool
-    {
-        $fqcn = $this->class_cache->getFqn($fqcn);
-        return $this->getSharedLoader()->remove($fqcn, $arguments);
-    }
-
-
-    /**
-     * calls reset() on loaders if that method exists
-     */
-    public function reset()
-    {
-        $this->shared_loader->reset();
-    }
+	private LoaderDecoratorInterface $new_loader;
+
+	private CachingLoaderDecoratorInterface $shared_loader;
+
+	private ClassInterfaceCache $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(): LoaderDecoratorInterface
+	{
+		return $this->new_loader;
+	}
+
+
+	/**
+	 * @return CachingLoaderDecoratorInterface
+	 */
+	public function getSharedLoader(): CachingLoaderDecoratorInterface
+	{
+		return $this->shared_loader;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = [], bool $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 = [])
+	{
+		return $this->load($fqcn, $arguments, false);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, array $arguments = [])
+	{
+		return $this->load($fqcn, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return bool
+	 */
+	public function isShared($fqcn, array $arguments = []): bool
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->isShared($fqcn, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 */
+	public function share($fqcn, $object, array $arguments = []): bool
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->share($fqcn, $object, $arguments);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return bool
+	 */
+	public function remove($fqcn, array $arguments = []): bool
+	{
+		$fqcn = $this->class_cache->getFqn($fqcn);
+		return $this->getSharedLoader()->remove($fqcn, $arguments);
+	}
+
+
+	/**
+	 * calls reset() on loaders if that method exists
+	 */
+	public function reset()
+	{
+		$this->shared_loader->reset();
+	}
 }

core/services/loaders/LoaderFactory.php

Indentation +58 added lines, -58 removed lines

@@ -70,68 +70,68 @@
  */
 class LoaderFactory
 {
-    private static ?LoaderInterface $loader = null;
+	private static ?LoaderInterface $loader = null;
 
 
-    /**
-     * @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
-    ): LoaderInterface {
-        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
+	): LoaderInterface {
+		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;
+	}
 
 
-    /**
-     * Used for instantiating a new instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public static function getNew($fqcn, array $arguments = [])
-    {
-        return LoaderFactory::getLoader()->getNew($fqcn, $arguments);
-    }
+	/**
+	 * Used for instantiating a new instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public static function getNew($fqcn, array $arguments = [])
+	{
+		return LoaderFactory::getLoader()->getNew($fqcn, $arguments);
+	}
 
 
-    /**
-     * Used for getting a shared instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public static function getShared($fqcn, array $arguments = [])
-    {
-        return LoaderFactory::getLoader()->getShared($fqcn, $arguments);
-    }
+	/**
+	 * Used for getting a shared instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public static function getShared($fqcn, array $arguments = [])
+	{
+		return LoaderFactory::getLoader()->getShared($fqcn, $arguments);
+	}
 }

core/services/loaders/LoaderInterface.php

Indentation +44 added lines, -44 removed lines

@@ -7,58 +7,58 @@
 
 interface LoaderInterface
 {
-    /**
-     * Can be for instantiating a new instance of a class,
-     * or for getting a shared instance of a class (default)
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = [], bool $shared = true);
+	/**
+	 * Can be for instantiating a new instance of a class,
+	 * or for getting a shared instance of a class (default)
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = [], bool $shared = true);
 
 
-    /**
-     * Used for instantiating a new instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, array $arguments = []);
+	/**
+	 * Used for instantiating a new instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, array $arguments = []);
 
 
-    /**
-     * Used for getting a shared instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, array $arguments = []);
+	/**
+	 * Used for getting a shared instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, array $arguments = []);
 
 
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = []): bool;
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = []): bool;
 
 
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn): bool;
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn): bool;
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 }

core/services/loaders/CachingLoader.php

Indentation +200 added lines, -200 removed lines

@@ -16,204 +16,204 @@
  */
 class CachingLoader extends CachingLoaderDecorator
 {
-    protected bool $bypass = false;
-
-    protected CollectionInterface $cache;
-
-    protected string $identifier;
-
-    private ObjectIdentifier $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,
-        string $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",
-                [$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',
-            [$this, 'reset']
-        );
-        // caching can be turned off via the following code:
-        // add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
-        $this->bypass = filter_var(
-            apply_filters(
-                'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
-                false,
-                $this
-            ),
-            FILTER_VALIDATE_BOOLEAN
-        );
-    }
-
-
-    /**
-     * @return string
-     */
-    public function identifier(): string
-    {
-        return $this->identifier;
-    }
-
-
-    /**
-     * @param string|null $identifier
-     * @throws InvalidDataTypeException
-     */
-    private function setIdentifier(?string $identifier)
-    {
-        if (! is_string($identifier)) {
-            throw new InvalidDataTypeException('$identifier', $identifier, 'string');
-        }
-        $this->identifier = $identifier;
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = []): bool
-    {
-        if ($object instanceof $fqcn) {
-            $added = false;
-            if ($arguments) {
-                // first cache the object using the identifier that includes the arguments
-                $added = $this->cache->add($object, $this->object_identifier->getIdentifier($fqcn, $arguments));
-            }
-            // then again using the identifier without the arguments
-            // WHY? because most requests for the object will not include arguments
-            $object_identifier = $this->object_identifier->getIdentifier($fqcn);
-            // but only if the object is not already in the cache
-            if (! $this->cache->has($object_identifier)) {
-                $added = $this->cache->add($object, $object_identifier)
-                    ? true
-                    : $added;
-            }
-            return $added;
-        }
-        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
-     * @return bool
-     * @since 5.0.42
-     */
-    public function isShared($fqcn, array $arguments = []): bool
-    {
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        return $this->cache->has($object_identifier);
-    }
-
-
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = [], bool $shared = true)
-    {
-        $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 ($this->bypass) {
-            // 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 4.9.62.p
-     */
-    public function clearCache()
-    {
-        $cache_class          = get_class($this->cache);
-        $collection_interface = $this->cache->collectionInterface();
-        $this->cache->trashAndDetachAll();
-        $new_cache = new $cache_class($collection_interface);
-        if (! $new_cache instanceof CollectionInterface) {
-            throw new InvalidDataTypeException('CachingLoader::$cache', $new_cache, 'CollectionInterface');
-        }
-        $this->cache = $new_cache;
-    }
-
-
-    /**
-     * @param string $fqcn
-     * @param array  $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn, array $arguments = []): bool
-    {
-        $fqcn              = ltrim($fqcn, '\\');
-        $object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
-        $object            = $this->cache->has($object_identifier)
-            ? $this->cache->get($object_identifier)
-            : $this->loader->load($fqcn, $arguments);
-        return $this->cache->remove($object);
-    }
+	protected bool $bypass = false;
+
+	protected CollectionInterface $cache;
+
+	protected string $identifier;
+
+	private ObjectIdentifier $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,
+		string $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",
+				[$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',
+			[$this, 'reset']
+		);
+		// caching can be turned off via the following code:
+		// add_filter('FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache', '__return_true');
+		$this->bypass = filter_var(
+			apply_filters(
+				'FHEE__EventEspresso_core_services_loaders_CachingLoader__load__bypass_cache',
+				false,
+				$this
+			),
+			FILTER_VALIDATE_BOOLEAN
+		);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function identifier(): string
+	{
+		return $this->identifier;
+	}
+
+
+	/**
+	 * @param string|null $identifier
+	 * @throws InvalidDataTypeException
+	 */
+	private function setIdentifier(?string $identifier)
+	{
+		if (! is_string($identifier)) {
+			throw new InvalidDataTypeException('$identifier', $identifier, 'string');
+		}
+		$this->identifier = $identifier;
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = []): bool
+	{
+		if ($object instanceof $fqcn) {
+			$added = false;
+			if ($arguments) {
+				// first cache the object using the identifier that includes the arguments
+				$added = $this->cache->add($object, $this->object_identifier->getIdentifier($fqcn, $arguments));
+			}
+			// then again using the identifier without the arguments
+			// WHY? because most requests for the object will not include arguments
+			$object_identifier = $this->object_identifier->getIdentifier($fqcn);
+			// but only if the object is not already in the cache
+			if (! $this->cache->has($object_identifier)) {
+				$added = $this->cache->add($object, $object_identifier)
+					? true
+					: $added;
+			}
+			return $added;
+		}
+		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
+	 * @return bool
+	 * @since 5.0.42
+	 */
+	public function isShared($fqcn, array $arguments = []): bool
+	{
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		return $this->cache->has($object_identifier);
+	}
+
+
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = [], bool $shared = true)
+	{
+		$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 ($this->bypass) {
+			// 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 4.9.62.p
+	 */
+	public function clearCache()
+	{
+		$cache_class          = get_class($this->cache);
+		$collection_interface = $this->cache->collectionInterface();
+		$this->cache->trashAndDetachAll();
+		$new_cache = new $cache_class($collection_interface);
+		if (! $new_cache instanceof CollectionInterface) {
+			throw new InvalidDataTypeException('CachingLoader::$cache', $new_cache, 'CollectionInterface');
+		}
+		$this->cache = $new_cache;
+	}
+
+
+	/**
+	 * @param string $fqcn
+	 * @param array  $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn, array $arguments = []): bool
+	{
+		$fqcn              = ltrim($fqcn, '\\');
+		$object_identifier = $this->object_identifier->getIdentifier($fqcn, $arguments);
+		$object            = $this->cache->has($object_identifier)
+			? $this->cache->get($object_identifier)
+			: $this->loader->load($fqcn, $arguments);
+		return $this->cache->remove($object);
+	}
 }

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
      */
     private function setIdentifier(?string $identifier)
     {
-        if (! is_string($identifier)) {
+        if ( ! is_string($identifier)) {
             throw new InvalidDataTypeException('$identifier', $identifier, 'string');
         }
         $this->identifier = $identifier;
@@ -113,7 +113,7 @@ 
             // WHY? because most requests for the object will not include arguments
             $object_identifier = $this->object_identifier->getIdentifier($fqcn);
             // but only if the object is not already in the cache
-            if (! $this->cache->has($object_identifier)) {
+            if ( ! $this->cache->has($object_identifier)) {
                 $added = $this->cache->add($object, $object_identifier)
                     ? true
                     : $added;
@@ -194,7 +194,7 @@ 
         $collection_interface = $this->cache->collectionInterface();
         $this->cache->trashAndDetachAll();
         $new_cache = new $cache_class($collection_interface);
-        if (! $new_cache instanceof CollectionInterface) {
+        if ( ! $new_cache instanceof CollectionInterface) {
             throw new InvalidDataTypeException('CachingLoader::$cache', $new_cache, 'CollectionInterface');
         }
         $this->cache = $new_cache;

core/services/loaders/CoreLoader.php

Indentation +101 added lines, -101 removed lines

@@ -28,111 +28,111 @@
  */
 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, array $arguments = array(), bool $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, array $arguments = array(), bool $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
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reset()
-    {
-        if ($this->generator instanceof ResettableInterface) {
-            $this->generator->reset();
-        }
-    }
+	/**
+	 * calls reset() on generator if method exists
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reset()
+	{
+		if ($this->generator instanceof ResettableInterface) {
+			$this->generator->reset();
+		}
+	}
 }

core/services/loaders/LoaderDecorator.php

Indentation +13 added lines, -13 removed lines

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

core/services/loaders/CachingLoaderDecoratorInterface.php

Indentation +21 added lines, -21 removed lines

@@ -11,29 +11,29 @@
  */
 interface CachingLoaderDecoratorInterface extends LoaderDecoratorInterface
 {
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = []): bool;
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = []): bool;
 
 
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return bool
-     */
-    public function isShared($fqcn, array $arguments = []): bool;
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return bool
+	 */
+	public function isShared($fqcn, array $arguments = []): bool;
 
 
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn, array $arguments = []): bool;
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn, array $arguments = []): bool;
 }

core/services/loaders/LoaderDecoratorInterface.php

Indentation +11 added lines, -11 removed lines

@@ -6,18 +6,18 @@
 
 interface LoaderDecoratorInterface
 {
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = array(), bool $shared = true);
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = array(), bool $shared = true);
 
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 }