CassetteStoreInterface
Where a cassette is written and read back from.
Listing is deliberately not part of this base contract — see ListableCassetteStoreInterface, which FileCassetteStore, a PDO-backed store, and an object-store-backed one all implement, each over its own underlying listing mechanism (a directory scan, a SELECT, or Quiote\Storage\ListableObjectStoreClientInterface’s own prefix-scan listing).
Synopsis
Section titled “Synopsis”interface CassetteStoreInterface
| Implemented by | ListableCassetteStoreInterface |
| Source | Store/CassetteStoreInterface.php |
Methods
Section titled “Methods”| Method | Description |
|---|---|
delete(CassetteId $id): void | Removes the cassette at $id. |
get(CassetteId $id): ?Cassette | Null when no cassette is stored under this id. |
has(CassetteId $id): bool | |
put(CassetteId $id, Cassette $cassette): void |
delete()
Section titled “delete()”abstract public function delete(CassetteId $id): void
Removes the cassette at $id.
Best-effort: an id that does not exist is not an error.
| Parameter | Type | Description |
|---|---|---|
$id | CassetteId |
abstract public function get(CassetteId $id): ?Cassette
Null when no cassette is stored under this id.
| Parameter | Type | Description |
|---|---|---|
$id | CassetteId |
Returns ?Cassette
abstract public function has(CassetteId $id): bool
| Parameter | Type | Description |
|---|---|---|
$id | CassetteId |
Returns bool
abstract public function put(CassetteId $id, Cassette $cassette): void
| Parameter | Type | Description |
|---|---|---|
$id | CassetteId | |
$cassette | Cassette |
| Throws | When |
|---|---|
StorageException | if the cassette could not be written. |