README

A simple and flexible key-value store library for PHP. It provides a common API with multiple backends: in-memory array, file storage, Redis (ext-redis), Predis, and Eloquent.

Install

composer require cesargb/key-value-store

Requirements:

• PHP ^8.4

Optional dependencies:

• ext-redis for RedisStore
• predis/predis for PredisStore
• illuminate/database for EloquentStore
• illuminate/support for Laravel service provider integration

Usage

List of stores

• ArrayStore: in-memory storage (resets when process ends)
• FileStore: file-based storage in a local directory
• RedisStore: Redis storage using the ext-redis extension
• PredisStore: Redis storage using predis/predis
• EloquentStore: database storage through an Eloquent model

Basic usage

<?php

use Cesargb\KeyValueStore\Store;
use Cesargb\KeyValueStore\Repositories\ArrayStore;

$store = new Store(new ArrayStore());

$store->set('name', 'Cesar');
echo $store->get('name'); // Cesar

var_dump($store->has('name')); // true
$store->delete('name');
var_dump($store->has('name')); // false

Multiple keys

<?php

use Cesargb\KeyValueStore\Store;
use Cesargb\KeyValueStore\Repositories\ArrayStore;

$store = new Store(new ArrayStore());

$store->setMultiple([
    'a' => 1,
    'b' => 2,
]);

$values = $store->getMultiple(['a', 'b', 'c'], 'default');
// ['a' => 1, 'b' => 2, 'c' => 'default']

$store->deleteMultiple(['a', 'b']);

Use a different repository

<?php

use Cesargb\KeyValueStore\Store;
use Cesargb\KeyValueStore\Repositories\FileStore;
use Cesargb\KeyValueStore\Repositories\RedisStore;
use Cesargb\KeyValueStore\Repositories\PredisStore;
use Cesargb\KeyValueStore\Repositories\EloquentStore;

// File repository
$store = new Store(new FileStore(__DIR__.'/storage/kv'));

// Redis repository (ext-redis)
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);
$store = new Store(new RedisStore($redis, prefix: 'kv_'));

// Predis repository
$predis = new Predis\Client(['host' => '127.0.0.1', 'port' => 6379]);
$store = new Store(new PredisStore($predis, prefix: 'kv_'));

// Eloquent repository
// Uses package default model/table (key_value_store).
$store = new Store(new EloquentStore());

// Optional custom model (must have key + value columns).
$store = new Store(new EloquentStore($model));

Key rules:

• Keys cannot be empty.
• Keys cannot contain: { } ( ) / \ @ :

Laravel integration

The package includes Cesargb\KeyValueStore\Laravel\KeyValueStoreServiceProvider with auto-discovery support.

Publish assets:

php artisan vendor:publish --tag=key-value-store-config
php artisan vendor:publish --tag=key-value-store-migrations
php artisan migrate

Publishing is only registered when the application is running in console, and the migration is published with a current timestamped filename.

Resolve from container:

<?php

use Cesargb\KeyValueStore\Contracts\Store as StoreContract;

$store = app(StoreContract::class);