SystemCache.php

Go to the documentation of this file.

<?php
namespace Elgg\Cache;

use Elgg\Profilable;
use Elgg\Config;
use ElggFileCache;
use Elgg\Database\Datalist;

class SystemCache {
    use Profilable;

    private $config;

    private $cache;

    private $datalist;

    public function __construct(ElggFileCache $cache, Config $config, Datalist $datalist) {
        $this->cache = $cache;
        $this->config = $config;
        $this->datalist = $datalist;
    }

    function reset() {
        $this->cache->clear();
    }
    
    function save($type, $data) {
        if ($this->isEnabled()) {
            return $this->cache->save($type, $data);
        }
    
        return false;
    }
    
    function load($type) {
        if ($this->isEnabled()) {
            $cached_data = $this->cache->load($type);
            if ($cached_data) {
                return $cached_data;
            }
        }
    
        return null;
    }
    
    function isEnabled() {
        return (bool)$this->config->getVolatile('system_cache_enabled');
    }
    
    function enable() {
        $this->datalist->set('system_cache_enabled', 1);
        $this->config->set('system_cache_enabled', 1);
        $this->reset();
    }
    
    function disable() {
        $this->datalist->set('system_cache_enabled', 0);
        $this->config->set('system_cache_enabled', 0);
        $this->reset();
    }
    
    function loadAll() {
        if ($this->timer) {
            $this->timer->begin([__METHOD__]);
        }

        $this->config->set('system_cache_loaded', false);

        if (!_elgg_services()->views->configureFromCache($this)) {
            return;
        }

        $data = $this->load('view_types');
        if (!is_string($data)) {
            return;
        }
        $GLOBALS['_ELGG']->view_types = unserialize($data);

        // Note: We don't need view_overrides for operation. Inspector can pull this from the cache

        $this->config->set('system_cache_loaded', true);

        if ($this->timer) {
            $this->timer->end([__METHOD__]);
        }
    }
    
    function init() {
        if (!$this->isEnabled()) {
            return;
        }

        // cache system data if enabled and not loaded
        if (!$this->config->getVolatile('system_cache_loaded')) {
            $this->save('view_types', serialize($GLOBALS['_ELGG']->view_types));

            _elgg_services()->views->cacheConfiguration($this);
        }
    
        if (!$GLOBALS['_ELGG']->i18n_loaded_from_cache) {

            _elgg_services()->translator->reloadAllTranslations();

            foreach ($GLOBALS['_ELGG']->translations as $lang => $map) {
                $this->save("$lang.lang", serialize($map));
            }
        }
    }
}