segregates reads and writes into two separate BEAR.Resource repository.
PHP
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
demo
src-annotation
src
tests
.gitignore
.php_cs
.scrutinizer.yml
.travis.yml
LICENSE
README.md
build.xml
composer.json
php.ini
phpcs.xml
phpmd.xml
phpstan.neon
phpunit.xml.dist

README.md

BEAR.QueryRepository

Scrutinizer Code Quality Code Coverage Build Status Build Status

CQRS-inspired BEAR.QueryRepository segregates reads and writes into two separate repository.

Transparent caching is enabled with @Cacheable annotated resource. When you post, put, patch or delete the resource, data is automatically stored in Query only repository. It can be worked as a normal cache with expiry time. You can also treat it as permanent query only data storage without expiry.

Meta information will be added in the header just like HTTP cache as following.

  • Etag: 2296077071
  • Last-Modified: Mon, 29 Dec 2014 04:51:43 GMT

Composer install

$ composer require bear/query-repository

Module install


use BEAR\QueryRepository\Expiry;
use BEAR\QueryRepository\QueryRepositoryModule;
use BEAR\QueryRepository\Annotation\ExpiryConfig;
use BEAR\QueryRepository\Annotation\Storage;
use BEAR\Resource\Module\ResourceModule;
use Doctrine\Common\Cache\ArrayCache;
use Doctrine\Common\Cache\CacheProvider;
use Ray\Di\AbstractModule;
use Ray\Di\Scope;

class AppModule extends AbstractModule
{
    /**
     * {@inheritdoc}
     */
    protected function configure()
    {
        $this->install(new QueryRepositoryModule); // main module
        $this->override(new MobileEtagModule);     // mobile etag module
        
        // Cache time
        list($short, $medium, $long) = [60, 3600, 24 * 3600];
        $this->install(new StorageExpiryModule($short, $medium, $long);
        
        // Query repository engine - memcached
        $memcachedServer = 'mem1.domain.com:11211:33,mem2.domain.com:11211:67'; // {host}:{port}:{weight},...
        $this->install(new StorageMemcachedModule($memcachedServer);
        
        // or 
        
        // Query repository engine - redis
        $redisServer = $server = 'localhost:6379'; // {host}:{port}
        $this->install(new StorageRedisModule($redisServer);        
    }
}

Redis install in OSX

brew install redis
redis-server

Usage

@Cacheable annotation


use BEAR\QueryRepository\Annotation\Cacheable;
use BEAR\Resource\ResourceObject;
 
/**
 * @Cacheable
 */
class User extends ResourceObject
{
    public function onGet($id)
    {
        // invoke not only 'GET' but also 'PATCH'
    }

     public function onPatch($id, $name)
    {
        // automatically re-generate the entry in query repository.
    }
}

A type option can select cache type either value or view. A value cache only cache resource value, A resource view (html or json) is rendered by each.

/**
 * @Cacheable(type="value")
 */

A view cache stored both template assigned view and resource value.

/**
 * @Cacheable(type="view")
 */

The default type of cahe is value.

An expiry option can limit data life time, short, medium, long and never are provided.

/**
 * @Cacheable(expiry="short")
 */

You can configure expiry time with ExpiryConfig binding.

// Cache time
list($short, $medium, $long) = [60, 3600, 24 * 3600];
$this->bind()->annotatedWith(ExpiryConfig::class)->toInstance(new Expiry($short, $medium, $long));
storage namespace

Also Storage for cache storage engine.

use Doctrine\Common\Cache\CacheProvider;
use Doctrine\Common\Cache\ApcCache;
use BEAR\RepositoryModule\Annotation\Storage;
use Ray\Di\Scope;

// ...

$this->bind(CacheProvider::class)->annotatedWith(Storage::class)->to(ApcCache::class)->in(Scope::SINGLETON);

When you have multiple web servers, shared storage engine like MemcacheCache or Redis are required.

@Purge / @Refresh annotation

You can purge or refresh entity value in query repository with @Purge or @Refresh annotation.

use BEAR\RepositoryModule\Annotation\Purge;
use BEAR\RepositoryModule\Annotation\Refresh;

class User extends ResourceObject
{
     /**
      * @Purge(uri="app://self/user/friend?user_id={id}")
      * @Refresh(uri="app://self/user/profile?user_id={id}")
      */
     public function onPatch($id, $name)

Direct access

You can manually access query repository with QueryRepository object.


use BEAR\QueryRepository\QueryRepository
use BEAR\Resource\Uri;

class AdminTool
{
    private $queryRepository;
    
    public function __construct(QueryRepositoryInterface $queryRepository)
    {
        $this->queryRepository = $queryRepository;
    }
    
    public function onPost()
    {
        // purge resource
        $this->queryRepository->purge(new Uri('app://self/ad/?id={id}', ['id' => 1]));
        
        // save
        $this->queryRepository->put($this);
        $this->queryRepository->put($resourceObject);

        // delete
        $repository->purge($resourceObject->uri);
        $repository->purge(new Uri('app://self/user'));
        
        // load
        list($code, $headers, $body) = $repository->get(new Uri('app://self/user'));
    }
}

Demo

php demo/run.php
    
GET
onGet invoked
200{"name":"bear","rnd":59}

GET
200{"name":"bear","rnd":59}

PATCH
onGet invoked
200{"name":"kuma","rnd":81}

GET
200{"name":"kuma","rnd":81}

GET
200{"name":"kuma","rnd":81}