Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/yiisoft/cache-apcu
Yii Cache Library - APCu Handler
https://github.com/yiisoft/cache-apcu
apcu cache cache-storage hacktoberfest psr-16 yii3
Last synced: 8 days ago
JSON representation
Yii Cache Library - APCu Handler
- Host: GitHub
- URL: https://github.com/yiisoft/cache-apcu
- Owner: yiisoft
- License: bsd-3-clause
- Created: 2019-05-02T12:37:52.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-31T13:49:45.000Z (over 1 year ago)
- Last Synced: 2024-04-13T23:13:21.327Z (6 months ago)
- Topics: apcu, cache, cache-storage, hacktoberfest, psr-16, yii3
- Language: PHP
- Homepage: https://www.yiiframework.com/
- Size: 90.8 KB
- Stars: 11
- Watchers: 18
- Forks: 7
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Yii Cache Library - APCu Handler
[](https://packagist.org/packages/yiisoft/cache-apcu)
[](https://packagist.org/packages/yiisoft/cache-apcu)
[](https://github.com/yiisoft/cache-apcu/actions?query=workflow%3Abuild)
[](https://scrutinizer-ci.com/g/yiisoft/cache-apcu/?branch=master)
[](https://scrutinizer-ci.com/g/yiisoft/cache-apcu/?branch=master)
[](https://dashboard.stryker-mutator.io/reports/github.com/yiisoft/cache-apcu/master)
[](https://github.com/yiisoft/cache-apcu/actions?query=workflow%3A%22static+analysis%22)
[](https://shepherd.dev/github/yiisoft/cache-apcu)
This package uses the PHP [APCu](https://www.php.net/manual/book.apcu.php)
extension and implements [PSR-16](https://www.php-fig.org/psr/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](https://getcomposer.org):
```shell
composer require yiisoft/cache-apcu
```
## General usage
The package does not contain any additional functionality for interacting with the cache,
except those defined in the [PSR-16](https://www.php-fig.org/psr/psr-16/) interface.
```php
$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:
```php
$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](https://github.com/yiisoft/cache).
## Documentation
- [Internals](docs/internals.md)
If you need help or have a question, the [Yii Forum](https://forum.yiiframework.com/c/yii-3-0/63) is a good place for
that. You may also check out other [Yii Community Resources](https://www.yiiframework.com/community).
## License
The Yii Cache Library - APCu Handler is free software. It is released under the terms of the BSD License.
Please see [`LICENSE`](./LICENSE.md) for more information.
Maintained by [Yii Software](https://www.yiiframework.com/).
## Support the project
[](https://opencollective.com/yiisoft)
## Follow updates
[](https://www.yiiframework.com/)
[](https://twitter.com/yiiframework)
[](https://t.me/yii3en)
[](https://www.facebook.com/groups/yiitalk)
[](https://yiiframework.com/go/slack)