Expirable interface to mark items can expire (e.g. by TTL)

akandels · Jul 6, 2012 · 8645bf7 · 8645bf7
1 parent bf1076e
commit 8645bf7
Show file tree

Hide file tree

Showing 8 changed files with 104 additions and 22 deletions.
diff --git a/library/Zend/Cache/Storage/Adapter/AbstractAdapter.php b/library/Zend/Cache/Storage/Adapter/AbstractAdapter.php
@@ -105,7 +105,6 @@ public function __construct($options = null)
      * detach all registered plugins to free
      * event handles of event manager
      *
-     *
      * @return void
      */
     public function __destruct()

diff --git a/library/Zend/Cache/Storage/Adapter/Apc.php b/library/Zend/Cache/Storage/Adapter/Apc.php
@@ -102,7 +102,7 @@ public function setOptions($options)
      * Get options.
      *
      * @return ApcOptions
-     * @see setOptions()
+     * @see    setOptions()
      */
     public function getOptions()
     {
@@ -308,10 +308,6 @@ protected function internalHasItems(array & $normalizedKeys)
      * @param  string $normalizedKey
      * @return array|boolean Metadata on success, false on failure
      * @throws Exception\ExceptionInterface
-     *
-     * @triggers getMetadata.pre(PreEvent)
-     * @triggers getMetadata.post(PostEvent)
-     * @triggers getMetadata.exception(ExceptionEvent)
      */
     protected function internalGetMetadata(& $normalizedKey)
     {

diff --git a/library/Zend/Cache/Storage/Adapter/ApcIterator.php b/library/Zend/Cache/Storage/Adapter/ApcIterator.php
@@ -81,7 +81,7 @@ public function __construct(Apc $storage, BaseApcIterator $baseIterator, $prefix
     /**
      * Get storage instance
      *
-     * @return StorageInterface
+     * @return Apc
      */
     public function getStorage()
     {

diff --git a/library/Zend/Cache/Storage/Adapter/Filesystem.php b/library/Zend/Cache/Storage/Adapter/Filesystem.php
@@ -375,7 +375,7 @@ public function getIterator()
     /**
      * Optimize the storage
      *
-     * @return void
+     * @return boolean
      * @return Exception\RuntimeException
      */
     public function optimize()
@@ -421,8 +421,9 @@ public function getTotalSpace()
                     $events->detach($handle);
                 }
             };
-            $handle = $this->getEventManager()->attach($callback);
+            $handle = $events->attach($callback);
         }
+
         return $this->totalSpace;
     }
 

diff --git a/library/Zend/Cache/Storage/Adapter/Memory.php b/library/Zend/Cache/Storage/Adapter/Memory.php
@@ -722,7 +722,7 @@ protected function internalGetCapabilities()
                         'object'   => true,
                         'resource' => true,
                     ),
-                    'supportedMetadata' => array('mtime'),
+                    'supportedMetadata'  => array('mtime'),
                     'maxTtl'             => PHP_INT_MAX,
                     'staticTtl'          => false,
                     'ttlPrecision'       => 0.05,

diff --git a/library/Zend/Cache/Storage/Capabilities.php b/library/Zend/Cache/Storage/Capabilities.php
@@ -58,56 +58,101 @@ class Capabilities
 
     /**
      * Expire read
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|boolean
      */
     protected $_expiredRead;
 
     /**
-     * Max key length
+     * Max. key length
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|int
      */
     protected $_maxKeyLength;
 
     /**
-     * Max ttl
+     * Max. TTL (0 means infinite)
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|int
      */
     protected $_maxTtl;
 
     /**
      * Namespace is prefix
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|boolean
      */
     protected $_namespaceIsPrefix;
 
     /**
      * Namespace separator
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|string
      */
     protected $_namespaceSeparator;
 
     /**
      * Static ttl
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|boolean
      */
     protected $_staticTtl;
 
    /**
-    * Capability property
+    * Supported datatypes
     *
     * If it's NULL the capability isn't set and the getter
     * returns the base capability or the default value.
     *
-    * @var null|mixed
+    * @var null|array
     */
     protected $_supportedDatatypes;
 
     /**
      * Supported metdata
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|array
      */
     protected $_supportedMetadata;
 
     /**
-     * Ttl precision
+     * TTL precision
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|int
      */
     protected $_ttlPrecision;
 
     /**
      * Use request time
+     *
+    * If it's NULL the capability isn't set and the getter
+    * returns the base capability or the default value.
+     *
+     * @var null|boolean
      */
     protected $_useRequestTime;
 

