nilportugues/repository-cache

Implementation of a base repository with cache layer using StashPHP

Repository Cache

, _(*1)

Repository to be used with nilportugues/repository implementing a PSR-6 cache layer using StashPHP., _(*2)

Installation

Use Composer to install the package:, _(*3)

$ composer require nilportugues/repository-cache

Cache Drivers

Repository Cache supports all of Stash's drivers:, _(*4)

• System
  • FileSystem
  • Sqlite (requires php-pdo-sqlite extension)
  • APC (requires php-apcu extension)
• Server
  • Memcached (requires php-memcache or php-memcached extensions)
  • Redis (requires php-redis extension)
• Specialized
  • Ephemeral (in memory cache)
  • Composite

For more information please check out Stash's documentation., _(*5)

Usage

use NilPortugues\Foundation\Infrastructure\Model\Repository\Cache\RepositoryCache;
use Stash\Driver\Ephemeral;
use Stash\Driver\Memcache;
use Stash\Pool;

//---------------------------------------------------------------------------
// Definition of cache drivers
//---------------------------------------------------------------------------
$memcached = new Memcache();
$memcached->setOptions(array('servers' => array('127.0.0.1', '11211')));

$cachePool = new Pool();
$cachePool->setDriver(new Ephemeral()); //hit in memory first as always will be faster
$cachePool->setDriver($memcached); //hit memcached second.

$ttl = 3600; //time in second for cache to expire.
$cacheNamespace = Color::class;

//---------------------------------------------------------------------------
// Adding cache to an existing repository
//---------------------------------------------------------------------------
$sqlRepository = new MySQLColorRepository();
$repository = new RepositoryCache($cachePool, $repository, $cacheNamespace, $ttl);

//---------------------------------------------------------------------------
// Now use as normal... 
//---------------------------------------------------------------------------
$color = new Color('#@@@@@@', 'New color');
$repository->add($color);
$repository->find(ColorId('#@@@@@@')); //should hit cache and return an instance of Color.

Quality

To run the PHPUnit tests at the command line, go to the tests directory and issue phpunit., _(*6)

This library attempts to comply with PSR-1, PSR-2, PSR-4., _(*7)

If you notice compliance oversights, please send a patch via Pull Request., _(*8)

Contribute

Contributions to the package are always welcome!, _(*9)

• Report any bugs or issues you find on the issue tracker.
• You can grab the source code at the package's Git repository.

Support

Get in touch with me using one of the following means:, _(*10)

• Emailing me at contact@nilportugues.com
• Opening an Issue

Authors

• Nil Portugués Calderó
• The Community Contributors

License

The code base is licensed under the MIT license., _(*11)