App\Reuse\Controllers\Api\TFileCache

Complexity

Total Complexity

10

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getCachePath()	0	3	1
A	setCache()	0	6	1
A	getCacheFilename()	0	8	2
A	cacheExpired()	0	6	2
A	clearCache()	0	12	3
A	getCache()	0	3	1

<?php

namespace App\Reuse\Controllers\Api;

trait TFileCache
{

    protected $cacheTtl = 60 * 5;
    protected $cacheFilename = '';

    /**
     * return true if cache is expired
     *
     * @return boolean
     */
    protected function cacheExpired(): bool
    {
        $this->cacheFilename = $this->getCacheFilename();
        return (file_exists($this->cacheFilename) === false)
            ? true
            : filemtime($this->cacheFilename) < (time() - $this->cacheTtl);
    }

    /**
     * returns cache content
     *
     * @return string
     */
    protected function getCache(): string
    {
        return file_get_contents($this->cacheFilename);
    }

    /**
     * set cache content
     *
     * @param string $content
     * @return integer
     */
    protected function setCache(string $content): int
    {
        return file_put_contents(
            $this->cacheFilename,
            $content,
            LOCK_EX
        );
    }

    /**
     * clear cache dir
     *
     * @param bool $fromRequest
     * @return void
     */
    protected function clearCache(bool $fromRequest = false)
    {
        if ($fromRequest) {
            @unlink($this->getCacheFilename());

It seems like you do not handle an error condition for unlink(). This can introduce security issues, and is generally not recommended.

        } else {
            $fileList = array_filter(
                glob($this->getCachePath() . '*'),

It seems like glob($this->getCachePath() . '*') can also be of type false; however, parameter $input of array_filter() does only seem to accept array, maybe add an additional type check?

                'is_file'
            );
            $counter = count($fileList);
            for ($c = 0; $c < $counter; $c++) {
                unlink($fileList[$c]);
            }
        }
    }

    /**
     * returns cache filename from request uri
     *
     * @return string
     */
    protected function getCacheFilename(): string
    {
        $path = $this->getCachePath();
        if (!file_exists($path)) {
            mkdir($path);
        }
        $filename = md5($this->request->getUri());
        return $path . $filename;
    }

    /**
     * returns cache path from request script filename
     *
     * @return string
     */
    protected function getCachePath(): string
    {
        return dirname($this->request->getFilename()) . '/../cache/';
    }
}