cache.php

Go to the documentation of this file.

<?php
/* Filepath Cache */

function elgg_get_system_cache() {
    return _elgg_services()->fileCache;
}

function elgg_reset_system_cache() {
    _elgg_services()->systemCache->reset();
}

function elgg_save_system_cache($type, $data) {
    return _elgg_services()->systemCache->save($type, $data);
}

function elgg_load_system_cache($type) {
    return _elgg_services()->systemCache->load($type);
}

function elgg_is_system_cache_enabled() {
    return _elgg_services()->systemCache->isEnabled();
}

function elgg_enable_system_cache() {
    _elgg_services()->systemCache->enable();
}

function elgg_disable_system_cache() {
    _elgg_services()->systemCache->disable();
}

/* Simplecache */

function elgg_register_simplecache_view($view_name) {
    _elgg_services()->simpleCache->registerView($view_name);
}

function elgg_get_simplecache_url($view, $subview = '') {
    return _elgg_services()->simpleCache->getUrl($view, $subview);
}

function elgg_is_simplecache_enabled() {
    return _elgg_services()->simpleCache->isEnabled();
}

function elgg_enable_simplecache() {
    _elgg_services()->simpleCache->enable();
}

function elgg_disable_simplecache() {
    _elgg_services()->simpleCache->disable();
}

function _elgg_rmdir($dir, $empty = false) {
    if (!$dir) {
        // realpath can return false
        _elgg_services()->logger->warn(__FUNCTION__ . ' called with empty $dir');
        return true;
    }
    $files = array_diff(scandir($dir), array('.', '..'));
    
    foreach ($files as $file) {
        if (is_dir("$dir/$file")) {
            _elgg_rmdir("$dir/$file");
        } else {
            unlink("$dir/$file");
        }
    }

    if ($empty) {
        return true;
    }
    
    return rmdir($dir);
}

function elgg_invalidate_simplecache() {
    _elgg_services()->simpleCache->invalidate();
}

function elgg_flush_caches() {
    _elgg_services()->events->trigger('cache:flush', 'system');
}

function _elgg_is_cache_symlinked() {
    $link = elgg_get_root_path() . 'cache/';
    $target = elgg_get_cache_path() . 'views_simplecache/';
    return is_dir($link) && realpath($target) == realpath($link);
}

function _elgg_invalidate_cache_for_entity($entity_guid) {
    _elgg_services()->entityCache->remove($entity_guid);
}

function _elgg_cache_init() {
    _elgg_services()->simpleCache->init();
    _elgg_services()->systemCache->init();
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('ready', 'system', '_elgg_cache_init');
    
    // register plugin hooks for cache reset
    $events->registerHandler('cache:flush', 'system', 'elgg_reset_system_cache');
    $events->registerHandler('cache:flush', 'system', 'elgg_invalidate_simplecache');
};