configuration.php

Go to the documentation of this file.

<?php
function elgg_get_site_url($site_guid = 0) {
    return _elgg_services()->config->getSiteUrl($site_guid);
}

function elgg_get_plugins_path() {
    return _elgg_services()->config->getPluginsPath();
}

function elgg_get_data_path() {
    return _elgg_services()->config->getDataPath();
}

function elgg_get_root_path() {
    return _elgg_services()->config->getRootPath();
}

function elgg_get_config($name, $site_guid = 0) {
    return _elgg_services()->config->get($name, $site_guid);
}

function elgg_set_config($name, $value) {
    return _elgg_services()->config->set($name, $value);
}

function elgg_save_config($name, $value, $site_guid = 0) {
    return _elgg_services()->config->save($name, $value, $site_guid);
}

function datalist_get($name) {
    return _elgg_services()->datalist->get($name);
}

function datalist_set($name, $value) {
    return _elgg_services()->datalist->set($name, $value);
}

function run_function_once($functionname, $timelastupdatedcheck = 0) {
    return _elgg_services()->datalist->runFunctionOnce($functionname, $timelastupdatedcheck);
}

function unset_config($name, $site_guid = 0) {
    return _elgg_services()->configTable->remove($name, $site_guid);
}

function set_config($name, $value, $site_guid = 0) {
    return _elgg_services()->configTable->set($name, $value, $site_guid);
}

function get_config($name, $site_guid = 0) {
    return _elgg_services()->configTable->get($name, $site_guid);
}

function _elgg_load_site_config() {
    global $CONFIG;

    $CONFIG->site_guid = (int) datalist_get('default_site');
    $CONFIG->site_id = $CONFIG->site_guid;
    $CONFIG->site = _elgg_services()->entityTable->get($CONFIG->site_guid, 'site');
    if (!$CONFIG->site) {
        throw new \InstallationException("Unable to handle this request. This site is not configured or the database is down.");
    }

    $CONFIG->wwwroot = $CONFIG->site->url;
    $CONFIG->sitename = $CONFIG->site->name;
    $CONFIG->sitedescription = $CONFIG->site->description;
    $CONFIG->siteemail = $CONFIG->site->email;
    $CONFIG->url = $CONFIG->wwwroot;

    _elgg_services()->configTable->loadAll();

    // gives hint to elgg_get_config function how to approach missing values
    $CONFIG->site_config_loaded = true;

    if (!empty($CONFIG->debug)) {
        _elgg_services()->logger->setLevel($CONFIG->debug);
        _elgg_services()->logger->setDisplay(true);
    }
}

function _elgg_load_application_config() {
    global $CONFIG;

    $install_root = str_replace("\\", "/", dirname(dirname(dirname(__FILE__))));
    $defaults = array(
        'path' => "$install_root/",
        'view_path' => "$install_root/views/",
        'plugins_path' => "$install_root/mod/",
        'language' => 'en',

        // compatibility with old names for plugins not using elgg_get_config()
        'viewpath' => "$install_root/views/",
        'pluginspath' => "$install_root/mod/",
    );

    foreach ($defaults as $name => $value) {
        if (empty($CONFIG->$name)) {
            $CONFIG->$name = $value;
        }
    }

    // set cookie values for session and remember me
    if (!isset($CONFIG->cookies)) {
        $CONFIG->cookies = array();
    }
    if (!isset($CONFIG->cookies['session'])) {
        $CONFIG->cookies['session'] = array();
    }
    $session_defaults = session_get_cookie_params();
    $session_defaults['name'] = 'Elgg';
    $CONFIG->cookies['session'] = array_merge($session_defaults, $CONFIG->cookies['session']);
    if (!isset($CONFIG->cookies['remember_me'])) {
        $CONFIG->cookies['remember_me'] = array();
    }
    $session_defaults['name'] = 'elggperm';
    $session_defaults['expire'] = strtotime("+30 days");
    $CONFIG->cookies['remember_me'] = array_merge($session_defaults, $CONFIG->cookies['remember_me']);

    if (!is_memcache_available()) {
        _elgg_services()->datalist->loadAll();
    }

    // allow sites to set dataroot and simplecache_enabled in settings.php
    if (isset($CONFIG->dataroot)) {
        $CONFIG->dataroot = sanitise_filepath($CONFIG->dataroot);
        $CONFIG->dataroot_in_settings = true;
    } else {
        $dataroot = datalist_get('dataroot');
        if (!empty($dataroot)) {
            $CONFIG->dataroot = $dataroot;
        }
        $CONFIG->dataroot_in_settings = false;
    }
    if (isset($CONFIG->simplecache_enabled)) {
        $CONFIG->simplecache_enabled_in_settings = true;
    } else {
        $simplecache_enabled = datalist_get('simplecache_enabled');
        if ($simplecache_enabled !== false) {
            $CONFIG->simplecache_enabled = $simplecache_enabled;
        } else {
            $CONFIG->simplecache_enabled = 1;
        }
        $CONFIG->simplecache_enabled_in_settings = false;
    }

    $system_cache_enabled = datalist_get('system_cache_enabled');
    if ($system_cache_enabled !== false) {
        $CONFIG->system_cache_enabled = $system_cache_enabled;
    } else {
        $CONFIG->system_cache_enabled = 1;
    }

    // needs to be set before system, init for links in html head
    $CONFIG->lastcache = (int)datalist_get("simplecache_lastupdate");

    $CONFIG->i18n_loaded_from_cache = false;

    // this must be synced with the enum for the entities table
    $CONFIG->entity_types = array('group', 'object', 'site', 'user');
}

function _elgg_config_test($hook, $type, $tests) {
    global $CONFIG;
    $tests[] = "{$CONFIG->path}engine/tests/ElggCoreConfigTest.php";
    return $tests;
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $hooks->registerHandler('unit_test', 'system', '_elgg_config_test');
};