Released final 9.1.0 changes

Geolim4 · Geolim4 · commit c594c36fb86e · 2022-04-04T00:27:24.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,10 +3,17 @@
 - __API__
   - Upgraded Phpfastcache API to `4.1.0` ([see changes](CHANGELOG_API.md))
 - __Core__
+  - Added `\Phpfastcache\Helper\UninstanciableObjectTrait` trait which will contains base locked constructor for any classes that are nor meant to be instanciated.
   - Deprecated `\Phpfastcache\Config\Config::class` 
   - Removed/reworked/improved dead/unreachable/redundant/obsolete code, thanks to `Phpstan`
 - __Drivers__
   - **Added `Solr` driver support**
+- __Events__
+  - Added `\Phpfastcache\Event\EventInterface` for `\Phpfastcache\Event\Event` and subclasses below
+  - Added `\Phpfastcache\Drivers\Arangodb\Event` for Arangodb events
+  - Added `\Phpfastcache\Drivers\Dynamodb\Event` for Dynamodb events
+  - Added `\Phpfastcache\Drivers\Solr\Event` for Solr events
+  - Moved the following constant from `\Phpfastcache\Event\Event` to their respective drivers: `ARANGODB_CONNECTION`, `ARANGODB_COLLECTION_PARAMS`, `DYNAMODB_CREATE_TABLE`
 - __Cluster__
   - Fixed #855 // ClusterReplication drivers are saving erroneous expiration date in low-level backends
 - __Misc__
diff --git a/CHANGELOG_API.md b/CHANGELOG_API.md
@@ -1,4 +1,5 @@
 ## 4.1.0
+- Created `\Phpfastcache\Event\EventInterface` which will be used for `Phpfastcache\Event\Event` and any `Phpfastcache\Drivers\xxxxxxx\Event` classes
 - Extended `CacheItemPoolInterface::save()` with `ExtendedCacheItemPoolInterface::save()` for re-typing
 - Method `ExtendedCacheItemPoolInterface::getConfig()` now returns `ConfigurationOptionInterface` instead of `ConfigurationOption`
 - Method `ExtendedCacheItemPoolInterface::getDefaultConfig()` now returns `ConfigurationOptionInterface` instead of `ConfigurationOption`
diff --git a/docs/EVENTS.md b/docs/EVENTS.md
@@ -276,3 +276,14 @@ This is an exhaustive list, and it will be updated as soon as new events will be
     - **Description**
         - Allow you to alter the parameters built used to create the table
     - **Risky Circular Methods**: None
+
+#### Solr
+- onSolrBuildEndpoint(*Callable* **$callback**)
+    - **Callback arguments**
+        - *ExtendedCacheItemPoolInterface* **$itemPool**
+        - *EventReferenceParameter($params)* **$endpoints** _via EventReferenceParameter object_ **(type modification forbidden)**
+    - **Scope**
+        - Solr Driver
+    - **Description**
+        - Allow you to alter the endpoints built used to connect to Solr server
+    - **Risky Circular Methods**: None
diff --git a/lib/Phpfastcache/Api.php b/lib/Phpfastcache/Api.php
@@ -18,22 +18,17 @@
 
 use Phpfastcache\Exceptions\PhpfastcacheIOException;
 use Phpfastcache\Exceptions\PhpfastcacheLogicException;
