Cache: Rename CacheStoreInterface to CacheInterface

Author: lkrms

scripts/generate.php

@@ -8,7 +8,7 @@
 use Salient\Cli\CliOptionBuilder;
 use Salient\Console\ConsoleWriter;
 use Salient\Container\Container;
-use Salient\Contract\Cache\CacheStoreInterface;
+use Salient\Contract\Cache\CacheInterface;
 use Salient\Contract\Console\ConsoleWriterInterface;
 use Salient\Contract\Container\ContainerInterface;
 use Salient\Contract\Core\MessageLevel as Level;
@@ -71,7 +71,7 @@
 
 $facades = [
     App::class => [ContainerInterface::class, [Container::class], '--desc', 'A facade for the global service container', '--api'],
-    Cache::class => [CacheStoreInterface::class, [CacheStore::class], '--desc', 'A facade for the global cache store', '--api'],
+    Cache::class => [CacheInterface::class, [CacheStore::class], '--desc', 'A facade for the global cache store', '--api'],
     Config::class => [ConfigurationManager::class, '--api'],
     Console::class => [ConsoleWriterInterface::class, [ConsoleWriter::class], '--desc', 'A facade for the global console writer', '--api'],
     Err::class => [ErrorHandler::class, '--skip', 'handleShutdown,handleError,handleException'],

src/Toolkit/Cache/CacheStore.php

@@ -2,7 +2,7 @@
 
 namespace Salient\Cache;
 
-use Salient\Contract\Cache\CacheStoreInterface;
+use Salient\Contract\Cache\CacheInterface;
 use Salient\Core\AbstractStore;
 use DateInterval;
 use DateTimeImmutable;
@@ -16,7 +16,7 @@
  *
  * @api
  */
-final class CacheStore extends AbstractStore implements CacheStoreInterface
+final class CacheStore extends AbstractStore implements CacheInterface
 {
     private ?SQLite3Stmt $Stmt = null;
     private ?int $Now = null;
@@ -316,7 +316,7 @@ public function getItemKeys(): array
     /**
      * @inheritDoc
      */
-    public function asOfNow(?int $now = null): CacheStoreInterface
+    public function asOfNow(?int $now = null): CacheInterface
     {
         if ($this->Now !== null) {
             throw new LogicException(

src/Toolkit/Container/Application.php

@@ -4,7 +4,7 @@
 
 use Salient\Cache\CacheStore;
 use Salient\Console\Target\StreamTarget;
-use Salient\Contract\Cache\CacheStoreInterface;
+use Salient\Contract\Cache\CacheInterface;
 use Salient\Contract\Console\ConsoleMessageType as MessageType;
 use Salient\Contract\Container\ApplicationInterface;
 use Salient\Contract\Core\MessageLevel as Level;
@@ -500,7 +500,7 @@ final public function stopCache()
         return $this;
     }
 
-    private function checkCache(CacheStoreInterface $cache): bool
+    private function checkCache(CacheInterface $cache): bool
     {
         return $cache instanceof CacheStore
             && File::same($this->getCacheDb(false), $cache->getFilename());

src/Toolkit/Container/Container.php

@@ -13,7 +13,7 @@
 use Salient\Container\Exception\ArgumentsNotUsedException;
 use Salient\Container\Exception\InvalidServiceException;
 use Salient\Container\Exception\ServiceNotFoundException;
-use Salient\Contract\Cache\CacheStoreInterface;
+use Salient\Contract\Cache\CacheInterface;
 use Salient\Contract\Console\ConsoleWriterInterface;
 use Salient\Contract\Container\ContainerAwareInterface;
 use Salient\Contract\Container\ContainerInterface;
@@ -58,7 +58,7 @@ class Container implements ContainerInterface, FacadeAwareInterface
     ];
 
     private const DEFAULT_SERVICES = [
-        CacheStoreInterface::class => [CacheStore::class, ServiceLifetime::SINGLETON],
+        CacheInterface::class => [CacheStore::class, ServiceLifetime::SINGLETON],
         ConsoleWriterInterface::class => [ConsoleWriter::class, ServiceLifetime::SINGLETON],
         LoggerInterface::class => [ConsoleLogger::class, ServiceLifetime::INHERIT],
         SyncStoreInterface::class => [SyncStore::class, ServiceLifetime::SINGLETON],

src/Toolkit/Contract/Cache/CacheStoreInterface.php renamed to src/Toolkit/Contract/Cache/CacheInterface.php

@@ -2,15 +2,15 @@
 
 namespace Salient\Contract\Cache;
 
-use Psr\SimpleCache\CacheInterface;
+use Psr\SimpleCache\CacheInterface as PsrCacheInterface;
 use DateInterval;
 use DateTimeInterface;
 use LogicException;
 
 /**
  * @api
  */
-interface CacheStoreInterface extends CacheInterface
+interface CacheInterface extends PsrCacheInterface
 {
     /**
      * Store an item under a given key
@@ -154,7 +154,7 @@ public function getItemKeys(): array;
      * @throws LogicException if the store is a copy, or if another copy of the
      * store is open.
      */
-    public function asOfNow(?int $now = null): CacheStoreInterface;
+    public function asOfNow(?int $now = null): CacheInterface;
 
     /**
      * Close the store and any underlying resources

src/Toolkit/Contract/Curler/CurlerInterface.php

@@ -6,7 +6,7 @@
 use Psr\Http\Message\RequestInterface;
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\UriInterface as PsrUriInterface;
-use Salient\Contract\Cache\CacheStoreInterface;
+use Salient\Contract\Cache\CacheInterface;
 use Salient\Contract\Core\DateFormatterInterface;
 use Salient\Contract\Http\AccessTokenInterface;
 use Salient\Contract\Http\FormDataFlag;
@@ -475,7 +475,7 @@ public function withPager(?CurlerPagerInterface $pager, bool $alwaysPaginate = f
     /**
      * Get the endpoint's cache store
      */
-    public function getCacheStore(): ?CacheStoreInterface;
+    public function getCacheStore(): ?CacheInterface;
 
     /**
      * Get an instance with the given cache store
@@ -485,7 +485,7 @@ public function getCacheStore(): ?CacheStoreInterface;
      *
      * @return static
      */
-    public function withCacheStore(?CacheStoreInterface $store = null);
+    public function withCacheStore(?CacheInterface $store = null);
 
     /**
      * Check if the instance handles cookies

src/Toolkit/Core/Facade/Cache.php

@@ -7,7 +7,7 @@
 use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 use Psr\Http\Message\UriInterface as PsrUriInterface;
-use Salient\Contract\Cache\CacheStoreInterface;
+use Salient\Contract\Cache\CacheInterface;
 use Salient\Contract\Core\Arrayable;
 use Salient\Contract\Core\Buildable;
 use Salient\Contract\Core\DateFormatterInterface;
@@ -115,7 +115,7 @@ class Curler implements CurlerInterface, Buildable
     protected array $Middleware = [];
     protected ?CurlerPagerInterface $Pager;
     protected bool $AlwaysPaginate;
-    protected ?CacheStoreInterface $CacheStore;
+    protected ?CacheInterface $CacheStore;
     protected ?string $CookiesCacheKey;
     protected bool $CacheResponses;
     protected bool $CachePostResponses;
@@ -164,7 +164,7 @@ class Curler implements CurlerInterface, Buildable
      * @param array<array{CurlerMiddlewareInterface|HttpRequestHandlerInterface|Closure(RequestInterface $request, Closure(RequestInterface): HttpResponseInterface $next, CurlerInterface $curler): ResponseInterface,1?:string|null}> $middleware Middleware applied to the request handler stack
      * @param CurlerPagerInterface|null $pager Pagination handler
      * @param bool $alwaysPaginate Use the pager to process requests even if no pagination is required
-     * @param CacheStoreInterface|null $cacheStore Cache store used for cookie and response caching instead of the {@see Cache} facade's underlying store
+     * @param CacheInterface|null $cacheStore Cache store used for cookie and response caching instead of the {@see Cache} facade's underlying store
      * @param bool $handleCookies Enable cookie handling
      * @param string|null $cookiesCacheKey Key to cache cookies under (cookie handling is implicitly enabled if given)
      * @param bool $cacheResponses Cache responses to GET and HEAD requests (HTTP caching headers are ignored; USE RESPONSIBLY)
@@ -195,7 +195,7 @@ public function __construct(
         array $middleware = [],
         ?CurlerPagerInterface $pager = null,
         bool $alwaysPaginate = false,
-        ?CacheStoreInterface $cacheStore = null,
+        ?CacheInterface $cacheStore = null,
         bool $handleCookies = false,
         ?string $cookiesCacheKey = null,
         bool $cacheResponses = false,
@@ -658,7 +658,7 @@ public function getPager(): ?CurlerPagerInterface
     /**
      * @inheritDoc
      */
-    public function getCacheStore(): ?CacheStoreInterface
+    public function getCacheStore(): ?CacheInterface
     {
         return $this->CacheStore;
     }
@@ -946,7 +946,7 @@ public function withPager(
     /**
      * @inheritDoc
      */
-    public function withCacheStore(?CacheStoreInterface $store = null)
+    public function withCacheStore(?CacheInterface $store = null)
     {
         return $this->with('CacheStore', $store);
     }
@@ -1600,7 +1600,7 @@ private function filterCookiesCacheKey(?string $cacheKey): string
         return Arr::implode(':', [self::class, 'cookies', $cacheKey], '');
     }
 
-    private function getCache(): CacheStoreInterface
+    private function getCache(): CacheInterface
     {
         return $this->CacheStore ?? Cache::getInstance();
     }