Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/decodelabs/stash
PSR6 / PSR16 Cache handler
https://github.com/decodelabs/stash
apcu cache memcached php redis
Last synced: 10 days ago
JSON representation
PSR6 / PSR16 Cache handler
- Host: GitHub
- URL: https://github.com/decodelabs/stash
- Owner: decodelabs
- License: mit
- Created: 2022-10-16T17:26:50.000Z (about 2 years ago)
- Default Branch: develop
- Last Pushed: 2024-09-04T21:33:56.000Z (4 months ago)
- Last Synced: 2024-11-30T03:18:13.702Z (about 1 month ago)
- Topics: apcu, cache, memcached, php, redis
- Language: PHP
- Homepage:
- Size: 98.6 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Stash
[](https://packagist.org/packages/decodelabs/stash)
[](https://packagist.org/packages/decodelabs/stash)
[](https://packagist.org/packages/decodelabs/stash)
[](https://github.com/decodelabs/stash/actions/workflows/integrate.yml)
[](https://github.com/phpstan/phpstan)
[](https://packagist.org/packages/decodelabs/stash)
### Cache storage system
Stash provides a PSR6 / PSR16 compatible cache system for PHP.
_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._
---
## Installation
```bash
composer require decodelabs/stash
```
## Usage
Store and access data in a standardised volatile cache either via the PSR6 or PSR16 interface mechanisms.
Caches are namespaced to allow for clean separation of data between usage domains.
```php
use DecodeLabs\Stash;
$myCache = Stash::load('MyCache');
if(!$cache->has('myValue')) {
$cache->set('myValue', [1, 2, 3]);
}
$total = 0;
foreach($cache->get('myValue', []) as $number) {
$total += $number;
}
$cache->delete('myValue');
```
### Fetch
Use the fetch method to ensure a cache value is in place in one call:
```php
$myValue = $myCache->fetch('myValue', function() {
return [1, 2, 3]; // Only called if key not found in cache
});
```
### Array Access
Array access methods provide quick offset access to cache data:
```php
if(!isset($myCache['myValue'])) {
$myCache['myValue'] = 'Hello world';
}
echo $myCache['myValue'];
unset($MyCache['myValue']);
```
### Object access
Object access works the same way as ArrayAccess, but with the PSR6 Cache Item object as the return:
```php
$item = $myCache->myValue;
if(!$item->isHit()) {
$item->set('Hello world');
}
echo $item->get();
$item->delete();
```
## Drivers
The following drivers are available out of the box:
- Memcache
- Redis
- Predis (native PHP redis client)
- APCu
- File (serialized data)
- PhpFile (var_export data)
- PhpArray (in memory)
- Blackhole (nothing stored)
However, Stash uses [Archetype](https://github.com/decodelabs/archetype) to load driver classes so additional drivers may be provided by implementing your own `Resolver`.
By default, Stash will use the best-fit driver for your environment, starting with Memcache, through Redis and APCu, and falling back on the File store.
### Configuration
All drivers have default configuration to allow them to work out of the box, however Stash provides the ability to implement your own configuration loader so that you can control drivers and settings on a per-namespace basis
Implement the following interface however your system requires; all nullable methods can just return null to use default configuration:
```php
interface Config
{
public function getDriverFor(string $namespace): ?string;
public function isDriverEnabled(string $driver): bool;
public function getAllDrivers(): array;
public function getDriverSettings(string $driver): ?array;
public function getPileUpPolicy(string $namespace): ?PileUpPolicy;
public function getPreemptTime(string $namespace): ?int;
public function getSleepTime(string $namespace): ?int;
public function getSleepAttempts(string $namespace): ?int;
}
```
Then tell Stash about your configuration provider:
```php
Stash::setConfig(new MyConfig());
```
## Custom Store methods
By default, newly loaded caches use a generic Store implementation, however if you require custom methods for domain-oriented data access, you can implement your own Store classes using a custom [Archetype](https://github.com/decodelabs/archetype) `Resolver`.
```php
namespace MyApp;
use DecodeLabs\Archetype;
use DecodeLabs\Stash\Store;
use DecodeLabs\Stash\Store\Generic;
class MyCache extends Generic
{
public function getMyData(): string
{
return $this->fetch('myData', function() {
return 'Hello world';
});
}
}
Archetype::map(Store::class, namespace::class);
$myCache = Stash::load('MyCache'); // Will now use MyApp\MyCache
```
## Licensing
Stash is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.