ArrayCache.php

Go to the documentation of this file.

<?php
namespace Ubiquity\cache\system;
 
use Ubiquity\utils\base\UFileSystem;
use Ubiquity\exceptions\CacheException;
use Ubiquity\cache\CacheFile;
use Ubiquity\utils\base\UArray;
 
class ArrayCache extends AbstractDataCache {
 
    const PHP_TAG = "<?php\n";
 
    private $_fileMode;
 
    public function __construct($root, $postfix = '', $cacheParams = []) {
        parent::__construct($root, $postfix);
        $this->_fileMode = $cacheParams['fileMode'] ?? 0755;
    }
 
    public function init() {
        if (! is_dir($this->_root)) {
            \mkdir($this->_root, $this->_fileMode, true);
        }
    }
 
    public function exists($key) {
        return \file_exists($this->_getPath($key));
    }
 
    public function store($key, $code, $tag = null) {
        $content = $code;
        if (\is_array($code)) {
            $content = self::PHP_TAG . 'return ' . UArray::asPhpArray($code, 'array') . ";\n";
        }
        $path = $this->_getPath($key);
        $dir = pathinfo($path, PATHINFO_DIRNAME);
        if (UFileSystem::safeMkdir($dir)) {
            if (@\file_put_contents($path, $content, LOCK_EX) === false) {
                throw new CacheException("Unable to write cache file: {$path}");
            }
            if (@\chmod($path, $this->_fileMode) === false) {
                throw new CacheException("Unable to set permissions of cache file: {$path}");
            }
        } else {
            throw new CacheException("Unable to create folder : {$dir}");
        }
    }
 
    public function fetch($key) {
        return include ($this->_getPath($key));
    }
 
    public function file_get_contents($key) {
        return \file_get_contents($this->_getPath($key));
    }
 
    public function getTimestamp($key) {
        return \filemtime($this->_getPath($key));
    }
 
    private function _getPath($key) {
        return $this->_root . $key . $this->postfix . '.php';
    }
 
    public function remove($key) {
        $file = $this->_getPath($key);
        if (\file_exists($file))
            return \unlink($file);
        return false;
    }
 
    public function clear($matches = "") {
        $files = glob($this->_root . $matches . '*');
        foreach ($files as $file) {
            if (\is_file($file))
                \unlink($file);
        }
    }
 
    public function getCacheFiles($type) {
        return CacheFile::initFromFiles($this->_root . $type, \ucfirst($type), function ($file) {
            $path = UFileSystem::relativePath(dirname($file), $this->_root);
            $file = \basename($file);
            return $path . \DS . substr($file, 0, strpos($file, $this->postfix . '.php'));
        });
    }
 
    public function clearCache($type) {
        CacheFile::delete($this->_root . \strtolower($type));
    }
 
    public function getCacheInfo() {
        $result = parent::getCacheInfo();
        $result .= "\nRoot cache directory is <b>" . UFileSystem::cleanPathname($this->_root) . "</b>.";
        return $result;
    }
 
    public function getEntryKey($key) {
        return UFileSystem::cleanFilePathname($this->_getPath($key));
    }
 
    public function setRoot($root) {
        $this->_root = rtrim($root, \DS) . \DS;
    }
}