Skip to content

CHANGELOG.md

Latest commit

 

History

History
196 lines (185 loc) · 12 KB

CHANGELOG.md

File metadata and controls

196 lines (185 loc) · 12 KB

9.2.4

30 april 2025
  • Core
    • PHP 8.4 compatibility (@khoaofgod, @CHANCENY)
  • Drivers
    • Redis: Refactor Redis driver to read all keys efficiently (@mapcentia)

9.2.3

11 january 2024
  • Drivers
    • Added support of Ravendb as an extension with its own sub-repository.
    • Deprecated \Phpfastcache\Entities\DriverStatistic::getData(). Will be removed as of v10.
    • Deprecated \Phpfastcache\Entities\DriverStatistic::setData(). Will be removed as of v10.
    • Added \Phpfastcache\Entities\DriverStatistic::getCount(): int|null. If applicable will return the count of cache objects stored in driver database/collection. Null otherwise.
    • Added \Phpfastcache\Entities\DriverStatistic::setCount()

9.2.2

11 january 2024
  • Core
    • Added optional prefix to \Phpfastcache\Core\Pool\CacheItemPoolTrait::getKeys()

9.2.1

07 january 2024
  • Misc
    • Added additional check in cache manager for extensions

9.2.0

07 january 2024
  • API
  • Extensions (💡 New in 9.2)
    • Created an extension mechanism to allow some drivers to be loaded independently, see README.md
    • Added support of Couchbasev4 as an extension with its own sub-repository.
    • IMPORTANT: AS OF v9.2 the following drivers has been MOVED to their own sub-repositories as a standalone extension: Arangodb, Couchdb, Dynamodb, Firestore, Mongodb, Solr. However Couchbasev3 will stay in the core for compatibility reasons but will be deprecated.
    • IMPORTANT: AS OF v10 extensions will have their namespaces permanently moved from Phpfastcache\Drivers\EXT_NAME\{Config, Driver, Event, Item} to Phpfastcache\Extensions\Drivers\EXT_NAME\{Config, Driver, Event, Item}. For now an alias is ensuring compatibility.
  • Events
    • EventManager is now scoped to its own poll if retrieved through ExtendedCacheItemPoolTrait::->getEventManager(). Global EventManager EventManager::getInstance() remains unchanged, see EVENTS.md.
    • EventManagerInterface::on() now also accepts a single string $events.
    • Alias \Phpfastcache\PhpfastcacheEventManager of \Phpfastcache\EventManager has been added to improve your code import readability.
    • Deprecated \Phpfastcache\Event\EventManagerDispatcherInterface::hasEventManager to be removed for v10.
  • Drivers
    • Implemented #906 // Added RedisCluster driver support
    • Driver Memstatic has changed its name to Memory for more consistency.
    • Driver Wincache is now deprecated and will be removed as of v10 due to the lack of updates to PHP 8 as officially stated by PHP.
  • Pool
    • Added ExtendedCacheItemPoolTrait::getAllItems to allow you to retrieve all items in the cache. This method have some limitations, (see more in the Wiki).
  • Core
    • Configuration methodsConfigurationOption::isPreventCacheSlams(), ConfigurationOption::setPreventCacheSlams(), ConfigurationOption::getCacheSlamsTimeout(), ConfigurationOption::setCacheSlamsTimeout() are deprecated. (See changes).
    • Fixed #907 // Internal "driver decode()" method will now throw an if the string data looks corrupted.
    • Internal: Implemented multiple keys fetch (if supported by the backend) to improve the performances behind all getItems() calls. Currently only supported in some backends, but it may evolve in the future.
    • Internal: Implemented multiple keys delete (if supported by the backend) to improve the performances behind all deleteItems() calls. Currently only supported in some backends, but it may evolve in the future.
    • \Phpfastcache\CacheContract::get() now accepts a \Stringable $cacheKey argument.
  • Tags
    • Added \Phpfastcache\Core\Item\TaggableCacheItemInterface::isTagged(): bool
  • Misc
    • Fixed multiple code typo & updated README.md

9.1.3

12 february 2023
  • Core
    • Fixed #893 // getItemsByTag() - empty after one item has expired
  • Misc
    • Fixed multiple code typo & updated README.md

9.1.2

09 june 2022
  • API
  • Core
    • Rewrote some core code to improve code maintainability & readability following Scrutinizer and Phpstan recommendations
    • Fixed an issue with tags not properly reinitialized when a backend driver returns an expired cache item
  • Drivers
    • Fixed #866 // Deprecated Method Cassandra\ExecutionOptions starting of Cassandra 1.3
  • Misc
    • Increased PHPSTAN level to 6
    • Fixed multiple fails of Travis CI
    • Migrated Github issue templates from Markdown to YAML configurations

9.1.1

15 april 2022
  • Core
    • Fixed #860 // Cache item throw an error on reading with DateTimeImmutable date objects
    • Fixed an issue with tags not properly reinitialized when a backend driver returns an expired cache item
  • Drivers
    • Fixed #862 // Multiple driver errors caused by invalid return type of driverRead() (reported by @ShockedPlot7560 and @aemla)

