bearsunday / BEAR.QueryRepository

src/ResourceStorageInterface.php

<?php

declare(strict_types=1);

namespace BEAR\QueryRepository;

use BEAR\Resource\AbstractUri;
use BEAR\Resource\ResourceObject;

interface ResourceStorageInterface
{
    /**
     * Is ETag registered ?
     */
    public function hasEtag(string $etag): bool;

    /**
     * Save Etag
     */
    public function saveEtag(AbstractUri $uri, string $etag, string $surrogateKeys, int|null $ttl): void;

    /**
     * Delete Etag
     *
     * @return bool
     */
    public function deleteEtag(AbstractUri $uri);

    /**
     * Return cached resource state
     */
    public function get(AbstractUri $uri): ResourceState|null;

    /**
     * Save resource cache with value
     *
     * @return bool
     */
    public function saveValue(ResourceObject $ro, int $ttl);

    /**
     * Save resource cache with view
     *
     * @return bool
     */
    public function saveView(ResourceObject $ro, int $ttl);

    /**
     * Return cached resource static
     */
    public function getDonut(AbstractUri $uri): ResourceDonut|null;

    /**
     * Save donut-cacheable page
     *
     * @param list<string> $headerKeys

The type BEAR\QueryRepository\list was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    public function saveDonut(AbstractUri $uri, ResourceDonut $donut, int|null $sMaxAge, array $headerKeys): void;

    /**
     * Save donut-cache state
     */
    public function saveDonutView(ResourceObject $ro, int|null $ttl): bool;

    /**
     * Invalidate tags
     *
     * @param list<string> $tags
     */
    public function invalidateTags(array $tags): bool;
}