- Removed the old magic methods from the Cache manager

- Added LockableConfiguration interface

Author: Geolim4

.travis.yml

@@ -47,7 +47,7 @@ install:
   - ./bin/ci/scripts/install_dependencies.sh
 
 script:
-  - ./vendor/bin/phpcs lib/  --report=summary
+  - ./vendor/bin/phpcs lib/ --report=summary
   - ./vendor/bin/phpmd lib/ ansi phpmd.xml
   - ./vendor/bin/phpstan analyse lib/ -l 2 -c phpstan.neon 2>&1
   - php -f ./bin/ci/run_tests.php

CHANGELOG.md

@@ -1,12 +1,14 @@
 ## 9.0.0
-##### 30 august 2021
-- __Estimated release date__: _End of 2021 (december)_
+##### 1 november 2021
+- __Migration guide__
+  - Read the [migration guide](./docs/migration/MigratingFromV8ToV9.md) to upgrade from V8 to V9
 - __API__
   - Upgraded Phpfastcache API `4.0.0` ([see changes](CHANGELOG_API.md))
   - Renamed `Api::getPhpFastCacheVersion()` to `Api::getPhpfastcacheVersion()`
   - Renamed `Api::getPhpFastCacheChangelog()` to `Api::getPhpfastcacheChangelog()`
   - Renamed `Api::getPhpFastCacheGitHeadHash()` to `Api::getPhpfastcacheGitHeadHash()`
 - __Global__
+  - Removed magics methods from CacheManager `CacheManager::DriverName()`, use `CacheManager::getInstance('DriverName')` instead
   - Slightly increased performances on some critical points of the library
   - Removed "BadPracticeOMeter" notice in CacheManager
   - Removed many code duplicate (like in `\Phpfastcache\Driver\[DRIVER_NAME]\Item` classes)
@@ -22,10 +24,11 @@
   - Deprecated `\Phpfastcache\Helper\CacheConditionalHelper`, use `\Phpfastcache\CacheContract` instead
   - The `\Phpfastcache\CacheContract` class is now also callable directly without calling `get()` method
 - __Config/Options__
+  - Configuration object will now be locked once the cache pool instance is running. 
   - Updated `ConfigurationOption` which is no longer an `ArrayObject` class, therefore array-syntax is no longer available.
-  - Renamed configuration entry `htaccess` to `autoHtaccessCreationEnabled` for files-based drivers.
-  - Renamed `IOConfigurationOptionTrait::getHtaccess()` to `IOConfigurationOptionTrait::isAutoHtaccessCreationEnabled()`
-  - Renamed `IOConfigurationOptionTrait::setHtaccess()` to `IOConfigurationOptionTrait::setAutoHtaccessCreationEnabled()`
+  - Removed configuration entry `htaccess` for files-based drivers.
+  - Removed `IOConfigurationOptionTrait::getHtaccess()`
+  - Removed `IOConfigurationOptionTrait::setHtaccess()`
 - __Tests__
   - Added PHPMD, PHPCS and PHPSTAN coverages to increase quality of the project
   - Updated tests to work with new core/drivers changes

composer.json

@@ -18,12 +18,6 @@
                 "homepage": "https://github.com/PHPSocialNetwork/phpfastcache/graphs/contributors"
             }
     ],
-    "funding": [
-        {
-            "type": "patreon",
-            "url": "https://www.patreon.com/geolim4"
-        }
-    ],
     "require": {
         "php": "^8.0",
         "psr/cache": "^3.0",
@@ -66,5 +60,16 @@
             "Phpfastcache\\": "lib/Phpfastcache/",
             "Phpfastcache\\Tests\\": "tests/lib/"
         }
-    }
+    },
+    "support": {
+        "issues": "https://github.com/PHPSocialNetwork/phpfastcache/issues",
+        "wiki": "https://github.com/PHPSocialNetwork/phpfastcache/wiki",
+        "source": "https://github.com/PHPSocialNetwork/phpfastcache"
+    },
+    "funding": [
+        {
+            "type": "patreon",
+            "url": "https://www.patreon.com/geolim4"
+        }
+    ]
 }

composer.lock

