Inheritance diagram for ilSetting:

Collaboration diagram for ilSetting:

Public Member Functions
	__construct ($a_module="common", $a_disabled_cache=false)
	Initialize settings. More...

	getModule ()
	Get currernt module. More...

	read ()
	Read settings data. More...

	get ($a_keyword, $a_default_value=false)
	get setting More...

	deleteAll ()
	Delete all settings of a current module. More...

	deleteLike ($a_like)
	Delete all settings corresponding to a like string. More...

	delete ($a_keyword)
	delete one value from settingstable public More...

	getAll ()
	read all values from settingstable public More...

	set ($a_key, $a_val)
	write one value to db-table settings public More...

	setScormDebug ($a_key, $a_val)

Static Public Member Functions
static	_lookupValue ($a_module, $a_keyword)

static	_getValueType ()
	Get the type of the value column in the database. More...

static	_changeValueType ($a_new_type='text')
	change the type of the value column in the database More...

static	_getLongerSettings ($a_limit='4000')
	get a list of setting records with values loger than a limit More...

Data Fields
	$setting = array()

	$module = ""

Protected Attributes
	$db

Static Private Attributes
static	$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	$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: Alex Killing alex..nosp@m.kill.nosp@m.ing@d.nosp@m.atab.nosp@m.ay.de

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Initialize settings.

Definition at line 60 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 ( $a_new_type = 'text' )

static

change the type of the value column in the database

Parameters

string 'text' or 'clob'

Returns: bolean type changed or not

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

References $DIC, $ilDB, and array.

Referenced by ilSetupGUI\changeSettingsType().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $old_type = self::_getValueType();
 
         if ($a_new_type == $old_type) {
             return false;
         } elseif ($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;
         } elseif ($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;
         } else {
             return false;
         }
     }

Here is the caller graph for this function:

◆ _getLongerSettings()

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

static

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

Parameters

int	character limit (default: 4000)

Returns: array records with longer values

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

References $DIC, $ilDB, $query, $result, $row, and array.

Referenced by ilSetupGUI\changeSettingsType(), and ilSetupGUI\showLongerSettings().

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

Here is the caller graph for this function:

◆ _getValueType()

static ilSetting::_getValueType ( )

static

Get the type of the value column in the database.

Returns: string 'text' or 'clob'

Exceptions

ilDatabaseException

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

References $info.

Referenced by ilSetupGUI\changeSettingsType(), and ilSetupGUI\initSettingsTypeForm().

     {
         include_once('./Services/Database/classes/class.ilDBAnalyzer.php');
         $analyzer = new ilDBAnalyzer();
         $info = $analyzer->getFieldInformation('settings');
 
         if ($info['value']['type'] == 'clob') {
             return 'clob';
         } else {
             return 'text';
         }
     }

Here is the caller graph for this function:

◆ _lookupValue()

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

static

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

References $data, $DIC, $ilDB, $query, $res, and array.

Referenced by ilCronManager\runActiveJobs().

     {
         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'];
     }

Here is the caller graph for this function:

◆ delete()

ilSetting::delete ( $a_keyword )

delete one value from settingstable public

Parameters

string keyword

Returns: string value

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

References $db, and $ilDB.

     {
         $ilDB = $this->db;
 
         $st = $ilDB->manipulate("DELETE FROM settings WHERE keyword = " .
             $ilDB->quote($a_keyword, "text") . " AND module = " .
             $ilDB->quote($this->module, "text"));
 
         unset($this->setting[$a_keyword]);
 
         return true;
     }

◆ deleteAll()

ilSetting::deleteAll ( )

Delete all settings of a current module.

public

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

References $db, $ilDB, $query, and array.

     {
         $ilDB = $this->db;
         
         $query = "DELETE FROM settings WHERE module = " . $ilDB->quote($this->module, "text");
         $ilDB->manipulate($query);
 
         $this->setting = array();
 
         return true;
     }

◆ deleteLike()

ilSetting::deleteLike ( $a_like )

Delete all settings corresponding to a like string.

public

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

References $db, $ilDB, $query, $res, and $row.

     {
         $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"]);
         }
         
         return true;
     }

◆ get()

ilSetting::get	(	$a_keyword,
		$a_default_value = `false`
	)

get setting

public

Parameters

string	keyword
string	default_value This value is returned, when no setting has been found for the keyword.

Returns: string value

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

References ILIAS_VERSION.

Referenced by ilOnScreenChatGUI\isOnScreenChatAccessible().

     {
         if ($a_keyword == "ilias_version") {
             return ILIAS_VERSION;
         }
         
         if (isset($this->setting[$a_keyword])) {
             return $this->setting[$a_keyword];
         } else {
             return $a_default_value;
         }
     }

Here is the caller graph for this function:

◆ getAll()

ilSetting::getAll ( )

read all values from settingstable public

Returns: array keyword/value pairs

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

References $setting.

     {
         return $this->setting;
     }

◆ getModule()

ilSetting::getModule ( )

Get currernt module.

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

References $module.

     {
         return $this->module;
     }

◆ read()

ilSetting::read ( )

Read settings data.

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

References $db, $ilDB, $module, $query, $res, $row, $setting, and array.

Referenced by __construct().

     {
         $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	(	$a_key,
		$a_val
	)

write one value to db-table settings public

Parameters

string	keyword
string	value

Returns: boolean true on success

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

References $db, $DIC, $ilDB, $lng, array, and ilUtil\sendFailure().

Referenced by setScormDebug().

     {
         global $DIC;
 
         $lng = $DIC["lng"];
         $ilDB = $this->db;
         
         $this->delete($a_key);
 
         if (!isset(self::$value_type)) {
             self::$value_type = self::_getValueType();
         }
 
         if (self::$value_type == 'text' and strlen($a_val) >= 4000) {
             ilUtil::sendFailure($lng->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;
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setScormDebug()

ilSetting::setScormDebug	(	$a_key,
		$a_val
	)

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

References $db, $ilDB, and set().

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

Here is the call graph for this function:

Field Documentation

◆ $db

ilSetting::$db

protected

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

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

◆ $module

ilSetting::$module = ""

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

Referenced by getModule(), and read().

◆ $setting

ilSetting::$setting = array()

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

Referenced by getAll(), and read().

◆ $settings_cache

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 44 of file class.ilSetting.php.

◆ $value_type

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 51 of file class.ilSetting.php.

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

Services/Administration/classes/class.ilSetting.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _changeValueType()

◆ _getLongerSettings()

◆ _getValueType()

◆ _lookupValue()

◆ delete()

◆ deleteAll()

◆ deleteLike()

◆ get()

◆ getAll()

◆ getModule()

◆ read()

◆ set()

◆ setScormDebug()

Field Documentation

◆ $db

◆ $module

◆ $setting

◆ $settings_cache

◆ $value_type