dukt / analytics

src/services/Cache.php

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

namespace dukt\analytics\services;

use Craft;
use craft\helpers\DateTimeHelper;
use yii\base\Component;
use dukt\analytics\Plugin as Analytics;

This use statement conflicts with another class in this namespace, dukt\analytics\services\Analytics. Consider defining an alias.

use DateInterval;

class Cache extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Get cache
     *
     * @param $id
     *
     * @return mixed
     */
    public function get($id)
    {
        if (Analytics::$plugin->getSettings()->enableCache == true) {
            $cacheKey = $this->getCacheKey($id);

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

        return null;
    }

    /**
     * Set 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 mixed
     * @throws \Exception
     */
    public function set($id, $value, $expire = null, $dependency = null, $enableCache = null)
    {
        if (null === $enableCache) {

The condition null === $enableCache is always true.

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

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

            if (!$expire) {

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

                $expire = $this->getCacheDuration();
            }

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

        return null;
    }

    /**
     * Deletes a value with the specified key from cache.
     *
     * @param string $id The key of the value to be deleted.
     *
     * @return bool If no error happens during deletion.
     */
    public function delete($id)
    {
        $cacheKey = $this->getCacheKey($id);

$id of type string is incompatible with the type array expected by parameter $request of dukt\analytics\services\Cache::getCacheKey().

        return Craft::$app->getCache()->delete($cacheKey);
    }

    // Private Methods
    // =========================================================================

    /**
     * Get cache duration (in seconds)
     *
     * @return int
     * @throws \Exception
     */
    private function getCacheDuration()
    {
        $duration = Analytics::$plugin->getSettings()->cacheDuration;

        return DateTimeHelper::intervalToSeconds(new DateInterval($duration));
    }

    /**
     * Get cache key
     *
     * @param array $request
     *
     * @return string
     */
    private function getCacheKey(array $request)
    {
        $dataSourceClassName = 'GoogleAnalytics';

        unset($request['CRAFT_CSRF_TOKEN']);

        $request[] = $dataSourceClassName;

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

        $cacheKey = 'analytics.'.$hash;

        return $cacheKey;
    }
}