File

Filesystem/B-Tree cache backend.

class File extends \Hazaar\Cache\Backend

Extends: Hazaar\Cache\Backend

Persists cache entries to a namespaced on-disk B-Tree store, making it a broadly available fallback backend when in-memory extensions are unavailable.

Features include:

• Optional zlib compression for stored payloads
• Per-value expiration support
• Optional namespace TTL with keepalive extension on access
• Deferred shutdown cleanup of expired namespace files

Properties

weight

Backend priority weight used in chained backend ordering.

protected int $weight = 4

Type: int

config

Typed view of this backend's options.

private File\Options $config

Type: Hazaar\Cache\Backend\File\Options

zlib

Indicates whether zlib support is available in the current runtime.

private bool $zlib

Type: bool

cacheDir

Absolute directory path used for backend cache files.

private string $cacheDir

Type: string

timeout

Current namespace timeout epoch for keepalive/expiry handling.

private int $timeout

Type: int

local

private array $local

Type: array

store

Open B-Tree store instance for the active namespace.

private BTree $store

Type: Hazaar\Util\BTree

__openStore

private array $__openStore

Type: array

shutdownRegistered

Tracks whether global shutdown cleanup has been registered.

private bool $shutdownRegistered

Type: bool

Methods

close

Closes the cache backend, storing the timeout value if set, and registers a shutdown function

public close(): bool

Returns: bool

to clean up expired cache files in the cache directory.

The shutdown function iterates through the cache directory, checks each file's modification time, and removes files whose namespace timeout has expired plus an additional 5 minutes.

available

Indicates whether this backend is available.

public available(): bool

Returns: bool

init

Initializes storage paths, opens the namespace B-Tree store, and configures capabilities.

public init(string $namespace): void

Returns: void

Parameters

Parameter	Type	Description
$namespace	string	active cache namespace

has

Check if a value exists.

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

Returns: bool

Parameters

Parameter	Type	Description
$key	string
$checkEmpty	bool

get

Retrieves a cache value.

public get(string $key): mixed

Returns: mixed

Parameters

Parameter	Type	Description
$key	string	cache key

set

Stores a value in the B-Tree cache backend.

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

Returns: bool

Parameters

Parameter	Type	Description
$key	string	cache key
$value	mixed	value to store
$timeout	int	optional per-value timeout in seconds

remove

Removes a key from cache.

public remove(string $key): bool

Returns: bool

Parameters

Parameter	Type	Description
$key	string	cache key

clear

Clears all keys in the active namespace.

public clear(): bool

Returns: bool

toArray

public toArray(): array

Returns: array

count

Returns the number of active (non-expired) keys in this namespace.

public count(): int

Returns: int

keepalive

Extends namespace timeout when namespace TTL is enabled.

private keepalive(): void

Returns: void

load

Load the key value from storage.

private load(string $key, ?array $cache): mixed

Returns: mixed

This should only happen once and then it will be stored in memory and only written again when changed.

Parameters

Parameter	Type	Description
$key	string
$cache	array

---

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