tugmaks/yii2-cached-dataprovider

Cached data provider

0.1 2018-02-12 18:19 UTC

Requires

• php: >7.1
• yiisoft/yii2: ^2.0.11

MIT

• Maxim Tyugaev

• yii2
• cached dataprovider

README

Simple decorator for dataprovider

Installation

The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist tugmaks/yii2-cached-dataprovider "0.1"

or add

"tugmaks/yii2-cached-dataprovider": "0.1"

to the require section of your composer.json file.

Usage example

First, you need to configure CacheResolver service in container

'singletons' => [
        'cache'                               => function () {
            return \Yii::$app->cache;
        },
        'cache_resolver.naming_strategy.caching_item_name' => [
            ['class' => \Tugmaks\Dataprovider\DefaultCacheKeyNamingStrategy::class],
            [
                'caching_item_name',
            ],
        ],
        'cache_resolver.caching_item_name'                 => [
            ['class' => \Tugmaks\Dataprovider\CacheResolver::class],
            [
                Instance::of('cache'),
                Instance::of('cache_resolver.naming_strategy.caching_item_name'),
                //Additionally you can pass cache ttl and dependecy
            ],
        ],
    ],

Second, instead of passing yii\data\DataProviderInterface object directly to data widget, you have to decorate it in this way:

use use Tugmaks\Dataprovider\CachedDataProvider;

$cacheResolver = \Yii::$container->get('cache_resolver.caching_item_name');

$cachedDataProvider = new CachedDataProvider($dataProvider, $cacheResolver);

Now pass $cachedDataProvider to data widget.