consik/yii2-cachecleaner

Yii2 behavior for deleting cache values on component event

Yii2 CacheCleaner Extension

, _(*1)

Installation

The preferred way to install this extension is through composer., _(*2)

Either run, _(*3)

composer require consik/yii2-cachecleaner

or add, _(*4)

"consik/yii2-cachecleaner": "^1.0"

CacheCleanerBehavior class description

Deletes cache after defined events., _(*5)

Properties

1. array $events = [] - Associative array where key is event name, value(array|string|null) is a cache key(s) to delete
2. string $cacheComponent = 'cache' - Name of the application cache component

Public methods

1. boolean deleteCache(string|array $key) - Deletes cache value(s)
2. boolean flushCache() - Deletes all cache values

ARUpdateCCBehavior class description. #docs

Deletes cache values after updating ActiveRecord attributes, _(*6)

Properties

1. array $attributes = [] - Associative array, where array keys is attributes name, array value is cache value(s) keys
2. string $cacheComponent = 'cache' - Name of the application cache component

See DocBlock for usage examples., _(*7)

Examples

Autodelete cache after AR update

Simple use case: We have cached AR object somewhere in our app:, _(*8)

<?php
...
if (!$model = Yii::$app->cache->get('cachedModel')) {
    $model = ARModel::findOne($modelID);
    Yii::$app->cache->set('cachedModel', $model);
}
...

So, if somewhere in applicaton we change or delete this AR data, we have to delete our cache value., _(*9)

Just use CacheCleanerBehavior in your ARModel:, _(*10)

<?php
public function behaviors()
{
    return [[
        'class' => CacheCleanerBehavior::className(),
        //'cacheComponent' => 'cache',  //you can define your app cache component
        'events' => [
            ActiveRecord::EVENT_AFTER_UPDATE => 'cachedModel'
            ActiveRecord::EVENT_BEFORE_DELETE => 'cachedModel'
        ]
    ]];
}

NOTE! When component initialize behaviors there is no attributes! To set cache keys with object attributes use callable param for defining. #DocBlock, _(*11)

Using CacheUpdateEvent

There is a special class in package for triggering events when you change cache values, where you can send to handler action changed cache key(s)., _(*12)

You can use this class with CacheCleanerBehavior if you want delete different keys using one event name., _(*13)

Example:, _(*14)

<?php
public function behaviors()
{
    return [[
        'class' => CacheCleanerBehavior::className(),
        'events' => [
            YOUR_EVENT_NAME => null
        ]
    ]];
}

...

function someComponentAction()
{
...
    $this->trigger(YOUR_EVENT_NAME, new CacheUpdateEvent([
        'keys' => ['keyName1', 'keyName2'],
    ]));
...
}

Other options for defining $events property

See the doc block for CacheCleanerBehavior::$events, _(*15)