+use Phpfastcache\Helper\UninstanciableObjectTrait;
 
 /**
  * Class Api
  * @package Phpfastcache
  */
 class Api
 {
-    protected static string $version = '4.1.0';
+    use UninstanciableObjectTrait;
 
-    /**
-     * Api constructor.
-     */
-    final protected function __construct()
-    {
-        // The Api is not meant to be instantiated
-    }
+    protected static string $version = '4.1.0';
 
     /**
      * This method will return the current
diff --git a/lib/Phpfastcache/CacheManager.php b/lib/Phpfastcache/CacheManager.php
@@ -26,6 +26,7 @@
 use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
 use Phpfastcache\Exceptions\PhpfastcacheLogicException;
 use Phpfastcache\Exceptions\PhpfastcacheUnsupportedOperationException;
+use Phpfastcache\Helper\UninstanciableObjectTrait;
 use Phpfastcache\Util\ClassNamespaceResolverTrait;
 
 /**
@@ -34,6 +35,7 @@
 class CacheManager
 {
     use ClassNamespaceResolverTrait;
+    use UninstanciableObjectTrait;
 
     public const CORE_DRIVER_NAMESPACE = 'Phpfastcache\Drivers\\';
 
@@ -56,14 +58,6 @@ class CacheManager
      */
     protected static array $driverCustoms = [];
 
-    /**
-     * CacheManager constructor.
-     */
-    final protected function __construct()
-    {
-        // The cache manager is not meant to be instantiated
-    }
-
     /**
      * @param string $instanceId
      * @return ExtendedCacheItemPoolInterface
@@ -270,7 +264,7 @@ static function (ExtendedCacheItemPoolInterface $cachePool) use ($cachePoolInsta
      */
     public static function setDefaultConfig(ConfigurationOptionInterface $config): void
     {
-        if (is_subclass_of($config, ConfigurationOption::class)) {
+        if (\is_subclass_of($config, ConfigurationOption::class)) {
             throw new PhpfastcacheInvalidArgumentException('Default configuration cannot be a child class of ConfigurationOption::class');
         }
         self::$config = $config;
diff --git a/lib/Phpfastcache/Config/IOConfigurationOptionTrait.php b/lib/Phpfastcache/Config/IOConfigurationOptionTrait.php
@@ -90,12 +90,12 @@ public function setCacheFileExtension(string $cacheFileExtension): static
         $this->enforceLockedProperty(__FUNCTION__);
         $safeFileExtensions = \explode('|', IOConfigurationOptionInterface::SAFE_FILE_EXTENSIONS);
 
-        if (str_contains($cacheFileExtension, '.')) {
+        if (\str_contains($cacheFileExtension, '.')) {
             throw new PhpfastcacheInvalidConfigurationException('cacheFileExtension cannot contain a dot "."');
         }
         if (!\in_array($cacheFileExtension, $safeFileExtensions, true)) {
             throw new PhpfastcacheInvalidConfigurationException(
-                "Extension \"$cacheFileExtension\" is not safe, currently allowed extension names: " . \implode(', ', $safeFileExtensions)
+                "Extension \"$cacheFileExtension\" is unsafe, currently allowed extension names: " . \implode(', ', $safeFileExtensions)
             );
         }
 
diff --git a/lib/Phpfastcache/Drivers/Arangodb/Driver.php b/lib/Phpfastcache/Drivers/Arangodb/Driver.php
@@ -30,7 +30,6 @@
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
 use Phpfastcache\Entities\DriverStatistic;
-use Phpfastcache\Event\Event;
 use Phpfastcache\Event\EventReferenceParameter;
 use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
 use Phpfastcache\Exceptions\PhpfastcacheDriverException;
diff --git a/lib/Phpfastcache/Drivers/Arangodb/Event.php b/lib/Phpfastcache/Drivers/Arangodb/Event.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace Phpfastcache\Drivers\Arangodb;
+
+class Event extends \Phpfastcache\Event\Event
+{
+    public const ARANGODB_CONNECTION = 'ArangodbConnection';
+    public const ARANGODB_COLLECTION_PARAMS = 'ArangodbCollectionParams';
+}
diff --git a/lib/Phpfastcache/Drivers/Dynamodb/Driver.php b/lib/Phpfastcache/Drivers/Dynamodb/Driver.php
@@ -25,7 +25,6 @@
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
 use Phpfastcache\Entities\DriverStatistic;
-use Phpfastcache\Event\Event;
 use Phpfastcache\Event\EventReferenceParameter;
 use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
 use Phpfastcache\Exceptions\PhpfastcacheDriverException;
diff --git a/lib/Phpfastcache/Drivers/Dynamodb/Event.php b/lib/Phpfastcache/Drivers/Dynamodb/Event.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Phpfastcache\Drivers\Dynamodb;
+
+class Event extends \Phpfastcache\Event\Event
+{
+    public const DYNAMODB_CREATE_TABLE = 'DynamodbCreateTable';
+}
diff --git a/lib/Phpfastcache/Drivers/Solr/Driver.php b/lib/Phpfastcache/Drivers/Solr/Driver.php
@@ -21,6 +21,7 @@
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Core\Pool\TaggableCacheItemPoolTrait;
 use Phpfastcache\Entities\DriverStatistic;
+use Phpfastcache\Event\EventReferenceParameter;
 use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
 use Phpfastcache\Exceptions\PhpfastcacheDriverConnectException;
 use Phpfastcache\Exceptions\PhpfastcacheDriverException;
@@ -79,7 +80,8 @@ public function driverCheck(): bool
     protected function driverConnect(): bool
     {
         $this->mappingSchema = $this->getConfig()->getMappingSchema();
-        $this->instance = new SolariumClient(new SolariumCurlAdapter(), $this->getConfig()->getEventDispatcher(), [
+
+        $endpoint = [
             'endpoint' => [
                 $this->getConfig()->getEndpointName() => [
                     'scheme' => $this->getConfig()->getScheme(),
@@ -89,7 +91,11 @@ protected function driverConnect(): bool
                     'core' => $this->getConfig()->getCoreName(),
                 ]
             ]
-        ]);
+        ];
+
+        $this->eventManager->dispatch(Event::SOLR_BUILD_ENDPOINT, $this, new EventReferenceParameter($endpoint));
+
+        $this->instance = new SolariumClient(new SolariumCurlAdapter(), $this->getConfig()->getEventDispatcher(), $endpoint);
 
         try {
             return $this->instance->ping($this->instance->createPing())->getStatus() === 0;
diff --git a/lib/Phpfastcache/Drivers/Solr/Event.php b/lib/Phpfastcache/Drivers/Solr/Event.php
@@ -0,0 +1,8 @@
+<?php
+
+namespace Phpfastcache\Drivers\Solr;
+
+class Event extends \Phpfastcache\Event\Event
+{
+    public const SOLR_BUILD_ENDPOINT = 'SolrBuildEndpoint';
+}
diff --git a/lib/Phpfastcache/Event/Event.php b/lib/Phpfastcache/Event/Event.php
@@ -16,8 +16,12 @@
 
 namespace Phpfastcache\Event;
 
-class Event
+use Phpfastcache\Helper\UninstanciableObjectTrait;
+
+class Event implements EventInterface
 {
+    use UninstanciableObjectTrait;
+
     public const CACHE_GET_ITEM = 'CacheGetItem';
     public const CACHE_DELETE_ITEM = 'CacheDeleteItem';
     public const CACHE_SAVE_ITEM = 'CacheSaveItem';
@@ -33,7 +37,9 @@ class Event
     public const CACHE_ITEM_SET = 'CacheItemSet';
     public const CACHE_ITEM_EXPIRE_AT = 'CacheItemExpireAt';
     public const CACHE_ITEM_EXPIRE_AFTER = 'CacheItemExpireAfter';
-    public const ARANGODB_CONNECTION = 'ArangodbConnection';
-    public const ARANGODB_COLLECTION_PARAMS = 'ArangodbCollectionParams';
-    public const DYNAMODB_CREATE_TABLE = 'DynamodbCreateTable';
+
+    public static function getEvents(): array
+    {
+        return (new \ReflectionClass(static::class))->getConstants();
+    }
 }
diff --git a/lib/Phpfastcache/Event/EventInterface.php b/lib/Phpfastcache/Event/EventInterface.php
@@ -0,0 +1,22 @@
+<?php
+
+/**
+ *
+ * This file is part of Phpfastcache.
+ *
+ * @license MIT License (MIT)
+ *
+ * For full copyright and license information, please see the docs/CREDITS.txt and LICENCE files.
+ *
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
+ */
+
+declare(strict_types=1);
+
+namespace Phpfastcache\Event;
+
+interface EventInterface
+{
+    public static function getEvents(): array;
+}
diff --git a/lib/Phpfastcache/Event/EventManagerInterface.php b/lib/Phpfastcache/Event/EventManagerInterface.php
@@ -45,6 +45,7 @@
  * @method Void onArangodbConnection(Callable $callable, ?string $callbackName = null)
  * @method Void onArangodbCollectionParams(Callable $callable, ?string $callbackName = null)
  * @method Void onDynamodbCreateTable(Callable $callable, ?string $callbackName = null)
+ * @method Void onSolrBuildEndpoint(Callable $callable, ?string $callbackName = null)
  */
 interface EventManagerInterface
 {
diff --git a/lib/Phpfastcache/EventManager.php b/lib/Phpfastcache/EventManager.php
@@ -19,9 +19,12 @@
 use Phpfastcache\Event\EventManagerInterface;
 use Phpfastcache\Exceptions\PhpfastcacheEventManagerException;
 use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
+use Phpfastcache\Helper\UninstanciableObjectTrait;
 
 class EventManager implements EventManagerInterface
 {
+    use UninstanciableObjectTrait;
+
     public const ON_EVERY_EVENT = '__every';
 
     protected static EventManagerInterface $instance;
@@ -30,14 +33,6 @@ class EventManager implements EventManagerInterface
         self::ON_EVERY_EVENT => []
     ];
 
-    /**
-     * EventManager constructor.
-     */
-    final protected function __construct()
-    {
-        // The constructor should not be instantiated externally
-    }
-
     /**
      * @return EventManagerInterface
      */
@@ -86,7 +81,7 @@ public function dispatch(string $eventName, ...$args): void
      */
     public function __call(string $name, array $arguments): void
     {
-        if (str_starts_with($name, 'on')) {
+        if (\str_starts_with($name, 'on')) {
             $name = \substr($name, 2);
             if (\is_callable($arguments[0])) {
                 if (isset($arguments[1]) && \is_string($arguments[0])) {
diff --git a/lib/Phpfastcache/Helper/UninstanciableObjectTrait.php b/lib/Phpfastcache/Helper/UninstanciableObjectTrait.php
@@ -0,0 +1,42 @@
+<?php
+
+/**
+ *
+ * This file is part of Phpfastcache.
+ *
+ * @license MIT License (MIT)
+ *
+ * For full copyright and license information, please see the docs/CREDITS.txt and LICENCE files.
+ *
+ * @author Georges.L (Geolim4)  <contact@geolim4.com>
+ * @author Contributors  https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors
+ */
+
+declare(strict_types=1);
+
+namespace Phpfastcache\Helper;
+
+use DateInterval;
+use DateTime;
+use Phpfastcache\CacheManager;
+use Phpfastcache\Config\ConfigurationOptionInterface;
+use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
+use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
+use Phpfastcache\Exceptions\PhpfastcacheDriverCheckException;
+use Phpfastcache\Exceptions\PhpfastcacheDriverException;
+use Phpfastcache\Exceptions\PhpfastcacheDriverNotFoundException;
+use Phpfastcache\Exceptions\PhpfastcacheInvalidArgumentException;
+use Phpfastcache\Exceptions\PhpfastcacheLogicException;
+use Phpfastcache\Exceptions\PhpfastcacheRootException;
+use Phpfastcache\Exceptions\PhpfastcacheSimpleCacheException;
+use Psr\Cache\InvalidArgumentException;
+use Psr\SimpleCache\CacheInterface;
+use Traversable;
+
+trait UninstanciableObjectTrait
+{
+    final protected function __construct()
+    {
+        // The target class is not meant to be instantiated
+    }
+}
diff --git a/tests/ReadWriteOperations.test.php b/tests/ReadWriteOperations.test.php
@@ -48,6 +48,7 @@
         $instances[ $dirIndex ][ $cacheInstanceName ] = CacheManager::getInstance('Files', new FilesConfig([
           'path' => $dir . str_pad($i, 3, '0', STR_PAD_LEFT),
           'secureFileManipulation' => true,
+          'cacheFileExtension' => 'pfc',
           'securityKey' => '_cache',
         ]));
 
diff --git a/tests/Solr.test.php b/tests/Solr.test.php
@@ -13,6 +13,9 @@
  */
 
 use Phpfastcache\CacheManager;
+use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
+use Phpfastcache\Event\EventReferenceParameter;
+use Phpfastcache\EventManager;
 use Phpfastcache\Tests\Helper\TestHelper;
 use Phpfastcache\Drivers\Solr\Config as SolrConfig;
 
@@ -45,7 +48,21 @@
  */
 // $solrConfig->setEventDispatcher($yourEventDispatcher);
 
+/**
+ * Test of custom events
+ */
+$onSolrBuildEndpointCalled = false;
+EventManager::getInstance()->onSolrBuildEndpoint(static function () use (&$onSolrBuildEndpointCalled, $testHelper){
+    $testHelper->assertPass('Event "onSolrBuildEndpoint" has been called.');
+    $onSolrBuildEndpointCalled = true;
+});
+
 $cacheInstance = CacheManager::getInstance('Solr', $solrConfig);
+
+if(!$onSolrBuildEndpointCalled) {
+    $testHelper->assertFail('Event "onSolrBuildEndpoint" has NOT been called.');
+}
+
 $testHelper->runCRUDTests($cacheInstance);
 
 $testHelper->terminateTest();

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`## 4.1.0`
	`2`	+- Created `\Phpfastcache\Event\EventInterface` which will be used for `Phpfastcache\Event\Event` and any `Phpfastcache\Drivers\xxxxxxx\Event` classes
`2`	`3`	- Extended `CacheItemPoolInterface::save()` with `ExtendedCacheItemPoolInterface::save()` for re-typing
`3`	`4`	- Method `ExtendedCacheItemPoolInterface::getConfig()` now returns `ConfigurationOptionInterface` instead of `ConfigurationOption`
`4`	`5`	- Method `ExtendedCacheItemPoolInterface::getDefaultConfig()` now returns `ConfigurationOptionInterface` instead of `ConfigurationOption`
Original file line number	Diff line number	Diff line change
`@@ -90,12 +90,12 @@ public function setCacheFileExtension(string $cacheFileExtension): static`
`90`	`90`	`$this->enforceLockedProperty(__FUNCTION__);`
`91`	`91`	`$safeFileExtensions = \explode('\|', IOConfigurationOptionInterface::SAFE_FILE_EXTENSIONS);`
`92`	`92`
`93`		`- if (str_contains($cacheFileExtension, '.')) {`
	`93`	`+ if (\str_contains($cacheFileExtension, '.')) {`
`94`	`94`	`throw new PhpfastcacheInvalidConfigurationException('cacheFileExtension cannot contain a dot "."');`
`95`	`95`	`}`
`96`	`96`	`if (!\in_array($cacheFileExtension, $safeFileExtensions, true)) {`
`97`	`97`	`throw new PhpfastcacheInvalidConfigurationException(`
`98`		`- "Extension \"$cacheFileExtension\" is not safe, currently allowed extension names: " . \implode(', ', $safeFileExtensions)`
	`98`	`+ "Extension \"$cacheFileExtension\" is unsafe, currently allowed extension names: " . \implode(', ', $safeFileExtensions)`
`99`	`99`	`);`
`100`	`100`	`}`
`101`	`101`