Merge pull request #332 from Geolim4/final

 Implemented #331

Author: Geolim4

.travis.yml

@@ -30,3 +30,4 @@ script:
   - php -f tests/NewCacheInstance.test.php
   - php -f tests/Psr6InterfaceImplements.test.php
   - php -f tests/AbstractProxy.test.php
+  - php -f tests/AttachingDetachingMethods.test.php

README.md

@@ -105,6 +105,10 @@ phpFastCache offers you a lot of useful APIs:
 - appendItemsByTags(array $tagNames, $data) // Append items by some tags
 - prependItemsByTag($tagName, $data) // Prepend items by a tag
 - prependItemsByTags(array $tagNames, $data) // Prepend items by some tags
+- detachItem($item) // Detach an item from the pool
+- detachAllItems($item) // Detach all items from the pool
+- attachItem($item) // (Re-)attach an item to the pool
+- isAttached($item) // Verify if an item is (still) attached
 
 Also support Multiple calls, Tagging, Setup Folder for caching. Look at our examples folders.
 

src/phpFastCache/Api.php

@@ -20,7 +20,7 @@
  */
 class Api
 {
-    protected static $version = '1.1.1';
+    protected static $version = '1.1.2';
 
     /**
      * This method will returns the current
@@ -45,6 +45,13 @@ public static function getVersion()
     public static function getChangelog()
     {
         return <<<CHANGELOG
+- 1.1.2
+-- Implemented [de|a]ttaching methods to improve memory management
+   ExtendedCacheItemPoolInterface::detachItem()
+   ExtendedCacheItemPoolInterface::detachAllItems()
+   ExtendedCacheItemPoolInterface::attachItem()
+   ExtendedCacheItemPoolInterface::isAttached()
+
 - 1.1.1
 -- Implemented JsonSerializable interface to ExtendedCacheItemInterface
 

src/phpFastCache/Cache/ExtendedCacheItemPoolInterface.php

@@ -105,7 +105,7 @@ public function setItem(CacheItemInterface $item);
      *   True if the pool was successfully cleared. False if there was an error.
      */
     public function clean();
-    
+
     /**
      * @return driverStatistic
      */
@@ -325,4 +325,33 @@ public function prependItemsByTag($tagName, $data);
      *   True if the item was successfully prepended. False if there was an error.
      */
     public function prependItemsByTags(array $tagNames, $data);
+
+    /**
+     * @param \Psr\Cache\CacheItemInterface $item
+     * @return void
+     */
+    public function detachItem(CacheItemInterface $item);
+
+    /**
+     * @return void
+     */
+    public function detachAllItems();
+
+    /**
+     * @param \Psr\Cache\CacheItemInterface $item
+     * @return void
+     * @throws \LogicException
+     */
+    public function attachItem(CacheItemInterface $item);
+
+    /**
+     * Returns true if the item exists, is attached and the Spl Hash matches
+     * Returns false if the item exists, is attached and the Spl Hash mismatches
+     * Returns null if the item does not exists
+     *
+     * @param \Psr\Cache\CacheItemInterface $item
+     * @return bool|null
+     * @throws \LogicException
+     */
+    public function isAttached(CacheItemInterface $item);
 }

src/phpFastCache/Core/ExtendedCacheItemPoolTrait.php

@@ -71,7 +71,7 @@ public function getItemsByTag($tagName)
                  * Therefore we pass a filter callback
                  * to remove the expired Item(s) provided by
                  * the item keys passed through getItems()
-                 * 
+                 *
                  * #headache
                  */
                 return array_filter($this->getItems(array_unique(array_keys($items))), function(ExtendedCacheItemInterface $item){
@@ -296,6 +296,43 @@ public function prependItemsByTags(array $tagNames, $data)
     }
 
     /**
+     * @param \Psr\Cache\CacheItemInterface $item
+     * @return void
+     */
+    public function detachItem(CacheItemInterface $item)
+    {
+        if(isset($this->itemInstances[$item->getKey()])){
+            $this->deregisterItem($item);
+        }
+    }
+
+    /**
+     * @return void
+     */
+    public function detachAllItems()
+    {
+        foreach ($this->itemInstances as $item) {
+            $this->detachItem($item);
+        }
+    }
+
+    /**
+     * @param \Psr\Cache\CacheItemInterface $item
+     * @return void
+     * @throws \LogicException
+     */
+    public function attachItem(CacheItemInterface $item)
+    {
+        if(isset($this->itemInstances[$item->getKey()]) && spl_object_hash($item) !== spl_object_hash($this->itemInstances[ $item->getKey() ])){
+            throw new \LogicException('The item already exists and cannot be overwritten because the Spl object hash mismatches ! You probably tried to re-attach a detached item which has been already retrieved from cache.');
+        }else{
+            $this->itemInstances[$item->getKey()] = $item;
+        }
+    }
+
+
+    /**
+     * @internal This method de-register an item from $this->itemInstances
      * @param CacheItemInterface|string $item
      * @throws \InvalidArgumentException
      */
@@ -313,4 +350,21 @@ protected function deregisterItem($item)
             gc_collect_cycles();
         }
     }
