Nip\Cache\Cacheable\CanCache

Complexity

Total Complexity

9

Size/Duplication

Total Lines	71
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

0%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	needsCaching()	0	7	2
A	checkSaveCache()	0	8	2
	generateCacheData()	0	1	?
A	getDataFromCache()	0	4	1
A	saveDataToCache()	0	5	1
A	dataCacheKey()	0	7	2
A	dataCacheTtl()	0	4	1

<?php

namespace Nip\Cache\Cacheable;

use DateInterval;
use Nip\Utility\Str;

/**
 * Trait CanCache
 * @package Nip\Cache\Cacheable
 */
trait CanCache
{
    use HasCacheStore;

    protected $needsCaching = false;

    /**
     * @param null $needCaching
     * @return bool
     */
    public function needsCaching($needCaching = null): bool
    {
        if (is_bool($needCaching)) {
            $this->needsCaching = $needCaching;
        }
        return $this->needsCaching;
    }

    protected function checkSaveCache()
    {
        if ($this->needsCaching() !== true) {
            return;
        }
        $data = $this->generateCacheData();
        $this->saveDataToCache($data);
    }

    abstract function generateCacheData();

It is generally recommended to explicitly declare the visibility for methods.

    /**
     * @param null $key
     * @return mixed|null
     * @throws \Psr\SimpleCache\InvalidArgumentException
     */
    protected function getDataFromCache($key = null)
    {
        return $this->cacheStore()->get($this->dataCacheKey($key));
    }

    /**
     * @param $data
     * @param null $key
     * @noinspection PhpDocMissingThrowsInspection
     */
    protected function saveDataToCache($data, $key = null)
    {
        /** @noinspection PhpUnhandledExceptionInspection */
        $this->cacheStore()->set($this->dataCacheKey($key), $data,$this->dataCacheTtl($key));
    }

    /**
     * @param $key
     * @return string
     */
    protected function dataCacheKey($key= null)
    {
        if ($key !== null) {
            return $key;
        }
        return Str::slug(__CLASS__);
    }

    /**
     * @param null $key
     * @return DateInterval
     */
    protected function dataCacheTtl($key= null)

The parameter $key is not used and could be removed.

    {
        return DateInterval::createFromDateString('10 years');
    }
}