QueryCache.php

Go to the documentation of this file.

<?php

namespace Elgg\Cache;

use Elgg\Traits\Loggable;

class QueryCache extends LRUCache {
    
    use Loggable;
    
    protected $config_disabled = false;

    protected $runtime_enabled = false;
    
    public function __construct(int $size = 50, bool $config_disabled = false) {
        
        $this->config_disabled = $config_disabled;
        
        parent::__construct($size);
    }
    
    public function enable() {
        $this->runtime_enabled = true;
    }
    
    public function disable(bool $clear = true) {
        $this->runtime_enabled = false;
        
        if ($clear) {
            $this->clear();
        }
    }
    
    public function isEnabled() {
        if ($this->config_disabled) {
            return false;
        }
        
        return $this->runtime_enabled;
    }
    
    public function clear() {
        parent::clear();
        
        $this->getLogger()->info('Query cache invalidated');
    }
    
    public function get($key, $default = null) {
        if (!$this->isEnabled()) {
            return $default;
        }
        
        $result = parent::get($key, $default);
        
        $this->getLogger()->info("DB query results returned from cache (hash: {$key})");
        
        return $result;
    }
    
    public function set($key, $value) {
        if (!$this->isEnabled()) {
            return;
        }
        
        parent::set($key, $value);
        
        $this->getLogger()->info("DB query results cached (hash: {$key})");
    }
    
    public function getHash(string $sql, array $params = [], string $extras = '') {
        $query_id = $sql . '|';
        if (!empty($params)) {
            $query_id .= serialize($params) . '|';
        }
        
        $query_id .= $extras;

        // MD5 yields smaller mem usage for cache and cleaner logs
        return md5($query_id);
    }
}