9.1.0

04 april 2022
  • API
  • 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
    • Full PSR-12 compliance is now enforced by PHPCS
    • Multiple typo fixes (@mbiebl)
    • Updated composer suggestions and CI builder dependencies

9.0.2

04 march 2022
  • Core
    • Updated CacheContract::__invoke() signature
    • Added new option to allow EventManager override + improved EventManager tests (EventManager::setInstance())
  • Drivers
    • Fixed #853 // Configuration validation issue with Memcached socket (path)
  • Misc
    • Fixed typo and some types hint

9.0.1

14 november 2021
  • Core
    • Added \Phpfastcache\Event\Event class for centralizing event name with reusable constants.
  • Item
    • \Psr\Cache\CacheItemInterface::set will also no longer accepts resource object anymore as method unique parameter
  • Misc

9.0.0

31 october 2021
  • Migration guide
  • PSR-6
    • Upgraded psr/cache dependency to ^2.0||^3.0 (for PHP-8 types)
    • \Psr\Cache\CacheItemInterface::get() slightly changed to fully comply with missing PSR-6 specification: If the cache item is NOT hit, this method will return NULL.
  • PSR-16
    • Upgraded psr/simple-cache dependency to ^2.0||^3.0 (for PHP-8 types)
  • API
    • Upgraded Phpfastcache API to 4.0.0 (see changes)
    • Renamed Api::getPhpFastCacheVersion() to Api::getPhpfastcacheVersion()
    • Renamed Api::getPhpFastCacheChangelog() to Api::getPhpfastcacheChangelog()
    • Renamed Api::getPhpFastCacheGitHeadHash() to Api::getPhpfastcacheGitHeadHash()
  • Cluster
    • Renamed \Phpfastcache\Cluster\AggregatorInterface::aggregateNewDriver() to \Phpfastcache\Cluster\AggregatorInterface::aggregateDriverByName()
  • Exceptions
    • Added PhpfastcacheEventManagerException for EventManager-related exceptions
  • Global
    • Removed magics methods from CacheManager CacheManager::DriverName(), use CacheManager::getInstance('DriverName') instead
    • \Phpfastcache\Proxy\PhpfastcacheAbstractProxy now implements \Phpfastcache\Proxy\PhpfastcacheAbstractProxyInterface
    • 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)
    • Reworked traits inter-dependencies for better logic and less polymorphic calls in pool/item traits
    • Upgrading library to use benefits of PHP 8 new features (see below)
    • Typed every class properties of the library
    • Migrated many Closure to arrow functions
    • Updated parameters & return type hint to use benefit of covariance and contravariance
    • Removed embedded Autoload, Phpfastcache is now only Composer-compatible.
    • Removed embedded dependencies (psr/cache, psr/simple-cache)
  • Helpers
    • 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.
    • 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
    • Removed Autoload test since its support has been removed and now only managed by Composer
    • Increased tests reliability and code coverage for better catching any eventual regression
  • Item
    • \Psr\Cache\CacheItemInterface::set will not accept \Closure object anymore as method unique parameter
  • Drivers
    • Added Arangodb driver support
    • Added Dynamodb (AWS) driver support
    • Added Firestore (GCP) driver support
    • Removed Cookie driver because of its potential dangerosity
    • Removed Couchbase (SDK 2 support dropped) driver which is now replaced by Couchbasev3 (SDK 3)
    • Removed Devtrue and Devfalse drivers
    • Added Devrandom with configurable factor chance and data length
    • Renamed classes \Phpfastcache\Cluster\Drivers\[STATEGY]\[CLUSTER_NAME]Cluster to \Phpfastcache\Cluster\Drivers\[STATEGY]\Driver for better driver naming across the project
  • Events
    • Added \Phpfastcache\Event\EventReferenceParameter class and more events such as driver-specific events, see EVENTS.md file for more information
    • Event callbacks will now receive the eventName as an extra last callback parameter (except for onEveryEvents callbacks)
    • Added EventManagerInterface::on(array $eventNames, $callback) method, to subscribe to multiple events in once with the same callback
    • Added method named unbindAllEventCallbacks(): bool to EventManagerInterface to allow you to unbind/clear all event from an event instance
    • Updated argument type #2 ($items) of onCacheSaveMultipleItems() event from ExtendedCacheItemInterface[] to EventReferenceParameter($items)
    • Updated argument type #2 ($items) of onCacheCommitItem() event from ExtendedCacheItemInterface[] to EventReferenceParameter($items)
    • Updated argument type #2 ($value) of onCacheItemSet() event from mixed to EventReferenceParameter(mixed $value)
  • Misc
    • Increased minimum PHP compatibility in composer to ^8.0
    • Updated copyright headers on every file to include the many project contributors
    • Globally renamed every occurrence of PhpFastCache to Phpcastcache