README

描述

为 Yii2 框架提供的缓存小部件。将整个渲染的小部件作为一个单独的缓存项进行缓存。允许你在小部件类中一次性配置缓存，并在多个视图中渲染它，使其免于缓存业务逻辑，确保遵循 DRY 和 KISS 原则。

安装

此小部件支持 composer。你可以从 packagist 仓库 获取最新版本。

用法

定义自定义缓存小部件

定义自定义缓存小部件非常简单。只需从 Kolyunya\yii2\widgets\CacheableWidget 扩展你的小部件即可。你的小部件将由默认的缓存（cache 应用组件）缓存，默认持续时间为一分钟，无需任何依赖关系和缓存键变化。

class MySimpleCacheableWidget extends CacheableWidget
{
    /**
     * @inheritdoc
     */
    public function run()
    {
        // Do some resource-expensive work.
        $this->doSomeExpensiveWork();
        $this->doSomeMoreExpensiveWork();

        // Render some heavy templates.
        return $this->render('my-simple-cacheable-widget',
            'foo' => $this->foo,
            'bar' => $this->bar,
        ]);
    }
}

在更复杂的情况下，你可以覆盖基缓存小部件的一些受保护方法来配置更复杂的缓存策略。

class MyCacheableWidget extends CacheableWidget
{
    /**
     *
     * @var Foo
     */
    public $foo;

    /**
     *
     * @var Bar
     */
    public $bar;

    /**
     * @inheritdoc
     */
    public function run()
    {
        // Do some resource-expensive work.
        $this->doSomeExpensiveWork();
        $this->doSomeMoreExpensiveWork();

        // Render some heavy templates.
        return $this->render('my-cacheable-widget',
            'foo' => $this->foo,
            'bar' => $this->bar,
        ]);
    }

    /**
     * @inheritdoc
     */
    protected function getCacheComponent()
    {
        return 'myCustomCache';
    }

    /**
     * @inheritdoc
     */
    protected function getCacheDuration()
    {
        return 60 * 60;
    }

    /**
     * @inheritdoc
     */
    protected function getCacheDependency()
    {
        return new MyCustomCacheDependency();
    }

    /**
     * @inheritdoc
     */
    protected function getCacheKeyVariations()
    {
        return [
            $this->foo,
            $this->bar,
        ];
    }
}

在视图中渲染小部件

<?= MyCacheableWidget::widget([
    'foo' => $foo,
    'bar' => $bar,
]); ?>