yiisoft / cache-apcu
Yii Caching Library - APCu Handler
Fund package maintenance!
Open Collective
yiisoft
Requires
- php: ^7.4|^8.0
- ext-apcu: *
- psr/simple-cache: ~1.0.1
Requires (Dev)
- phpunit/phpunit: ^9.4
- roave/infection-static-analysis-plugin: ^1.5
- spatie/phpunit-watcher: ^1.23
- vimeo/psalm: ^4.3
Provides
This package is auto-updated.
Last update: 2023-08-31 00:43:34 UTC
README
Yii Cache Library - APCu Handler
This package uses the PHP APCu extension and implements PSR-16 cache.
This option can be considered as the fastest one when dealing with a cache for a centralized thick application (e.g. one server, no dedicated load balancers, etc.).
Requirements
- PHP 8.0 or higher.
APCu
PHP extension.
Installation
The package could be installed with composer:
composer require yiisoft/cache-apcu --prefer-dist
General usage
The package does not contain any additional functionality for interacting with the cache, except those defined in the PSR-16 interface.
$cache = new \Yiisoft\Cache\Apcu\ApcuCache(); $parameters = ['user_id' => 42]; $key = 'demo'; // try retrieving $data from cache $data = $cache->get($key); if ($data === null) { // $data is not found in cache, calculate it from scratch $data = calculateData($parameters); // store $data in cache for an hour so that it can be retrieved next time $cache->set($key, $data, 3600); } // $data is available here
In order to delete value you can use:
$cache->delete($key); // Or all cache $cache->clear();
To work with values in a more efficient manner, batch operations should be used:
getMultiple()
setMultiple()
deleteMultiple()
This package can be used as a cache handler for the Yii Caching Library.
Testing
Unit testing
The package is tested with PHPUnit. To run tests:
./vendor/bin/phpunit
Mutation testing
The package tests are checked with Infection mutation framework. To run it:
./vendor/bin/infection
Static analysis
The code is statically analyzed with Psalm. To run static analysis:
./vendor/bin/psalm
Support the project
Follow updates
License
The Yii Logging Library - APCu Handler is free software. It is released under the terms of the BSD License.
Please see LICENSE
for more information.
Maintained by Yii Software.