FragmentCache::begin() - Code Metrics - Inspection of "Adjust to widget changes" - yiisoft/yii-widgets - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 99f331...02d9ba )

by Alexander

created 2020-11-30 23:35 UTC

FragmentCache::begin() A

↳ Parent: FragmentCache

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	7
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	0
dl	0
loc	9
ccs	7
cts	7
cp	1
crap	3
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Widgets;

use function array_merge;
use function ob_get_clean;
use function ob_implicit_flush;
use function ob_start;
use Yiisoft\Cache\CacheInterface;
use Yiisoft\Cache\Dependency\Dependency;

use Yiisoft\View\DynamicContentAwareInterface;
use Yiisoft\View\DynamicContentAwareTrait;
use Yiisoft\View\WebView;
use Yiisoft\Widget\Widget;

final class FragmentCache extends Widget implements DynamicContentAwareInterface
{
    use DynamicContentAwareTrait;

    private string $id;
    private CacheInterface $cache;
    private int $duration = 60;
    private ?Dependency $dependency = null;
    private $variations;
    private ?string $content = null;

    private WebView $webView;

    public function __construct(CacheInterface $cache, WebView $webview)
    {
        $this->cache = $cache;
        $this->webView = $webview;
    }

    /**
     * Initializes the FragmentCache object.
     */
    public function begin(): ?string
    {
        parent::begin();
        if ($this->getCachedContent() === null) {
            $this->webView->pushDynamicContent($this);
            ob_start();
            PHP_VERSION_ID >= 80000 ? ob_implicit_flush(false) : ob_implicit_flush(0);
            PHP_VERSION_ID >= 80000 ? ob_implicit_flush(/** @scrutinizer ignore-type */ false) : ob_implicit_flush(0);
        }
        return null;
    }

    /**
     * Marks the end of content to be cached.
     *
     * Content displayed before this method call and after {@see init()} will be captured and saved in cache.
     *
     * This method does nothing if valid content is already found in cache.
     *
     * @return string the result of widget execution to be outputted.
     */
    public function run(): string
    {
        $content = $this->getCachedContent();

        if ($content !== null) {
            return $content;
        }

        $this->webView->popDynamicContent();

        $content = ob_get_clean();

        if ($content === false || $content === '') {
            return '';
        }

        $data = [$content, $this->getDynamicPlaceholders()];

        $this->cache->set($this->calculateKey(), $data, $this->duration, $this->dependency);

        return $this->updateDynamicContent($content, $this->getDynamicPlaceholders());
    }

    /**
     * Returns the cached content if available.
     *
     * @return string|null the cached content. False is returned if valid content is not found in the cache.
     */
    public function getCachedContent(): ?string
    {
        $key = $this->calculateKey();

        if (!$this->cache->has($key)) {
            return null;
        }

        $data = $this->cache->get($key);

        [$this->content, $placeholders] = $data;

        $this->content = $this->updateDynamicContent($this->content, $placeholders, true);
        $this->content = $this->updateDynamicContent(/** @scrutinizer ignore-type */ $this->content, $placeholders, true);

        return $this->content;
    }

    /**
     * Generates a unique key used for storing the content in cache.
     *
     * The key generated depends on both {@see id} and {@see variations}.
     *
     * @return mixed a valid cache key
     */
    public function calculateKey()
    {
        $key = array_merge([__CLASS__, $this->id], (array) $this->variations);

        $jsonKey = json_encode($key);

        return md5($jsonKey);
    }

    /**
     * @param Dependency|null $value the dependency that the cached content depends on.
     *
     * This can be either a {@see Dependency} object or a configuration array for creating the dependency object.
     *
     * Would make the output cache depends on the last modified time of all posts. If any post has its modification time
     * changed, the cached content would be invalidated.
     *
     * @return $this
     */
    public function dependency(?Dependency $value): self
    {
        $this->dependency = $value;

        return $this;
    }

    /**
     * @param int $value number of seconds that the data can remain valid in cache.
     *
     * @return $this
     */
    public function duration(int $value): self
    {
        $this->duration = $value;

        return $this;
    }

    public function id(string $value): self
    {
        $this->id = $value;

        return $this;
    }

    /**
     * @param array|string $value list of factors that would cause the variation of the content being cached.
     *
     * Each factor is a string representing a variation (e.g. the language, a GET parameter). The following variation
     * setting will cause the content to be cached in different versions according to the current application language:
     *
     * @return $this
     */
    public function variations($value): self
    {
        $this->variations = $value;

        return $this;
    }

    protected function getView(): WebView
    {
        return $this->webView;
    }
}


yiisoft / yii-widgets

Push — master ( 99f331...02d9ba )

FragmentCache::begin() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like