Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nilportugues/repository-cache

[PHP 7] Repository with Cache layer using PSR-6
https://github.com/nilportugues/repository-cache

apcu cache clean-architecture clean-code ddd domain-driven-design ephemeral filesystem hexagonal-architecture inmemory memcache memcached performance php php7 psr-6 redis repository sqlite stashphp

Last synced: 3 months ago
JSON representation

[PHP 7] Repository with Cache layer using PSR-6

Host: GitHub
URL: https://github.com/nilportugues/repository-cache
Owner: nilportugues
Created: 2016-01-26T21:43:43.000Z (almost 9 years ago)
Default Branch: master
Last Pushed: 2016-08-08T23:32:42.000Z (over 8 years ago)
Last Synced: 2024-10-04T18:50:42.088Z (4 months ago)
Topics: apcu, cache, clean-architecture, clean-code, ddd, domain-driven-design, ephemeral, filesystem, hexagonal-architecture, inmemory, memcache, memcached, performance, php, php7, psr-6, redis, repository, sqlite, stashphp
Language: PHP
Homepage: http://nilportugues.com
Size: 21.5 KB
Stars: 7
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Repository Cache

![PHP7 Tested](http://php-eye.com/badge/nilportugues/repository-cache/php70.svg)

[![Build Status](https://travis-ci.org/PHPRepository/repository-cache.svg)](https://travis-ci.org/PHPRepository/repository-cache) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/nilportugues/php-repository-cache/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/nilportugues/php-repository-cache/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/2941364f-c744-4680-ac53-a77f5328a46d/mini.png)](https://insight.sensiolabs.com/projects/2941364f-c744-4680-ac53-a77f5328a46d) [![Latest Stable Version](https://poser.pugx.org/nilportugues/repository-cache/v/stable)](https://packagist.org/packages/nilportugues/repository-cache) [![Total Downloads](https://poser.pugx.org/nilportugues/repository-cache/downloads)](https://packagist.org/packages/nilportugues/repository-cache) [![License](https://poser.pugx.org/nilportugues/repository-cache/license)](https://packagist.org/packages/nilportugues/repository-cache)

[![Donate](https://www.paypalobjects.com/en_US/i/btn/btn_donate_SM.gif)](https://paypal.me/nilportugues)

Repository to be used with *[nilportugues/repository](https://github.com/nilportugues/php-repository)* implementing a PSR-6 cache layer using [StashPHP](http://www.stashphp.com/).

## Installation

Use [Composer](https://getcomposer.org) to install the package:

```json

$ composer require nilportugues/repository-cache

```

## Cache Drivers

Repository Cache supports all of Stash's drivers:

- **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](http://www.stashphp.com/Drivers.html).

## Usage

```php

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.

This library attempts to comply with [PSR-1](http://www.php-fig.org/psr/psr-1/), [PSR-2](http://www.php-fig.org/psr/psr-2/), [PSR-4](http://www.php-fig.org/psr/psr-4/).

If you notice compliance oversights, please send a patch via [Pull Request](https://github.com/nilportugues/php-repository-cache/pulls).

## Contribute

Contributions to the package are always welcome!

* Report any bugs or issues you find on the [issue tracker](https://github.com/nilportugues/php-repository-cache/issues/new).

* You can grab the source code at the package's [Git repository](https://github.com/nilportugues/php-repository-cache).

## Support

Get in touch with me using one of the following means:

 - Emailing me at 

 - Opening an [Issue](https://github.com/nilportugues/php-repository-cache/issues/new)

## Authors

* [Nil Portugués Calderó](http://nilportugues.com)

* [The Community Contributors](https://github.com/nilportugues/php-repository-cache/graphs/contributors)

## License

The code base is licensed under the [MIT license](LICENSE).