@@ -7,6 +7,10 @@ Once released, the php version 8.1 will be unit-tested
 ### Embedded autoload has been removed (and therefore, embedded dependencies)
 Use [Composer](https://getcomposer.org/doc/03-cli.md#require) to include Phpfastcache in your project
 
+### Removed magics methods from CacheManager `CacheManager::DriverName()`
+Use `CacheManager::getInstance('DriverName')` instead.\
+This decision was made to make the cache manager more consistent by removing the "old legacy code". 
+
 ### Updated `ConfigurationOption` which is no longer an `ArrayObject` class
 You can no longer use the following array-compatible syntax: `$config['yourKey'] = 'value'`\
 Use the object-notation syntax instead: `$config->setYourKey('value')`
@@ -38,10 +42,13 @@ See [EVENTS.md](./../EVENTS.md) file for more information
 They have not been replaced.
 However, the `Devrandom` driver with configurable factor chance and data length has been added
 
-### Renamed configuration entry `htaccess` to `autoHtaccessCreationEnabled` for files-based drivers.
-- The variable has been renamed to better comply with its supposed role and avoid phpmd exception.
-- Renamed `IOConfigurationOptionTrait::getHtaccess()` to `IOConfigurationOptionTrait::isAutoHtaccessCreationEnabled()`
-- Renamed `IOConfigurationOptionTrait::setHtaccess()` to `IOConfigurationOptionTrait::setAutoHtaccessCreationEnabled()`
+### Removed configuration entry `htaccess` for files-based drivers.
+- We consider that it's no longer the task of Phpfastcache to handle server configuration
+- Removed `IOConfigurationOptionTrait::getHtaccess()`
+- Removed `IOConfigurationOptionTrait::setHtaccess()`
+
+### Configuration object will now be locked once the cache pool instance is running
+If you try to set a configuration value after the cache pool instance is being built, an exception will be thrown.
 
 ### Removed `Cookie` driver because of its potential dangerosity
 However, you can always implement it by yourself if you want to by putting it back from previous versions using `\Phpfastcache\CacheManager::addCustomDriver()` method

docs/migration/MigratingFromV8ToV9.md

@@ -27,38 +27,13 @@
 use Phpfastcache\Exceptions\PhpfastcacheUnsupportedOperationException;
 use Phpfastcache\Util\ClassNamespaceResolverTrait;
 
-/**
- * Class CacheManager
- * @package phpFastCache
- *
- * @method static ExtendedCacheItemPoolInterface Apcu() Apcu($config = []) Return a driver "Apcu" instance
- * @method static ExtendedCacheItemPoolInterface Cassandra() Cassandra($config = []) Return a driver "Cassandra" instance
- * @method static ExtendedCacheItemPoolInterface Cookie() Cookie($config = []) Return a driver "Cookie" instance
- * @method static ExtendedCacheItemPoolInterface Couchbase() Couchbase($config = []) Return a driver "Couchbase" instance
- * @method static ExtendedCacheItemPoolInterface Couchdb() Couchdb($config = []) Return a driver "Couchdb" instance
- * @method static ExtendedCacheItemPoolInterface Devnull() Devnull($config = []) Return a driver "Devnull" instance
- * @method static ExtendedCacheItemPoolInterface Files() Files($config = []) Return a driver "files" instance
- * @method static ExtendedCacheItemPoolInterface Leveldb() Leveldb($config = []) Return a driver "Leveldb" instance
- * @method static ExtendedCacheItemPoolInterface Memcache() Memcache($config = []) Return a driver "Memcache" instance
- * @method static ExtendedCacheItemPoolInterface Memcached() Memcached($config = []) Return a driver "Memcached" instance
- * @method static ExtendedCacheItemPoolInterface Memstatic() Memstatic($config = []) Return a driver "Memstatic" instance
- * @method static ExtendedCacheItemPoolInterface Mongodb() Mongodb($config = []) Return a driver "Mongodb" instance
- * @method static ExtendedCacheItemPoolInterface Predis() Predis($config = []) Return a driver "Predis" instance
- * @method static ExtendedCacheItemPoolInterface Redis() Redis($config = []) Return a driver "Pedis" instance
- * @method static ExtendedCacheItemPoolInterface Sqlite() Sqlite($config = []) Return a driver "Sqlite" instance
- * @method static ExtendedCacheItemPoolInterface Ssdb() Ssdb($config = []) Return a driver "Ssdb" instance
- * @method static ExtendedCacheItemPoolInterface Wincache() Wincache($config = []) Return a driver "Wincache" instance
- * @method static ExtendedCacheItemPoolInterface Zenddisk() Zenddisk($config = []) Return a driver "Zend disk cache" instance
- * @method static ExtendedCacheItemPoolInterface Zendshm() Zendshm($config = []) Return a driver "Zend memory cache" instance
- *
- */
 class CacheManager
 {
     public const CORE_DRIVER_NAMESPACE = 'Phpfastcache\Drivers\\';
 
     use ClassNamespaceResolverTrait;
 
-    protected static ConfigurationOption $config;
+    protected static ConfigurationOptionInterface $config;
 
     protected static string $namespacePath;
 
@@ -109,22 +84,6 @@ public static function getInstances(): array
         return self::$instances;
     }
 
-    /**
-     * @param string $name
-     * @param array $arguments
-     * @return ExtendedCacheItemPoolInterface
-     * @throws PhpfastcacheDriverCheckException
-     * @throws PhpfastcacheDriverException
-     * @throws PhpfastcacheDriverNotFoundException
-     * @throws PhpfastcacheInvalidArgumentException
-     */
-    public static function __callStatic(string $name, array $arguments): ExtendedCacheItemPoolInterface
-    {
-        $options = (\array_key_exists(0, $arguments) ? $arguments[0] : []);
-
-        return self::getInstance($name, $options);
-    }
-
     /**
      * @param string $driver
      * @param ConfigurationOptionInterface|null $config
@@ -133,13 +92,12 @@ public static function __callStatic(string $name, array $arguments): ExtendedCac
      * @throws PhpfastcacheDriverCheckException
      * @throws PhpfastcacheDriverException
      * @throws PhpfastcacheDriverNotFoundException
-     * @throws PhpfastcacheInvalidArgumentException
+     * @throws PhpfastcacheLogicException
      */
     public static function getInstance(string $driver, ?ConfigurationOptionInterface $config = null, ?string $instanceId = null): ExtendedCacheItemPoolInterface
     {
         $config = self::validateConfig($config);
         $driver = self::standardizeDriverName($driver);
-
         $instanceId = $instanceId ?: md5($driver . \serialize(\array_filter($config->toArray(), static fn ($val) => !\is_callable($val))));
 
         if (!isset(self::$instances[$instanceId])) {
@@ -161,18 +119,22 @@ public static function getInstance(string $driver, ?ConfigurationOptionInterface
     }
 
     /**
-     * @param ConfigurationOption|null $config
-     * @return ConfigurationOption
+     * @param ConfigurationOptionInterface|null $config
+     * @return ConfigurationOptionInterface
+     * @throws PhpfastcacheLogicException
      */
-    protected static function validateConfig(?ConfigurationOption $config): ConfigurationOption
+    protected static function validateConfig(?ConfigurationOptionInterface $config): ConfigurationOptionInterface
     {
+        if ($config instanceof ConfigurationOptionInterface && $config->isLocked()) {
+            throw new PhpfastcacheLogicException('You provided an already locked configuration, cannot continue.');
+        }
         return $config ?? self::getDefaultConfig();
     }
 
     /**
-     * @return ConfigurationOption
+     * @return ConfigurationOptionInterface
      */
-    public static function getDefaultConfig(): ConfigurationOption
+    public static function getDefaultConfig(): ConfigurationOptionInterface
     {
         return self::$config ?? self::$config = new ConfigurationOption();
     }
@@ -246,7 +208,8 @@ public static function clearInstances(): bool
         self::$instances = [];
 
         \gc_collect_cycles();
-        return !\count(self::$instances);
+
+        return true;
     }
 
     /**
@@ -274,9 +237,10 @@ static function (ExtendedCacheItemPoolInterface $cachePool) use ($cachePoolInsta
     }
 
     /**
-     * @param ConfigurationOption $config
+     * @param ConfigurationOptionInterface $config
+     * @throws PhpfastcacheInvalidArgumentException
      */
-    public static function setDefaultConfig(ConfigurationOption $config): void
+    public static function setDefaultConfig(ConfigurationOptionInterface $config): void
     {
         if (is_subclass_of($config, ConfigurationOption::class)) {
             throw new PhpfastcacheInvalidArgumentException('Default configuration cannot be a child class of ConfigurationOption::class');

lib/Phpfastcache/CacheManager.php

@@ -0,0 +1,65 @@
+<?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\Config;
+
+use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
+use Phpfastcache\Exceptions\PhpfastcacheLogicException;
+
+abstract class AbstractConfigurationOption implements LockableConfigurationInterface
+{
+    private bool $lockedObject = false;
+
+    private ExtendedCacheItemPoolInterface $locker;
+
+    public function lock(ExtendedCacheItemPoolInterface $poolInstance): static
+    {
+        $this->lockedObject = true;
+        $this->locker = $poolInstance;
+
+        return $this;
+    }
+
+    public function lockedBy(): ExtendedCacheItemPoolInterface
+    {
+        return $this->locker;
+    }
+
+    public function isLocked(): bool
+    {
+        return $this->lockedObject;
+    }
+
+    /**
+     * @throws PhpfastcacheLogicException
+     */
+    protected function enforceLockedProperty(string $method): void
+    {
+        if ($this->lockedObject === true) {
+            $dbt = \debug_backtrace(\DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+            $cause = $dbt[\array_key_last($dbt)] ?? null;
+            if ($cause) {
+                $moreInfo = \sprintf('Caused line %d in %s', $cause['line'], $cause['file']);
+            }
+            throw new PhpfastcacheLogicException(
+                \sprintf(
+                    'You can no longer change the configuration "%s" as the cache pool instance is now running. %s',
+                    \lcfirst(\substr($method, 3)),
+                    $moreInfo ?? ''
+                )
+            );
+        }
+    }
+}