ilSetting Class Reference

ILIAS Setting Class. More...

Inheritance diagram for ilSetting:

Collaboration diagram for ilSetting:

Public Member Functions
	__construct (string $a_module="common", bool $a_disabled_cache=false)
	getModule ()
	read ()
	get (string $a_keyword, ?string $a_default_value=null)
	get setting More...
	deleteAll ()
	deleteLike (string $a_like)
	delete (string $a_keyword)
	getAll ()
	set (string $a_key, string $a_val)
	setScormDebug (string $a_key, string $a_val)

Static Public Member Functions
static	_lookupValue (string $a_module, string $a_keyword)
static	_getValueType ()
	Get the type of the value column in the database. More...
static	_changeValueType (string $a_new_type='text')
	change the type of the value column in the database More...
static	_getLongerSettings (int $a_limit=4000)
	get a list of setting records with values loger than a limit More...

Data Fields
array	$setting = array()
string	$module = ""

Protected Attributes
ilDBInterface	$db
bool	$cache_disabled = false

Static Private Attributes
static array	$settings_cache = array()
	cache for the read settings ilSetting is instantiated more than once per request for some modules The cache avoids reading them from the DB with each instance More...
static string	$value_type = null
	the type of settings value field in database This is determined in the set method to get a correct DB insert Don't set the value type to force a detection at first access More...

Detailed Description

ILIAS Setting Class.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilSetting::__construct	(	string	$a_module = "common",
		bool	$a_disabled_cache = false
	)

Definition at line 47 of file class.ilSetting.php.

References $DIC, $ilDB, and read().

      {
        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();
    }

Here is the call graph for this function:

Member Function Documentation

_changeValueType()

static ilSetting::_changeValueType ( string  $a_new_type = 'text' )

static

change the type of the value column in the database

Parameters

string

$a_new_type

'text' or 'clob'

Returns

bool

Exceptions

ilDatabaseException

Definition at line 218 of file class.ilSetting.php.

References $DIC, $ilDB, and null.

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

_getLongerSettings()

static ilSetting::_getLongerSettings ( int  $a_limit = 4000 )

static

get a list of setting records with values loger than a limit

Definition at line 268 of file class.ilSetting.php.

References $DIC, and $ilDB.

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

_getValueType()

static ilSetting::_getValueType ( )

static

Get the type of the value column in the database.

Exceptions

ilDatabaseException

Definition at line 200 of file class.ilSetting.php.

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

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

_lookupValue()

static ilSetting::_lookupValue ( string  $a_module, string  $a_keyword  )

static

Implements ILIAS\Administration\Setting.

Definition at line 182 of file class.ilSetting.php.

References $data, $DIC, $ilDB, $res, and null.

Referenced by ilObjectAdditionalPropertiesLegacyRepository\areCustomIconsEnabled(), and ILIAS\BackgroundTasks\Task\Job\Manager\JobManagerImpl\runActiveJobs().

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

Here is the caller graph for this function:

delete()

ilSetting::delete

(

string

$a_keyword

)

Implements ILIAS\Administration\Setting.

Definition at line 129 of file class.ilSetting.php.

References $db, and $ilDB.

Referenced by ilCertificateScormTemplateDeleteAction\delete(), and ilObjNotificationAdminGUI\saveOSDSettings().

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

Here is the caller graph for this function:

deleteAll()

ilSetting::deleteAll

(

)

Implements ILIAS\Administration\Setting.

Definition at line 106 of file class.ilSetting.php.

References $db, and $ilDB.

                               : void
    {
        $ilDB = $this->db;

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

        $this->setting = array();
    }

deleteLike()

ilSetting::deleteLike

(

string

$a_like

)

Definition at line 116 of file class.ilSetting.php.

References $db, $ilDB, and $res.

                                              : 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"]);
        }
    }

get()

ilSetting::get	(	string	$a_keyword,
		?string	$a_default_value = null
	)

get setting

Implements ILIAS\Administration\Setting.

Definition at line 99 of file class.ilSetting.php.

