Repository files navigation

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

Features include:

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

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

composer require fire015/flintstone

<?phprequire'vendor/autoload.php';useFlintstone\Flintstone;$users =newFlintstone('users', ['dir' =>'/path/to/database/dir/']);

• PHP 7.3+

Flintstone can store any data type that can be formatted into a string. By default this usesserialize(). SeeChanging the formatter for more details.

<?php// Load a database$users =newFlintstone('users', ['dir' =>'/path/to/database/dir/']);// Set a key$users->set('bob', ['email' =>'bob@site.com','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' => 'bob@site.com', 'password' => '123456'));// Delete a key$users->delete('bob');// Flush the database$users->flush();

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 implementsFlintstone\Formatter\FormatterInterface and then you can provide it as theformatter option.

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

<?phprequire'vendor/autoload.php';useFlintstone\Flintstone;useFlintstone\Formatter\JsonFormatter;$users =newFlintstone('users', ['dir' =>__DIR__,'formatter' =>newJsonFormatter()]);

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

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