Blob store

, _(*1)

A simple interface to manage schema-free temporal persistent key/values. This was part of the Semantic MediaWiki code base and is now being deployed as independent library., _(*2)

It is suggested to use either redis, riak, or mongodb as back-end provider depending on the use case., _(*3)

Requirements

PHP 5.3 or later
Onoi/Cache ~1.1

Installation

The recommended installation method for this library is by either adding the dependency to your composer.json., _(*4)

{
    "require": {
        "onoi/blob-store": "~1.2"
    }
}

Usage

class Foo {

    private $blobStore;

    public function __construct( BlobStore $blobStore ) {
        $this->blobStore = $blobStore;
    }

    public function doSomethingFor( $id ) {
        $container = $this->blobStore->read( md5( $id ) );

        $container->set( 'one', array( new \stdClass, 'Text' ) );

        $container->append(
            'one',
            new \stdClass
        );

        $container->delete( 'two' );

        $this->blobStore->save( $container );
    }
}

$cacheFactory = new CacheFactory();

$compositeCache = $cacheFactory->newCompositeCache( array(
    $cacheFactory->newFixedInMemoryLruCache(),
    $cacheFactory->newDoctrineCache( new \Doctrine\Common\Cache\RedisCache( ... ) )
) );

or

$compositeCache = $cacheFactory->newCompositeCache( array(
    $cacheFactory->newFixedInMemoryLruCache(),
    $cacheFactory->newMediaWikiCache( \ObjectCache::getInstance( 'redis' ) )
) );

$blobStore = new BlobStore( 'foo', $compositeCache );

$instance = new Foo( $blobStore );
$instance->doSomethingFor( 'bar' );

When creating an instance a namespace is required to specify the context of the storage in case the BlobStore is used for different use cases., _(*5)

Contribution and support

If you want to contribute work to the project please subscribe to the developers mailing list and have a look at the contribution guidelinee. A list of people who have made contributions in the past can be found here., _(*6)

Tests

The library provides unit tests that covers the core-functionality normally run by the continues integration platform. Tests can also be executed manually using the composer phpunit command from the root directory., _(*7)

Release notes

1.2.0 (2016-03-19), _(*8)
- Added Container::addToLinkedList to maintain a linked list of interdependent containers (if the original container is removed then all linked containers will be expunged as well)
1.1.0 (2015-06-13), _(*9)
- Removed tracking of internal ID list
- Added Container::setExpiryInSeconds
1.0.0 (2015-06-02), _(*10)
- Initial release