ViewCache::delete() - Code Metrics - Inspection of "149 View cache" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#178)

unknown

created 2024-11-28 09:58 UTC

ViewCache::delete() A

↳ Parent: ViewCache

Complexity

Conditions	2
Paths	2

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	3
c	1
b	0
f	0
nc	2
nop	2
dl	0
loc	5
rs	10

<?php

namespace Quantum\Libraries\ResourceCache;

use Quantum\Libraries\Storage\FileSystem;
use Quantum\Exceptions\DiException;
use ReflectionException;
use voku\helper\HtmlMin;
use Quantum\Di\Di;
use Exception;

class ViewCache
{
	/**
	 * @var string
	 */
	private $cacheDir;

	/**
	 * @var string
	 */
	private $mimeType = '.tmp';

	/**
	 * @var int
	 */
	private $ttl;

	/**
	 * @var object
	 */
	private $fs;

	/**
	 * @var ViewCache
	 */
	private static $instance = null;

	public static function getInstance(): ViewCache
	{
		if (self::$instance === null) {
			self::$instance = new self();
		}

		return self::$instance;
	}

	/**
	 * @throws DiException
	 * @throws ReflectionException
	 * @throws Exception
	 */
	public function __construct()
	{
		$this->fs = Di::get(FileSystem::class);

		if (!config()->has('view_cache')) {
			throw new Exception('The config "view_cache" does not exists.');
		}

		$this->cacheDir = $this->getCacheDir();

		$this->ttl = is_int(config()->get('view_cache.ttl')) ? config()->get('view_cache.ttl') : 300;

		if (!$this->fs->isDirectory($this->cacheDir)) {
			mkdir($this->cacheDir, 0777, true);
		}
	}

	/**
	 * @param string $key
	 * @param string $content
	 * @param string $sessionId
	 * @return ViewCache
	 */
	public function set(string $key, string $content, string $sessionId): ViewCache
	{
		if (config()->has('view_cache.minify')) {
			$content = $this->minify($content);
		}

		$cacheFile = $this->getCacheFile($key, $sessionId);
		$this->fs->put($cacheFile, $content);

		return $this;
	}

	/**
	 * @param string $key
	 * @param string $sessionId
	 * @param int $ttl
	 * @return mixed|null
	 */
	public function get(string $key, string $sessionId, int $ttl): ?string
	public function get(string $key, string $sessionId, /** @scrutinizer ignore-unused */ int $ttl): ?string
	{
		$cacheFile = $this->getCacheFile($key, $sessionId);
		if (!$this->fs->exists($cacheFile)) {
			return null;
		}

		return $this->fs->get($cacheFile);
	}

	/**
	 * @param string $key
	 * @param string $sessionId
	 * @return void
	 */
	public function delete(string $key, string $sessionId): void
	{
		$cacheFile = $this->getCacheFile($key, $sessionId);
		if ($this->fs->exists($cacheFile)) {
			$this->fs->remove($cacheFile);
		}
	}

	/**
	 * @param string $key
	 * @param string $sessionId
	 * @param int|null $ttl
	 * @return bool
	 */
	public function exists(string $key, string $sessionId, int $ttl = null): bool
	{
		if (!$ttl){
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$ttl = $this->ttl;
		}

		$cacheFile = $this->getCacheFile($key, $sessionId);

		if (!$this->fs->exists($cacheFile) || $this->isExpired($cacheFile, $ttl)) {
			return false;
		}

		return true;
	}

	/**
	 * @param $cacheFile
	 * @param int|null $ttl
	 * @return bool
	 */
	public function isExpired($cacheFile, int $ttl = null): bool
	{
		if (!$ttl){
0   == false // true
0   == null  // true
123 == false // false
123 == null  // false

// It is often better to use strict comparison
0 === false // false
0 === null  // false
			$ttl = $this->ttl;
		}

		if (time() > ($this->fs->lastModified($cacheFile) + $ttl)) {
			$this->fs->remove($cacheFile);
			return true;
		}

		return false;
	}

	/**
	 * @return bool
	 */
	public function isEnabled(): bool
	{
		return is_bool(config()->get('resource_cache')) ? config()->get('resource_cache') : false;

	}

	/**
	 * @return int
	 */
	public function getTtl(): int
	{
		return $this->ttl;
	}

	/**
	 * @return string
	 */
	private function getCacheDir(): string
	{
		$configCacheDir = config()->get('view_cache.cache_dir', 'cache');

		$cacheDir = base_dir() . DS . $configCacheDir . DS . 'views' . DS;

		if ($module = current_module()) {
			$cacheDir = base_dir() . DS . $configCacheDir . DS . 'views' . DS . strtolower($module) . DS;
		}

		return $cacheDir;
	}

	/**
	 * @param string $key
	 * @param string $sessionId
	 * @return string
	 */
	private function getCacheFile(string $key, string $sessionId): string
	{
		return $this->cacheDir . md5($key . $sessionId) . $this->mimeType;
	}

	/**
	 * @param string $content
	 * @return string
	 */
	private function minify(string $content): string
	{
		return (new HtmlMin())->minify($content);
	}
}

softberg / quantum-php-core

Pull Request — master (#178)

ViewCache::delete() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like