cache.php

Go to the documentation of this file.

<?php
function elgg_get_system_cache(): \ElggCache {
    return _elgg_services()->fileCache;
}

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

function elgg_save_system_cache($type, $data, int $expire_after = null): bool {
    return _elgg_services()->systemCache->save($type, $data, $expire_after);
}

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

function elgg_delete_system_cache($type): bool {
    return _elgg_services()->systemCache->delete($type);
}

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

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

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

/* Simplecache */

function elgg_register_simplecache_view($view_name): void {
    _elgg_services()->views->registerCacheableView($view_name);
}

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

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

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

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

function elgg_invalidate_caches(): void {
    // this event sequence could take while, make sure there is no timeout
    set_time_limit(0);
    
    _elgg_services()->config->save('lastcache', time());
    
    _elgg_services()->events->triggerSequence('cache:invalidate', 'system');
}

function elgg_clear_caches(): void {
    // this event sequence could take while, make sure there is no timeout
    set_time_limit(0);
    
    _elgg_services()->events->triggerSequence('cache:clear', 'system');
}

function elgg_purge_caches(): void {
    // this event sequence could take while, make sure there is no timeout
    set_time_limit(0);
    
    _elgg_services()->events->triggerSequence('cache:purge', 'system');
}

function _elgg_is_cache_symlinked(): bool {
    $root_path = elgg_get_root_path();

    $simplecache_path = elgg_get_asset_path();
    $symlink_path = "{$root_path}cache";

    if (!is_dir($simplecache_path)) {
        return false;
    }
    return is_dir($symlink_path) && realpath($simplecache_path) == realpath($symlink_path);
}

function _elgg_symlink_cache(): bool {

    if (_elgg_is_cache_symlinked()) {
        // Symlink exists, no need to proceed
        return true;
    }

    $root_path = elgg_get_root_path();
    $simplecache_path = rtrim(elgg_get_asset_path(), '/');
    $symlink_path = "{$root_path}cache";

    if (is_dir($symlink_path)) {
        // Cache directory already exists
        // We can not proceed without overwriting files
        return false;
    }

    if (!is_dir($simplecache_path)) {
        // Views simplecache directory has not yet been created
        mkdir($simplecache_path, 0755, true);
    }

    symlink($simplecache_path, $symlink_path);

    if (_elgg_is_cache_symlinked()) {
        return true;
    }

    if (is_dir($symlink_path)) {
        unlink($symlink_path);
    }
    
    return false;
}