utopia-php / cache
A simple cache library to manage application cache storing, loading and purging
Installs: 149 804
Dependents: 4
Suggesters: 0
Security: 0
Stars: 29
Watchers: 8
Forks: 19
Open Issues: 8
Requires
- php: >=8.0
- ext-json: *
- ext-memcached: *
- ext-redis: *
Requires (Dev)
- laravel/pint: 1.2.*
- phpstan/phpstan: 1.9.x-dev
- phpunit/phpunit: ^9.3
- vimeo/psalm: 4.13.1
- dev-master
- 0.10.2
- 0.10.1
- 0.10.0
- 0.9.1
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.1
- 0.6.0
- 0.5.0
- 0.4.2
- 0.4.1
- 0.4.0
- 0.3.0
- 0.2.3
- 0.2.2
- 0.2.1
- 0.2.0
- v0.1.1
- v0.1.0
- dev-redis-cluster
- dev-feat-redis-sync
- dev-chore-replace-expectException
- dev-feat-github-action
- dev-feat-get-size
- dev-feat-add-push-pop
- dev-feat-detailed-filesystem-adapter-errors
- dev-feat-add-ping-method
- dev-feat-add-flush-method
- dev-feat-sharding-adapter
This package is auto-updated.
Last update: 2024-10-31 11:05:30 UTC
README
Utopia framework cache library is simple and lite library for managing application cache storing, loading and purging. This library is aiming to be as simple and easy to learn and use. This library is maintained by the Appwrite team.
Although this library is part of the Utopia Framework project it is dependency free and can be used as standalone with any other PHP project or framework.
Getting Started
Install using composer:
composer require utopia-php/cache
File System Adapter
<?php require_once __DIR__ . '/../../vendor/autoload.php'; use Utopia\Cache\Cache; use Utopia\Cache\Adapter\Filesystem; $cache = new Cache(new Filesystem('/cache-dir')); $key = 'data-from-example.com'; $data = $cache->load($key, 60 * 60 * 24 * 30 * 3 /* 3 months */); if(!$data) { $data = file_get_contents('https://example.com'); $cache->save($key, $data); } echo $data;
Contribute
Currently we support only a Filesystem adapter for usage as a cache storage, send a pull request to add redis, memcached or any other storage adapter you might need to use with this library.
System Requirements
Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
Tests
To run all unit tests, use the following Docker command:
docker compose exec tests vendor/bin/phpunit --configuration phpunit.xml tests
To run static code analysis, use the following Psalm command:
docker-compose exec php8 vendor/bin/psalm --show-info=true
Copyright and license
The MIT License (MIT) http://www.opensource.org/licenses/mit-license.php