Referenced by ilObjAdvancedEditing\_getUsedHTMLTags(), ilNusoapUserAdministrationAdapter\enableWSDL(), ilCleanCOPageHistoryCronjob\getCronDays(), ILIAS\Style\Content\Object\ObjectManager\getEffectiveStyleId(), ilCleanCOPageHistoryCronjob\getKeepEntries(), ILIAS\Awareness\WidgetManager\getListData(), ilLMTOCExplorerGUI\getNodeIcon(), ILIAS\Style\Content\Object\ObjectManager\getSelectableStyles(), ilObjLearningHistorySettingsGUI\initForm(), ilObjCommentsSettingsGUI\initForm(), ilObjNotesSettingsGUI\initForm(), ilObjPortfolio\isCommentsExportPossible(), ilObjWiki\isCommentsExportPossible(), ilOnScreenChatGUI\isOnScreenChatAccessible(), and ilObjNotificationAdminGUI\showOSDSettings().

     : ?string {
        return $this->setting[$a_keyword] ?? $a_default_value;
    }

Here is the caller graph for this function:

getAll()

ilSetting::getAll

(

)

Implements ILIAS\Administration\Setting.

Definition at line 140 of file class.ilSetting.php.

References $setting.

Referenced by ilObjAuthSettingsGUI\apacheAuthSettingsObject().

                            : array
    {
        return $this->setting;
    }

Here is the caller graph for this function:

getModule()

ilSetting::getModule

(

)

Implements ILIAS\Administration\Setting.

Definition at line 65 of file class.ilSetting.php.

References $module.

                               : string
    {
        return $this->module;
    }

read()

ilSetting::read

(

)

Implements ILIAS\Administration\Setting.

Definition at line 70 of file class.ilSetting.php.

References $db, $ilDB, $module, $res, and $setting.

Referenced by __construct().

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

Here is the caller graph for this function:

set()

ilSetting::set	(	string	$a_key,
		string	$a_val
	)

Implements ILIAS\Administration\Setting.

Definition at line 145 of file class.ilSetting.php.

References $db, $DIC, and $ilDB.

Referenced by ilMailCronNotification\activationWasToggled(), ilForumCronNotification\activationWasToggled(), ilMembershipCronNotifications\activationWasToggled(), ilObjAuthSettingsGUI\saveApacheSettingsObject(), ilObjNotificationAdminGUI\saveOSDSettings(), ilObjLearningHistorySettingsGUI\saveSettings(), ilObjNotesSettingsGUI\saveSettings(), ilObjCommentsSettingsGUI\saveSettings(), ilCleanCOPageHistoryCronjob\setCronDays(), ilCleanCOPageHistoryCronjob\setKeepEntries(), ilObjAdvancedEditing\setRichTextEditor(), and ilObjAdvancedEditing\setUsedHTMLTags().

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

Here is the caller graph for this function:

setScormDebug()

ilSetting::setScormDebug	(	string	$a_key,
		string	$a_val
	)

Todo:

this must not be part of a general settings class

Deprecated:

Definition at line 173 of file class.ilSetting.php.

References $db, and $ilDB.

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

Field Documentation

$cache_disabled

bool ilSetting::$cache_disabled = false

protected

Definition at line 45 of file class.ilSetting.php.

$db

ilDBInterface ilSetting::$db

protected

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

Referenced by delete(), deleteAll(), deleteLike(), read(), set(), and setScormDebug().

$module

string ilSetting::$module = ""

Definition at line 44 of file class.ilSetting.php.

Referenced by getModule(), and read().

$setting

array ilSetting::$setting = array()

Definition at line 43 of file class.ilSetting.php.

Referenced by getAll(), and read().

$settings_cache

array ilSetting::$settings_cache = array()

staticprivate

cache for the read settings ilSetting is instantiated more than once per request for some modules The cache avoids reading them from the DB with each instance

Definition at line 35 of file class.ilSetting.php.

$value_type

string ilSetting::$value_type = null

staticprivate

the type of settings value field in database This is determined in the set method to get a correct DB insert Don't set the value type to force a detection at first access

Definition at line 42 of file class.ilSetting.php.

---

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

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