cache-wincache icon indicating copy to clipboard operation
cache-wincache copied to clipboard

Yii Cache Library - WinCache Handler

Yii Cache Library - WinCache Handler


Latest Stable Version Total Downloads Build status codecov Mutation testing badge static analysis type-coverage

This package uses the PHP Windows Cache (see also) extension and implements PSR-16 cache.

Requirements

  • PHP 7.4.
  • WinCache PHP extension.

Installation

The package could be installed with composer:

composer require yiisoft/cache-wincache --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\WinCache\WinCache();
$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.

Documentation

  • Internals

Support

If you need help or have a question, the Yii Forum is a good place for that. You may also check out other Yii Community Resources.

Support the project

Open Collective

Follow updates

Official website Twitter Telegram Facebook Slack

License

The Yii Cache Library - WinCache Handler is free software. It is released under the terms of the BSD License. Please see LICENSE for more information.

Maintained by Yii Software.