Merge pull request #24 from Crell/v3

Crell · web-flow · commit aa5030cfa540 · 2021-02-03T17:26:27.000-06:00
Add return types
diff --git a/src/CacheItemInterface.php b/src/CacheItemInterface.php
@@ -32,7 +32,7 @@ interface CacheItemInterface
      * @return string
      *   The key string for this cache item.
      */
-    public function getKey();
+    public function getKey(): string;
 
     /**
      * Retrieves the value of the item from the cache associated with this object's key.
@@ -46,7 +46,7 @@ public function getKey();
      * @return mixed
      *   The value corresponding to this cache item's key, or null if not found.
      */
-    public function get();
+    public function get(): mixed;
 
     /**
      * Confirms if the cache item lookup resulted in a cache hit.
@@ -57,7 +57,7 @@ public function get();
      * @return bool
      *   True if the request resulted in a cache hit. False otherwise.
      */
-    public function isHit();
+    public function isHit(): bool;
 
     /**
      * Sets the value represented by this cache item.
@@ -72,7 +72,7 @@ public function isHit();
      * @return static
      *   The invoked object.
      */
-    public function set(mixed $value);
+    public function set(mixed $value): static;
 
     /**
      * Sets the expiration time for this cache item.
@@ -86,7 +86,7 @@ public function set(mixed $value);
      * @return static
      *   The called object.
      */
-    public function expiresAt(?\DateTimeInterface $expiration);
+    public function expiresAt(?\DateTimeInterface $expiration): static;
 
     /**
      * Sets the expiration time for this cache item.
@@ -101,5 +101,5 @@ public function expiresAt(?\DateTimeInterface $expiration);
      * @return static
      *   The called object.
      */
-    public function expiresAfter(int|\DateInterval|null $time);
+    public function expiresAfter(int|\DateInterval|null $time): static;
 }
diff --git a/src/CacheItemPoolInterface.php b/src/CacheItemPoolInterface.php
@@ -29,7 +29,7 @@ interface CacheItemPoolInterface
      * @return CacheItemInterface
      *   The corresponding Cache Item.
      */
-    public function getItem(string $key);
+    public function getItem(string $key): CacheItemInterface;
 
     /**
      * Returns a traversable set of cache items.
@@ -41,13 +41,13 @@ public function getItem(string $key);
      *   If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException
      *   MUST be thrown.
      *
-     * @return array|\Traversable
-     *   A traversable collection of Cache Items keyed by the cache keys of
+     * @return iterable
+     *   An iterable collection of Cache Items keyed by the cache keys of
      *   each item. A Cache item will be returned for each key, even if that
      *   key is not found. However, if no keys are specified then an empty
      *   traversable MUST be returned instead.
      */
-    public function getItems(array $keys = []);
+    public function getItems(array $keys = []): iterable;
 
     /**
      * Confirms if the cache contains specified cache item.
@@ -66,15 +66,15 @@ public function getItems(array $keys = []);
      * @return bool
      *   True if item exists in the cache, false otherwise.
      */
-    public function hasItem(string $key);
+    public function hasItem(string $key): bool;
 
     /**
      * Deletes all items in the pool.
      *
      * @return bool
      *   True if the pool was successfully cleared. False if there was an error.
      */
-    public function clear();
+    public function clear(): bool;
 
     /**
      * Removes the item from the pool.
@@ -89,7 +89,7 @@ public function clear();
      * @return bool
      *   True if the item was successfully removed. False if there was an error.
      */
-    public function deleteItem(string $key);
+    public function deleteItem(string $key): bool;
 
     /**
      * Removes multiple items from the pool.
@@ -104,7 +104,7 @@ public function deleteItem(string $key);
      * @return bool
      *   True if the items were successfully removed. False if there was an error.
      */
-    public function deleteItems(array $keys);
+    public function deleteItems(array $keys): bool;
 
     /**
      * Persists a cache item immediately.
@@ -115,7 +115,7 @@ public function deleteItems(array $keys);
      * @return bool
      *   True if the item was successfully persisted. False if there was an error.
      */
-    public function save(CacheItemInterface $item);
+    public function save(CacheItemInterface $item): bool;
 
     /**
      * Sets a cache item to be persisted later.
@@ -126,13 +126,13 @@ public function save(CacheItemInterface $item);
      * @return bool
      *   False if the item could not be queued or if a commit was attempted and failed. True otherwise.
      */
-    public function saveDeferred(CacheItemInterface $item);
+    public function saveDeferred(CacheItemInterface $item): bool;
 
     /**
      * Persists any deferred cache items.
      *
      * @return bool
      *   True if all not-yet-saved items were successfully saved or there were none. False otherwise.
      */
-    public function commit();
+    public function commit(): bool;
 }
