Storage interface

composer require quillstack/storage-interface

PackagistSource PHP ^8.1

Common interface for Storage classes.

Six methods, so that something writing files does not have to know which files. A package depending on this one works the same against the disk, against a bucket, or against something held in memory for a test.

Requirements

• PHP 8.1 or newer

Installation

composer require quillstack/storage-interface

Usage

Ask for the interface, not for an implementation:

use Quillstack\StorageInterface\StorageInterface;

final class Invoices
{
    public function __construct(private readonly StorageInterface $storage)
    {
    }

    public function keep(string $number, string $pdf): void
    {
        $this->storage->save("/invoices/{$number}.pdf", $pdf);
    }
}

Point it at whichever storage the application uses:

$app = new App(__DIR__ . '/../.env', [
    StorageInterface::class => LocalStorage::class,
]);

Technical documentation

Method	Does
get(string $path): mixed	reads what is there
exists(string $path): bool	whether there is anything at that path
missing(string $path): bool	the other way round, because !exists() reads worse
save(string $path, mixed $contents): bool	writes, replacing whatever was there
add(string $path, mixed $contents): bool	writes on the end of what is there
delete(string $path, string ...$more): bool	removes one or several

What implements it

• quillstack/local-storage — files on disk

quillstack/queue writes messages through it, which is why a queue can be pointed somewhere other than the local disk without knowing it has been.

There is nothing to run here: a package which only names things has no behaviour to test.

License

MIT. See LICENSE.