class.ilSetting.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilSetting implements \ILIAS\Administration\Setting
{
    protected ilDBInterface $db;

    private static array $settings_cache = array();

    private static ?string $value_type = null;
    public array $setting = array();
    public string $module = "";
    protected bool $cache_disabled = false;

    public function __construct(
        string $a_module = "common",
        bool $a_disabled_cache = false
    ) {
        global $DIC;

        $this->db = $DIC->database();
        $ilDB = $DIC->database();

        $this->cache_disabled = $a_disabled_cache;
        $this->module = $a_module;
        // check whether ini file object exists
        if (!is_object($ilDB)) {
            die("Fatal Error: ilSettings object instantiated without DB initialisation.");
        }
        $this->read();
    }

    public function getModule(): string
    {
        return $this->module;
    }

    public function read(): void
    {
        $ilDB = $this->db;

        // get the settings from the cache if they exist.
        // The setting array of the class is a reference to the cache.
        // So changing settings in one instance will change them in all.
        // This is the same behaviour as if the are read from the DB.
        if (!$this->cache_disabled) {
            if (isset(self::$settings_cache[$this->module])) {
                $this->setting = &self::$settings_cache[$this->module];
                return;
            } else {
                $this->setting = array();
                self::$settings_cache[$this->module] = &$this->setting;
            }
        }

        $query = "SELECT * FROM settings WHERE module=" . $ilDB->quote($this->module, "text");
        $res = $ilDB->query($query);

        while ($row = $ilDB->fetchAssoc($res)) {
            $this->setting[$row["keyword"]] = $row["value"];
        }
    }

    public function get(
        string $a_keyword,
        ?string $a_default_value = null
    ): ?string {
        return $this->setting[$a_keyword] ?? $a_default_value;
    }

    public function deleteAll(): void
    {
        $ilDB = $this->db;

        $query = "DELETE FROM settings WHERE module = " . $ilDB->quote($this->module, "text");
        $ilDB->manipulate($query);

        $this->setting = array();
    }

    public function deleteLike(string $a_like): void
    {
        $ilDB = $this->db;

        $query = "SELECT keyword FROM settings" .
            " WHERE module = " . $ilDB->quote($this->module, "text") .
            " AND " . $ilDB->like("keyword", "text", $a_like);
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $this->delete($row["keyword"]);
        }
    }

    public function delete(string $a_keyword): void
    {
        $ilDB = $this->db;

        $ilDB->manipulate("DELETE FROM settings WHERE keyword = " .
            $ilDB->quote($a_keyword, "text") . " AND module = " .
            $ilDB->quote($this->module, "text"));

        unset($this->setting[$a_keyword]);
    }

    public function getAll(): array
    {
        return $this->setting;
    }

    public function set(string $a_key, string $a_val): void
    {
        $ilDB = $this->db;

        $this->delete($a_key);

        if (!isset(self::$value_type)) {
            self::$value_type = self::_getValueType();
        }

        if (self::$value_type === 'text' && strlen($a_val) >= 4000) {
            global $DIC;
            $DIC->ui()->mainTemplate()->setOnScreenMessage('failure', $DIC->language()->txt('setting_value_truncated'), true);
            $a_val = substr($a_val, 0, 4000);
        }

        $ilDB->insert("settings", array(
            "module" => array("text", $this->module),
            "keyword" => array("text", $a_key),
            "value" => array(self::$value_type, $a_val)));

        $this->setting[$a_key] = $a_val;
    }

    public function setScormDebug(string $a_key, string $a_val): void
    {
        $ilDB = $this->db;
        if ($a_val !== "1") {
            $ilDB->query("UPDATE sahs_lm SET debug = 'n'");
        }
        $this->set($a_key, $a_val);
    }

    public static function _lookupValue(
        string $a_module,
        string $a_keyword
    ): ?string {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "SELECT value FROM settings WHERE module = %s AND keyword = %s";
        $res = $ilDB->queryF($query, array('text', 'text'), array($a_module, $a_keyword));
        $data = $ilDB->fetchAssoc($res);
        return $data['value'] ?? null;
    }

    public static function _getValueType(): string
    {
        $analyzer = new ilDBAnalyzer();
        $info = $analyzer->getFieldInformation('settings');

        if ($info['value']['type'] === 'clob') {
            return 'clob';
        } else {
            return 'text';
        }
    }

    public static function _changeValueType(
        string $a_new_type = 'text'
    ): bool {
        global $DIC;

        $ilDB = $DIC->database();

        $old_type = self::_getValueType();

        if ($a_new_type === $old_type) {
            return false;
        }
        if ($a_new_type === 'clob') {
            $ilDB->addTableColumn(
                'settings',
                'value2',
                array(  "type" => "clob",
                                    "notnull" => false,
                                    "default" => null)
            );

            $ilDB->query("UPDATE settings SET value2 = value");
            $ilDB->dropTableColumn('settings', 'value');
            $ilDB->renameTableColumn('settings', 'value2', 'value');

            return true;
        }
        if ($a_new_type === 'text') {
            $ilDB->addTableColumn(
                'settings',
                'value2',
                array(  "type" => "text",
                                    "length" => 4000,
                                    "notnull" => false,
                                    "default" => null)
            );

            $ilDB->query("UPDATE settings SET value2 = value");
            $ilDB->dropTableColumn('settings', 'value');
            $ilDB->renameTableColumn('settings', 'value2', 'value');

            return true;
        }
        return false;
    }


    public static function _getLongerSettings(
        int $a_limit = 4000
    ): array {
        global $DIC;

        $ilDB = $DIC->database();

        $settings = array();

        $query = "SELECT * FROM settings WHERE LENGTH(value) > "
            . $ilDB->quote($a_limit, 'integer');

        $result = $ilDB->query($query);

        while ($row = $ilDB->fetchAssoc($result)) {
            $settings[] = $row;
        }

        return $settings;
    }
}