Backend

Contract implemented by cache backend adapters.

interface Backend

Backends are responsible for storing and retrieving cache values within a namespace, supporting key management operations, and exposing backend- specific option handling.

Methods

init

Initializes the backend for a cache namespace.

public init(string $namespace): void

Returns: void

Parameters

Parameter	Type	Description
$namespace	string

has

Checks whether a cache key exists in the backend.

public has(string $key, bool $checkEmpty): bool

Returns: bool

Parameters

Parameter	Type	Description
$key	string
$checkEmpty	bool

get

Retrieves a cached value by key.

public get(string $key): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$key	string

set

Stores a value in cache.

public set(string $key, mixed $value, int $timeout): bool

Returns: bool

Parameters

Parameter	Type	Description
$key	string
$value	mixed
$timeout	int

remove

Removes a cached key/value pair.

public remove(string $key): bool

Returns: bool

Parameters

Parameter	Type	Description
$key	string

clear

Clears all entries for the current namespace.

public clear(): bool

Returns: bool

toArray

Exports cached key/value pairs as an array snapshot.

public toArray(): array

Returns: array

count

Counts entries currently stored in the active namespace.

public count(): int

Returns: int

setOption

Sets a backend-specific runtime option.

public setOption(string $key, mixed $value): void

Returns: void

Parameters

Parameter	Type	Description
$key	string
$value	mixed

---

Generated by Hazaar API Doc Generator on Fri, 04 Sep 2026 23:32:16 +0000