configuration.php

Go to the documentation of this file.

<?php
use Elgg\Exceptions\Exception as ElggException;
use Elgg\Project\Paths;

function elgg_get_site_url(): string {
    return _elgg_services()->config->wwwroot;
}

function elgg_get_plugins_path(): string {
    return _elgg_services()->config->plugins_path;
}

function elgg_get_data_path(): string {
    return _elgg_services()->config->dataroot;
}

function elgg_get_cache_path(): string {
    return _elgg_services()->config->cacheroot;
}

function elgg_get_asset_path(): string {
    return _elgg_services()->config->assetroot;
}

function elgg_get_root_path(): string {
    return Paths::project();
}

function elgg_sanitize_path(string $path, bool $append_slash = true): string {
    return Paths::sanitize($path, $append_slash);
}

function elgg_get_release(): string {
    static $release;
    
    if (!isset($release)) {
        $composerJson = file_get_contents(\Elgg\Project\Paths::elgg() . 'composer.json');
        if ($composerJson === false) {
            throw new ElggException('Unable to read composer.json file!');
        }
        
        $composer = json_decode($composerJson);
        if ($composer === null) {
            throw new ElggException('JSON parse error while reading composer.json!');
        }
        
        // Human-friendly version name
        if (!isset($composer->version)) {
            throw new ElggException('Version field must be set in composer.json!');
        }
        
        $release = $composer->version;
    }
    
    return $release;
}

function elgg_get_config(string $name, $default = null) {
    if (!_elgg_services()->config->hasValue($name)) {
        _elgg_services()->logger->info("Config value for '{$name}' is not set");
        return $default;
    }

    return _elgg_services()->config->$name;
}

function elgg_set_config(string $name, $value): void {
    _elgg_services()->config->$name = $value;
}

function elgg_save_config(string $name, $value): bool {
    return _elgg_services()->config->save($name, $value);
}

function elgg_remove_config(string $name): bool {
    return _elgg_services()->config->remove($name);
}

function elgg_get_icon_sizes(?string $entity_type = null, ?string $entity_subtype = null, $type = 'icon'): array {
    return _elgg_services()->iconService->getSizes($entity_type, $entity_subtype, $type);
}

function elgg_comments_are_latest_first(?\ElggEntity $container = null): bool {
    $params = [
        'entity' => $container,
    ];
    return (bool) elgg_trigger_event_results('config', 'comments_latest_first', $params, (bool) _elgg_services()->config->comments_latest_first);
}

function elgg_comments_per_page(?\ElggEntity $container = null): int {
    $params = [
        'entity' => $container,
    ];
    return (int) elgg_trigger_event_results('config', 'comments_per_page', $params, _elgg_services()->config->comments_per_page);
}