https://github.com/byjg/php-cache-engine
A multi-purpose cache engine PSR-6 and PSR-16 implementation with several drivers.
https://github.com/byjg/php-cache-engine
cache cachepool memcached php psr-16 psr-6 redis shared-memory
Last synced: about 2 months ago
JSON representation
A multi-purpose cache engine PSR-6 and PSR-16 implementation with several drivers.
- Host: GitHub
- URL: https://github.com/byjg/php-cache-engine
- Owner: byjg
- License: mit
- Created: 2015-07-21T19:06:13.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T14:50:44.000Z (3 months ago)
- Last Synced: 2025-04-15T06:12:38.518Z (about 2 months ago)
- Topics: cache, cachepool, memcached, php, psr-16, psr-6, redis, shared-memory
- Language: PHP
- Homepage:
- Size: 192 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Cache Engine
[](https://github.com/byjg/php-cache-engine/actions/workflows/phpunit.yml)
[](http://opensource.byjg.com)
[](https://github.com/byjg/php-cache-engine/)
[](https://opensource.byjg.com/opensource/licensing.html)
[](https://github.com/byjg/php-cache-engine/releases/)
A multipurpose cache engine PSR-6 and PSR-16 implementation with several drivers.
## PSR-16
PSR-16 defines a Simple Cache interface with less verbosity than PSR-6. Below a list
of engines available in this library that is PSR-16 compliant:
PSR-16 Getting Started: [here](docs/basic-usage-psr16-simplecache.md)
## PSR-6
The PSR-6 implementation use the engines defined above. PSR-6 is more verbosity and
have an extra layer do get and set the cache values.
You can use one of the factory methods to create a instance of the CachePool implementation:
PSR-6 Getting Started: [here](docs/basic-usage-psr6-cachepool.md)
## List of Cache Engines
| Class | Description |
|:-------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------|
| [\ByJG\Cache\Psr16\NoCacheEngine](docs/class-no-cache-engine.md) | Do nothing. Use it for disable the cache without change your code |
| [\ByJG\Cache\Psr16\ArrayCacheEngine](docs/class-array-cache-engine.md) | Local cache only using array. It does not persists between requests |
| [\ByJG\AnyDataset\NoSql\Cache\KeyValueCacheEngine](https://github.com/byjg/php-anydataset-nosql) | Use S3-Like or ClouflareKV as a store for the cache (other repository) |
| [\ByJG\Cache\Psr16\FileSystemCacheEngine](docs/class-filesystem-cache-engine.md) | Save the cache result in the local file system |
| [\ByJG\Cache\Psr16\MemcachedEngine](docs/class-memcached-engine.md) | Uses the Memcached as the cache engine |
| [\ByJG\Cache\Psr16\TmpfsCacheEngine](docs/class-tmpfs-cache-engine.md) | Uses the Tmpfs as the cache engine |
| [\ByJG\Cache\Psr16\RedisCachedEngine](docs/class-redis-cache-engine.md) | uses the Redis as cache |
| [\ByJG\Cache\Psr16\SessionCachedEngine](docs/class-session-cache-engine.md) | uses the PHP session as cache |
| [\ByJG\Cache\Psr16\ShmopCacheEngine](docs/class-shmop-cache-engine.md) (deprecated) | uses the shared memory area for cache. Use TmpfsCacheEngine. |
## Logging cache commands
You can add a PSR Log compatible to the constructor in order to get Log of the operations
See log examples [here](docs/setup-log-handler.md)
## Use a PSR-11 container to retrieve the cache keys
You can use a PSR-11 compatible to retrieve the cache keys.
See more [here](docs/psr11-usage.md)
## Beyond the PSR protocol
The PSR protocol is a good way to standardize the cache access,
but sometimes you need to go beyond the protocol.
Some cache engines have additional features that are not covered by the PSR protocol.
Some examples are:
- [Atomic Operations](docs/atomic-operations.md)
- [Garbage Collection](docs/garbage-collection.md)
## Install
Just type:
```
composer require "byjg/cache-engine"
```
## Running Unit Testes
```
vendor/bin/phpunit --stderr
```
**Note:** the parameter `--stderr` after `phpunit` is to permit run the tests on SessionCacheEngine.
## Dependencies
```mermaid
flowchart TD
byjg/cache-engine --> psr/cache
byjg/cache-engine --> psr/log
byjg/cache-engine --> psr/simple-cache
byjg/cache-engine --> psr/container
```
----
[Open source ByJG](http://opensource.byjg.com)