luya\web\filters\ResponseCache

Complexity

Total Complexity

8

Size/Duplication

Total Lines	68
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	9	2
A	callActionCallable()	0	6	3
A	beforeAction()	0	15	3

<?php

namespace luya\web\filters;

use Yii;
use luya\traits\CacheableTrait;
use yii\filters\PageCache;

/**
 * Filter to enable Response Cache.
 *
 * Extends the {{yii\filters\PageCache}} class by using the {{luya\traits\CacheableTrait}} whether caching
 * is enabled or not. Thefore you can attach this page cache to any controller whether caching is enabled 
 * or not, it will not throw an exception
 *
 * @author Basil Suter <basil@nadar.io>
 * @since 1.0.0
 */
class ResponseCache extends PageCache
{
    use CacheableTrait;
    
    /**
     * @var array Define an array with the actions and a corresponding callable function. This will be called whether caching
     * is enabled or not or the response is loaded from the cache.
     *
     * ```php
     * 'actionsCallable' => ['get-posts' => function($result) {
     *     // do something whether is the response cached or not
     * });
     * ```
     * @deprecated Replaced in favor of {{beforeCacheResponse}} and {{afterRestoreResponse}}.
     */
    public $actionsCallable = [];
    
    /**
     * @var array
     * @deprecated Use {{$only}} or {{$except}} instead.
     */
    public $actions = [];
    
    /**
     * @inheritdoc
     */
    public function init()
    {
        parent::init();
        
        // support deprecated $actions property
        if (!empty($this->actions)) {

The property luya\web\filters\ResponseCache::$actions has been deprecated with message: Use {{$only}} or {{$except}} instead.

            $this->only = $this->actions;

The property luya\web\filters\ResponseCache::$actions has been deprecated with message: Use {{$only}} or {{$except}} instead.

        }
    }
    
    /**
     * call the action callable if available.
     *
     * @param string $action The action ID name
     * @param string $result The cahed or not cached action response, this is a string as its after the action filters.
     */
    private function callActionCallable($action, $result)
    {
        if (isset($this->actionsCallable[$action]) && is_callable($this->actionsCallable[$action])) {

The property luya\web\filters\ResponseCache::$actionsCallable has been deprecated with message: Replaced in favor of {{beforeCacheResponse}} and {{afterRestoreResponse}}.

            call_user_func($this->actionsCallable[$action], $result);

The property luya\web\filters\ResponseCache::$actionsCallable has been deprecated with message: Replaced in favor of {{beforeCacheResponse}} and {{afterRestoreResponse}}.

        }
    }
    
    /**
     * @inheritdoc
     */
    public function beforeAction($action)
    {
        if (!$this->isCachable()) {
            return true;
        }
        
        $result = parent::beforeAction($action);
        
        // support legacy property.
        if (!empty($this->actionsCallable)) {

The property luya\web\filters\ResponseCache::$actionsCallable has been deprecated with message: Replaced in favor of {{beforeCacheResponse}} and {{afterRestoreResponse}}.

            $this->callActionCallable($action->id, Yii::$app->response->content);
        }
        
        return $result;
    }
}