eydun / flintstone

A key/value database store using flat files for PHP.

Flintstone

A key/value database store using flat files for PHP.

Features include:

• Memory efficient
• File locking
• Caching
• Gzip compression
• Easy to use

Installation

The easiest way to install Flintstone is via composer. Run the following command to install it.

composer require fire015/flintstone

<?php
require 'vendor/autoload.php';

use Flintstone\Flintstone;

$users = new Flintstone('users', ['dir' => '/path/to/database/dir/']);

Requirements

• PHP 7.3+

Data types

Flintstone can store any data type that can be formatted into a string. By default this uses serialize(). See Changing the formatter for more details.

Options

Name	Type	Default Value	Description
dir	string	the current working directory	The directory where the database files are stored (this should be somewhere that is not web accessible) e.g. /path/to/database/
ext	string	.dat	The database file extension to use
gzip	boolean	false	Use gzip to compress the database
cache	boolean or object	true	Whether to cache get() results for faster data retrieval
formatter	null or object	null	The formatter class used to encode/decode data
swap_memory_limit	integer	2097152	The amount of memory to use before writing to a temporary file

Usage examples

<?php

// Load a database
$users = new Flintstone('users', ['dir' => '/path/to/database/dir/']);

// Set a key
$users->set('bob', ['email' => '[email protected]', 'password' => '123456']);

// Get a key
$user = $users->get('bob');
echo 'Bob, your email is ' . $user['email'];

// Retrieve all key names
$keys = $users->getKeys(); // returns array('bob')

// Retrieve all data
$data = $users->getAll(); // returns array('bob' => array('email' => '[email protected]', 'password' => '123456'));

// Delete a key
$users->delete('bob');

// Flush the database
$users->flush();

Changing the formatter

By default Flintstone will encode/decode data using PHP's serialize functions, however you can override this with your own class if you prefer.

Just make sure it implements Flintstone\Formatter\FormatterInterface and then you can provide it as the formatter option.

If you wish to use JSON as the formatter, Flintstone already ships with this as per the example below:

<?php
require 'vendor/autoload.php';

use Flintstone\Flintstone;
use Flintstone\Formatter\JsonFormatter;

$users = new Flintstone('users', [
    'dir' => __DIR__,
    'formatter' => new JsonFormatter()
]);

Changing the cache

To speed up data retrieval Flintstone can store the results of get() in a cache store. By default this uses a simple array that only persist's for as long as the Flintstone object exists.

If you want to use your own cache store (such as Memcached) you can pass a class as the cache option. Just make sure it implements Flintstone\Cache\CacheInterface.