+
+    /**
+     * Returns true if the item exists, is attached and the Spl Hash matches
+     * Returns false if the item exists, is attached and the Spl Hash mismatches
+     * Returns null if the item does not exists
+     *
+     * @param \Psr\Cache\CacheItemInterface $item
+     * @return bool|null
+     * @throws \LogicException
+     */
+    public function isAttached(CacheItemInterface $item)
+    {
+        if(isset($this->itemInstances[$item->getKey()])){
+            return spl_object_hash($item) === spl_object_hash($this->itemInstances[ $item->getKey() ]);
+        }
+        return null;
+    }
 }

src/phpFastCache/Core/StandardPsr6StructureTrait.php

@@ -182,6 +182,7 @@ public function deleteItems(array $keys)
      * @param \Psr\Cache\CacheItemInterface $item
      * @return mixed
      * @throws \InvalidArgumentException
+     * @throws \RuntimeException
      */
     public function save(CacheItemInterface $item)
     {
@@ -190,7 +191,11 @@ public function save(CacheItemInterface $item)
          */
         if (!array_key_exists($item->getKey(), $this->itemInstances)) {
             $this->itemInstances[ $item->getKey() ] = $item;
+        } else if(spl_object_hash($item) !== spl_object_hash($this->itemInstances[ $item->getKey() ])){
+            throw new \RuntimeException('Spl object hash mismatches ! You probably tried to save a detached item which has been already retrieved from cache.');
         }
+
+
         if ($this->driverWrite($item) && $this->driverWriteTags($item)) {
             $item->setHit(true);
             CacheManager::$WriteHits++;
@@ -204,11 +209,14 @@ public function save(CacheItemInterface $item)
     /**
      * @param \Psr\Cache\CacheItemInterface $item
      * @return \Psr\Cache\CacheItemInterface
+     * @throws \RuntimeException
      */
     public function saveDeferred(CacheItemInterface $item)
     {
         if (!array_key_exists($item->getKey(), $this->itemInstances)) {
             $this->itemInstances[ $item->getKey() ] = $item;
+        }else if(spl_object_hash($item) !== spl_object_hash($this->itemInstances[ $item->getKey() ])){
+            throw new \RuntimeException('Spl object hash mismatches ! You probably tried to save a detached item which has been already retrieved from cache.');
         }
 
         return $this->deferredList[ $item->getKey() ] = $item;

tests/AttachingDetachingMethods.test.php

@@ -0,0 +1,57 @@
+<?php
+
+/**
+ * @author Khoa Bui (khoaofgod)  <[email protected]> http://www.phpfastcache.com
+ * @author Georges.L (Geolim4)  <[email protected]>
+ */
+
+use phpFastCache\CacheManager;
+use phpFastCache\Core\Pool\ExtendedCacheItemPoolInterface;
+use Psr\Cache\CacheItemPoolInterface;
+
+
+chdir(__DIR__);
+require_once __DIR__ . '/../vendor/autoload.php';
+
+$status = 0;
+echo "Testing [a|de]ttaching methods\n";
+
+/**
+ * Testing memcached as it is declared in .travis.yml
+ */
+$driverInstance = CacheManager::getInstance('Files');
+
+if (!is_object($driverInstance)) {
+    echo '[FAIL] CacheManager::getInstance() returned an invalid variable type:' . gettype($driverInstance) . "\n";
+    $status = 1;
+}else if(!($driverInstance instanceof CacheItemPoolInterface)){
+    echo '[FAIL] CacheManager::getInstance() returned an invalid class:' . get_class($driverInstance) . "\n";
+    $status = 1;
+}else{
+    $key = 'test_attaching_detaching';
+
+    $itemDetached = $driverInstance->getItem($key);
+    $driverInstance->detachItem($itemDetached);
+    $itemAttached = $driverInstance->getItem($key);
+
+    if(!$driverInstance->isAttached($itemDetached))
+    {
+        echo '[PASS] ExtendedCacheItemPoolInterface::isAttached() identified $itemDetached as being detached.' . "\n";
+    }
+    else
+    {
+        echo '[FAIL] ExtendedCacheItemPoolInterface::isAttached() failed to identify $itemDetached as to be detached.' . "\n";
+        $status = 1;
+    }
+
+    try{
+        $driverInstance->attachItem($itemDetached);
+        echo '[FAIL] ExtendedCacheItemPoolInterface::attachItem() attached $itemDetached without trowing an error.' . "\n";
+        $status = 1;
+    }catch(\LogicException $e){
+        echo '[PASS] ExtendedCacheItemPoolInterface::attachItem() failed to attach $itemDetached by trowing a LogicException exception.' . "\n";
+    }
+
+}
+
+exit($status);