class.ilSettingsFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSettingsFactory
{
    protected ilDBInterface $db;

    public function __construct(\ilDBInterface $db)
    {
        $this->db = $db;
    }

    public function settingsFor(string $a_module = "common"): ilSetting
    {
        // @todo: this function contains some open review issues which might be addressed by rklees.
        $tmp_dic = $GLOBALS["DIC"] ?? null;//PHP8Review: This may not be a critical Global but i still would recommend to use a global call here or even better to integrate it into the classes attributes
        try {
            // ilSetting pulls the database once in the constructor, we force it to
            // use ours.
            $DIC = new ILIAS\DI\Container();
            $DIC["ilDB"] = $this->db;
            $DIC["ilBench"] = null;
            $GLOBALS["DIC"] = $DIC;//PHP8Review: This may not be a critical Global but i still would recommend to use a global call here

            // Always load from db, as caching could be implemented as a
            // decorator to this.
            $settings = new ilSetting($a_module, true);

            // Provoke a setting to populate the value_type in ilSettings,
            // use a field that is likely to exist.
            // ... code was strange in < ILIAS 8 (wrong parameter count, module name for keyword, ...)
            // use dummy instead
            $settings->set(
                "dummy",
                $settings->get("dummy", "dummy")
            );
        } finally {
            $GLOBALS["DIC"] = $tmp_dic;//PHP8Review: This may not be a critical Global but i still would recommend to use a global call here
        }

        return $settings;
    }
}