ilSettingsFactory Class Reference

A factory that builds ilSettings that can be used for DI. More...

Collaboration diagram for ilSettingsFactory:

Public Member Functions
	__construct (\ilDBInterface $db)
	settingsFor (string $a_module="common")
	Get setting instance for module. More...

Protected Attributes
ilDBInterface	$db

Detailed Description

A factory that builds ilSettings that can be used for DI.

Author

Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 26 of file class.ilSettingsFactory.php.

Constructor & Destructor Documentation

__construct()

ilSettingsFactory::__construct

(

\ilDBInterface

$db

)

Definition at line 30 of file class.ilSettingsFactory.php.

References $db.

    {
        $this->db = $db;
    }

Member Function Documentation

settingsFor()

ilSettingsFactory::settingsFor

(

string

$a_module = "common"

)

Get setting instance for module.

Definition at line 38 of file class.ilSettingsFactory.php.

References $db, $DIC, $GLOBALS, and null.

                                                            : 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;
    }

Field Documentation

$db

ilDBInterface ilSettingsFactory::$db

protected

Definition at line 28 of file class.ilSettingsFactory.php.

Referenced by __construct(), and settingsFor().

---

The documentation for this class was generated from the following file:

• components/ILIAS/Administration/classes/class.ilSettingsFactory.php