Increased API up to 4.2.0 by updating \Phpfastcache\Cluster\AggregatablePoolInterface

Author: Geolim4

CHANGELOG_API.md

@@ -1,3 +1,7 @@
+## 4.2.0
+- Created method `\Phpfastcache\Cluster\AggregatablePoolInterface::isAggregatedBy(): ?ClusterPoolInterface` which will return the aggregator object for Cluster aggregators
+- Created method `\Phpfastcache\Cluster\AggregatablePoolInterface::setAggregatedBy(ClusterPoolInterface $clusterPool): static` which will allow to set the aggregator object
+
 ## 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

lib/Phpfastcache/Api.php

@@ -28,7 +28,7 @@ class Api
 {
     use UninstanciableObjectTrait;
 
-    protected static string $version = '4.1.0';
+    protected static string $version = '4.2.0';
 
     /**
      * This method will return the current

lib/Phpfastcache/Cluster/AggregatablePoolInterface.php

@@ -20,4 +20,7 @@
 
 interface AggregatablePoolInterface extends ExtendedCacheItemPoolInterface
 {
+    public function isAggregatedBy(): ?ClusterPoolInterface;
+
+    public function setAggregatedBy(ClusterPoolInterface $clusterPool): static;
 }

lib/Phpfastcache/Cluster/ClusterPoolAbstract.php

@@ -53,7 +53,7 @@ abstract class ClusterPoolAbstract implements ClusterPoolInterface
     ];
 
     /**
-     * @var ExtendedCacheItemPoolInterface[]
+     * @var AggregatablePoolInterface[]
      */
     protected array $clusterPools;
 
@@ -69,14 +69,22 @@ abstract class ClusterPoolAbstract implements ClusterPoolInterface
      * @throws PhpfastcacheDriverException
      * @throws PhpfastcacheIOException
      */
-    public function __construct(string $clusterName, EventManagerInterface $em, ExtendedCacheItemPoolInterface ...$driverPools)
+    public function __construct(string $clusterName, EventManagerInterface $em, AggregatablePoolInterface ...$driverPools)
     {
         if (count($driverPools) < 2) {
             throw new PhpfastcacheInvalidArgumentException('A cluster requires at least two pools to be working.');
         }
         $this->clusterPools = $driverPools;
         $this->__parentConstruct(new ConfigurationOption(), $clusterName, $em);
         $this->setEventManager(EventManager::getInstance());
+        $this->setClusterPoolsAggregator();
+    }
+
+    protected function setClusterPoolsAggregator(): void
+    {
+        foreach ($this->clusterPools as $clusterPool) {
+            $clusterPool->setAggregatedBy($this);
+        }
     }
 
     /**

lib/Phpfastcache/Cluster/ClusterPoolInterface.php

@@ -22,7 +22,7 @@
 interface ClusterPoolInterface extends ExtendedCacheItemPoolInterface
 {
     /**
-     * @return ExtendedCacheItemPoolInterface[]
+     * @return AggregatablePoolInterface[]
      */
     public function getClusterPools(): array;
 

lib/Phpfastcache/Cluster/Drivers/MasterSlaveReplication/Driver.php

@@ -16,6 +16,7 @@
 
 namespace Phpfastcache\Cluster\Drivers\MasterSlaveReplication;
 
+use Phpfastcache\Cluster\AggregatablePoolInterface;
 use Phpfastcache\Cluster\ClusterPoolAbstract;
 use Phpfastcache\Core\Item\ExtendedCacheItemInterface;
 use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
@@ -37,15 +38,15 @@ class Driver extends ClusterPoolAbstract
      * MasterSlaveReplicationCluster constructor.
      * @param string $clusterName
      * @param EventManagerInterface $em
-     * @param ExtendedCacheItemPoolInterface ...$driverPools
+     * @param AggregatablePoolInterface ...$driverPools
      * @throws PhpfastcacheDriverCheckException
      * @throws PhpfastcacheDriverConnectException
      * @throws PhpfastcacheInvalidArgumentException
      * @throws PhpfastcacheCoreException
      * @throws PhpfastcacheDriverException
      * @throws PhpfastcacheIOException
      */
-    public function __construct(string $clusterName, EventManagerInterface $em, ExtendedCacheItemPoolInterface ...$driverPools)
+    public function __construct(string $clusterName, EventManagerInterface $em, AggregatablePoolInterface ...$driverPools)
     {
         if (\count($driverPools) !== 2) {
             throw new PhpfastcacheInvalidArgumentException('A "master/slave" cluster requires exactly two pools to be working.');
@@ -91,17 +92,17 @@ protected function makeOperation(callable $operation)
     }
 
     /**
-     * @return ExtendedCacheItemPoolInterface
+     * @return AggregatablePoolInterface
      */
-    protected function getMasterPool(): ExtendedCacheItemPoolInterface
+    protected function getMasterPool(): AggregatablePoolInterface
     {
         return $this->clusterPools[0];
     }
 
     /**
-     * @return ExtendedCacheItemPoolInterface
+     * @return AggregatablePoolInterface
      */
-    protected function getSlavePool(): ExtendedCacheItemPoolInterface
+    protected function getSlavePool(): AggregatablePoolInterface
     {
         return $this->clusterPools[1];
     }

lib/Phpfastcache/Cluster/Drivers/RandomReplication/Driver.php

@@ -16,8 +16,8 @@
 
 namespace Phpfastcache\Cluster\Drivers\RandomReplication;
 
+use Phpfastcache\Cluster\AggregatablePoolInterface;
 use Phpfastcache\Cluster\Drivers\MasterSlaveReplication\Driver as MasterSlaveReplicationDriver;
-use Phpfastcache\Core\Pool\ExtendedCacheItemPoolInterface;
 use Phpfastcache\Event\Event;
 use Phpfastcache\Event\EventManagerInterface;
 use ReflectionException;
@@ -29,11 +29,12 @@ class Driver extends MasterSlaveReplicationDriver
      * RandomReplicationCluster constructor.
      * @param string $clusterName
      * @param EventManagerInterface $em
-     * @param ExtendedCacheItemPoolInterface ...$driverPools
+     * @param AggregatablePoolInterface ...$driverPools
      * @throws ReflectionException
      */
-    public function __construct(string $clusterName, EventManagerInterface $em, ExtendedCacheItemPoolInterface ...$driverPools)
+    public function __construct(string $clusterName, EventManagerInterface $em, AggregatablePoolInterface ...$driverPools)
     {
+        /** Straight call to ClusterPoolAbstract constructor  */
         (new ReflectionMethod(\get_parent_class(\get_parent_class($this)), __FUNCTION__))
             ->invoke($this, $clusterName, $em, ...$driverPools);
         $randomPool = $driverPools[\random_int(0, \count($driverPools) - 1)];

lib/Phpfastcache/Core/Pool/AggregatablePoolTrait.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace Phpfastcache\Core\Pool;
+
+use Phpfastcache\Cluster\ClusterPoolInterface;
+
+trait AggregatablePoolTrait
+{
+    protected ?ClusterPoolInterface $clusterPool = null;
+
+    public function isAggregatedBy(): ?ClusterPoolInterface
+    {
+        return $this->clusterPool;
+    }
+
+    public function setAggregatedBy(ClusterPoolInterface $clusterPool): static
+    {
+        $this->clusterPool = $clusterPool;
+
+        return $this;
+    }
+}

lib/Phpfastcache/Core/Pool/ExtendedCacheItemPoolTrait.php

@@ -28,6 +28,7 @@
 trait ExtendedCacheItemPoolTrait
 {
     use CacheItemPoolTrait;
+    use AggregatablePoolTrait;
 
     /**
      * @inheritDoc

tests/ClusterRandomReplication.test.php

@@ -35,4 +35,10 @@
 
 $testHelper->runCRUDTests($cluster);
 
+if($cluster->getClusterPools()[0]->isAggregatedBy() === $cluster){
+    $testHelper->assertPass('The cluster aggregator set is the same as the cluster container.');
+} else {
+    $testHelper->assertFail('The cluster aggregator set is NOT the same as the cluster container.');
+}
+
 $testHelper->terminateTest();