Skip to content

ListableCassetteStoreInterface

A CassetteStoreInterface whose store can also enumerate what it holds.

Separate from the base contract for the same reason ListableObjectStoreClientInterface is separate from ObjectStoreClientInterface: cassette:list and cassette:prune need this, but a store that genuinely cannot list (a pure key-value backend with no enumeration API at all) should not have to implement a method it cannot honour. Every store this package or its driver packages ship today (file, PDO, object-store-backed) does implement it, each over its own underlying listing mechanism.

interface ListableCassetteStoreInterface extends CassetteStoreInterface

ImplementsCassetteStoreInterface
Implemented byFileCassetteStore, PdoCassetteStore, ObjectStoreCassetteStore
SourceStore/ListableCassetteStoreInterface.php
MethodDescription
slugs(): list<string>Every cassette id currently in the store, as slugs (not raw ids — a store never learns a cassette’s raw id without decoding it).

abstract public function slugs(): list<string>

Every cassette id currently in the store, as slugs (not raw ids — a store never learns a cassette’s raw id without decoding it).

Returns list``<``string``>

These come from an ancestor and are documented where they are declared.

MethodDeclared inDescription
delete()CassetteStoreInterfaceRemoves the cassette at $id.
get()CassetteStoreInterfaceNull when no cassette is stored under this id.
has()CassetteStoreInterface
put()CassetteStoreInterface