diff --git a/library/Zend/Cache/Storage/ExpirableInterface.php b/library/Zend/Cache/Storage/ExpirableInterface.php
@@ -0,0 +1,24 @@
+<?php
+
+namespace Zend\Cache\Storage;
+
+interface ExpirableInterface
+{
+    /**
+     * Reset lifetime of an item
+     *
+     * @param  string $key
+     * @return boolean
+     * @throws \Zend\Cache\Exception\ExceptionInterface
+     */
+    public function touchItem($key);
+
+    /**
+     * Reset lifetime of multiple items.
+     *
+     * @param  array $keys
+     * @return array Array of not updated keys
+     * @throws \Zend\Cache\Exception\ExceptionInterface
+    */
+    public function touchItems(array $keys);
+}
diff --git a/tests/Zend/Cache/Storage/Adapter/CommonAdapterTest.php b/tests/Zend/Cache/Storage/Adapter/CommonAdapterTest.php
@@ -21,12 +21,15 @@
 
 namespace ZendTest\Cache\Storage\Adapter;
 
+use Zend\Http\Header\Expires;
+
 use Zend\Cache\Storage\IterableInterface,
     Zend\Cache\Storage\IteratorInterface,
     Zend\Cache\Storage\StorageInterface,
     Zend\Cache\Storage\ClearExpiredInterface,
     Zend\Cache\Storage\ClearByNamespaceInterface,
     Zend\Cache\Storage\ClearByPrefixInterface,
+    Zend\Cache\Storage\ExpirableInterface,
     Zend\Cache\Storage\FlushableInterface,
     Zend\Cache\Storage\OptimizableInterface,
     Zend\Cache\Storage\TagableInterface,
@@ -232,8 +235,11 @@ public function testHasItemReturnsFalseOnMissingItem()
 
     public function testHasItemReturnsFalseOnExpiredItem()
     {
-        $capabilities = $this->_storage->getCapabilities();
+        if (!$this->_storage instanceof ExpirableInterface) {
+            $this->markTestSkipped("Adapter doesn't support TTL expiration");
+        }
 
+        $capabilities = $this->_storage->getCapabilities();
         $ttl = $capabilities->getTtlPrecision();
         $this->_options->setTtl($ttl);
 
@@ -295,6 +301,10 @@ public function testGetItemSetsSuccessFlag()
 
     public function testGetItemReturnsNullOnExpiredItem()
     {
+        if (!$this->_storage instanceof ExpirableInterface) {
+            $this->markTestSkipped("Adapter doesn't support TTL expiration");
+        }
+
         $capabilities = $this->_storage->getCapabilities();
         if ($capabilities->getUseRequestTime()) {
             $this->markTestSkipped("Can't test get expired item if request time will be used");
@@ -405,6 +415,7 @@ public function testSetGetHasAndRemoveItem()
         $this->assertTrue($this->_storage->setItem('key', 'value'));
         $this->assertEquals('value', $this->_storage->getItem('key'));
         $this->assertTrue($this->_storage->hasItem('key'));
+
         $this->assertTrue($this->_storage->removeItem('key'));
         $this->assertFalse($this->_storage->hasItem('key'));
         $this->assertNull($this->_storage->getItem('key'));
@@ -532,8 +543,11 @@ public function testSetGetHasAndRemoveItemsWithNamespace()
 
     public function testSetAndGetExpiredItem()
     {
-        $capabilities = $this->_storage->getCapabilities();
+        if (!$this->_storage instanceof ExpirableInterface) {
+            $this->markTestSkipped("Adapter doesn't support TTL expiration");
+        }
 
+        $capabilities = $this->_storage->getCapabilities();
         $ttl = $capabilities->getTtlPrecision();
         $this->_options->setTtl($ttl);
 
@@ -559,8 +573,11 @@ public function testSetAndGetExpiredItem()
 
     public function testSetAndGetExpiredItems()
     {
-        $capabilities = $this->_storage->getCapabilities();
+        if (!$this->_storage instanceof ExpirableInterface) {
+            $this->markTestSkipped("Adapter doesn't support TTL expiration");
+        }
 
+        $capabilities = $this->_storage->getCapabilities();
         $ttl = $capabilities->getTtlPrecision();
         $this->_options->setTtl($ttl);
 
@@ -808,6 +825,10 @@ public function testDecrementItemsReturnsEmptyArrayIfNonWritable()
 
     public function testTouchItem()
     {
+        if (!$this->_storage instanceof ExpirableInterface) {
+            $this->markTestSkipped("Adapter doesn't support TTL expiration");
+        }
+
         $capabilities = $this->_storage->getCapabilities();
         $this->_options->setTtl(2 * $capabilities->getTtlPrecision());
 
@@ -988,10 +1009,6 @@ public function testTagable()
             $this->markTestSkipped("Storage doesn't implement TagableInterface");
         }
 
-        $capabilities = $this->_storage->getCapabilities();
-        $ttl = $capabilities->getTtlPrecision();
-        $this->_options->setTtl($ttl);
-
         $this->assertSame(array(), $this->_storage->setItems(array(
             'key1' => 'value1',
             'key2' => 'value2',