dukt\facebook\services\Cache

Complexity

Total Complexity

8

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	set()	0	15	4
A	get()	0	6	2
A	getCacheKey()	0	11	1
A	_formatDuration()	0	5	1

<?php
/**
 * @link      https://dukt.net/facebook/
 * @copyright Copyright (c) Dukt
 * @license   https://github.com/dukt/facebook/blob/master/LICENSE.md
 */

namespace dukt\facebook\services;

use Craft;
use yii\base\Component;
use DateInterval;
use dukt\facebook\Plugin as Facebook;


/**
 * Class Cache service
 *
 * @author Dukt <support@dukt.net>
 * @since  2.0
 */
class Cache extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Retrieves a value from cache with a specified key.
     *
     * @param $id
     *
     * @return mixed
     */
    public function get($id)
    {
        if (Facebook::$plugin->getSettings()->enableCache == true) {
            $cacheKey = $this->getCacheKey($id);

            return Craft::$app->cache->get($cacheKey);
        }
    }

    /**
     * Stores a value identified by a key into cache.
     *
     * @param      $id
     * @param      $value
     * @param null $expire

Are you sure the doc-type for parameter $expire is correct as it would always require null to be passed?

     * @param null $dependency

Are you sure the doc-type for parameter $dependency is correct as it would always require null to be passed?

     * @param null $enableCache

Are you sure the doc-type for parameter $enableCache is correct as it would always require null to be passed?

     *
     * @return bool
     * @throws \Exception
     */
    public function set($id, $value, $expire = null, $dependency = null, $enableCache = null)
    {
        if (is_null($enableCache)) {

The condition is_null($enableCache) is always true.

            $enableCache = Facebook::$plugin->getSettings()->enableCache;
        }

        if ($enableCache) {
            $cacheKey = $this->getCacheKey($id);

            if (!$expire) {

$expire is of type null, thus it always evaluated to false.

                $expire = Facebook::$plugin->getSettings()->cacheDuration;
                $expire = $this->_formatDuration($expire);
            }

            return Craft::$app->cache->set($cacheKey, $value, $expire, $dependency);

$expire of type string is incompatible with the type integer expected by parameter $duration of yii\caching\CacheInterface::set().

        }
    }

    // Private Methods
    // =========================================================================
    /**
     * Formats duration.
     *
     * @param        $cacheDuration
     *
     * @return string
     * @throws \Exception
     */
    private function _formatDuration($cacheDuration, string $format = '%s')
    {
        $cacheDuration = new DateInterval($cacheDuration);

        return $cacheDuration->format($format);
    }

    /**
     * Return the cache key.
     *
     * @param array $request
     *
     * @return string
     */
    private function getCacheKey(array $request)
    {
        $dataSourceClassName = 'Facebook';

        unset($request['CRAFT_CSRF_TOKEN']);

        $request[] = $dataSourceClassName;

        $hash = md5(serialize($request));

        return 'facebook.'.$hash;
    }
}