Settings template application class. More...

Collaboration diagram for ilSettingsTemplate:

Public Member Functions
	__construct (int $a_id=0, ?ilSettingsTemplateConfig $config=null)

	setId (int $a_val)

	getId ()

	setAutoGenerated (bool $a_status)

	getAutoGenerated ()

	setTitle (string $a_val)

	getTitle ()

	setType (string $a_val)

	getType ()

	setDescription (string $a_val)

	getDescription ()

	isAvailable ()

	setSetting (string $a_setting, $a_value, bool $a_hide=false)
	Set setting. More...

	removeSetting (string $a_setting)

	removeAllSettings ()

	getSettings ()

	addHiddenTab (string $a_tab_id)

	removeAllHiddenTabs ()

	getHiddenTabs ()

	getConfig ()
	Returns the template config associated with this template or NULL if none is given. More...

	setConfig (ilSettingsTemplateConfig $config)
	Sets the template config for this template. More...

	read ()

	create ()

	update ()

	insertHiddenTabs ()

	delete ()

Static Public Member Functions
static	getAllSettingsTemplates (string $a_type, bool $a_include_auto_generated=false)
	Get all settings templates of type. More...

static	lookupTitle (int $a_id)

static	lookupDescription (int $a_id)

static	translate (string $a_title_desc)

Static Protected Member Functions
static	lookupProperty (int $a_id, string $a_prop)

Protected Attributes
ilDBInterface	$db

Private Member Functions
	insertSettings ()

Private Attributes
int	$id

string	$type = ''

string	$title = ''

string	$description = ''

array	$setting = []

array	$hidden_tab = []

bool	$auto_generated = false

ilSettingsTemplateConfig	$config = null

bool	$available = true

Detailed Description

Settings template application class.

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

Deprecated:

Definition at line 27 of file class.ilSettingsTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilSettingsTemplate::__construct	(	int	$a_id = `0`,
		?ilSettingsTemplateConfig	$config = `null`
	)

Definition at line 41 of file class.ilSettingsTemplate.php.

References $DIC, read(), setConfig(), and setId().

       {
         global $DIC;
 
         $this->db = $DIC->database();
         if ($a_id > 0) {
             if ($config) {
                 $this->setConfig($config);
             }
             $this->setId($a_id);
             $this->read();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addHiddenTab()

ilSettingsTemplate::addHiddenTab ( string $a_tab_id )

Definition at line 155 of file class.ilSettingsTemplate.php.

Referenced by read(), and ilSettingsTemplateGUI\setValuesFromForm().

                                                   : void
     {
         $this->hidden_tab[$a_tab_id] = $a_tab_id;
     }

Here is the caller graph for this function:

◆ create()

ilSettingsTemplate::create ( )

Definition at line 233 of file class.ilSettingsTemplate.php.

References $db, $ilDB, getAutoGenerated(), getDescription(), getId(), getTitle(), getType(), insertHiddenTabs(), insertSettings(), and setId().

Referenced by ilSettingsTemplateGUI\saveSettingsTemplate().

                             : void
     {
         $ilDB = $this->db;
 
         $this->setId($ilDB->nextId("adm_settings_template"));
 
         // write template
         $ilDB->insert("adm_settings_template", [
             "id" => ["integer", $this->getId()],
             "title" => ["text", $this->getTitle()],
             "type" => ["text", $this->getType()],
             // begin-patch lok
             "description" => ["clob", $this->getDescription()],
             'auto_generated' => ['integer', $this->getAutoGenerated()]
             // end-patch lok
         ]);
 
         // write settings
         $this->insertSettings();
 
         // write hidden tabs
         $this->insertHiddenTabs();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilSettingsTemplate::delete ( )

Definition at line 315 of file class.ilSettingsTemplate.php.

References $db, and $ilDB.

                             : void
     {
         $ilDB = $this->db;
 
         $ilDB->manipulate(
             "DELETE FROM adm_settings_template WHERE "
             . " id = " . $ilDB->quote($this->getId(), "integer")
         );
         $ilDB->manipulate(
             "DELETE FROM adm_set_templ_value WHERE "
             . " template_id = " . $ilDB->quote($this->getId(), "integer")
         );
         $ilDB->manipulate(
             "DELETE FROM adm_set_templ_hide_tab WHERE "
             . " template_id = " . $ilDB->quote($this->getId(), "integer")
         );
     }

◆ getAllSettingsTemplates()

static ilSettingsTemplate::getAllSettingsTemplates	(	string	$a_type,
		bool	$a_include_auto_generated = `false`
	)

static

Get all settings templates of type.

Definition at line 336 of file class.ilSettingsTemplate.php.

References $DIC, and $ilDB.

Referenced by ilSettingsTemplateTableGUI\__construct(), ilObjSurveyGUI\addDidacticTemplateOptions(), ilObjTestGUI\addDidacticTemplateOptions(), ilLOEditorGUI\applySettingsTemplate(), and ilObjSurveyGUI\importSurveyObject().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if ($a_include_auto_generated) {
             $set = $ilDB->query("SELECT * FROM adm_settings_template " .
                 " WHERE type = " . $ilDB->quote($a_type, "text") .
                 " ORDER BY title");
         } else {
             $set = $ilDB->query("SELECT * FROM adm_settings_template " .
                 " WHERE type = " . $ilDB->quote($a_type, "text") .
                 'AND auto_generated = ' . $ilDB->quote(0, 'integer') . ' ' .
                 " ORDER BY title");
         }
 
         $settings_template = [];
         while ($rec = $ilDB->fetchAssoc($set)) {
             $settings_template[] = $rec;
         }
         return $settings_template;
     }

Here is the caller graph for this function:

◆ getAutoGenerated()

ilSettingsTemplate::getAutoGenerated ( )

Definition at line 72 of file class.ilSettingsTemplate.php.

References $auto_generated.

Referenced by create(), and update().

                                       : bool
     {
         return $this->auto_generated;
     }

Here is the caller graph for this function:

◆ getConfig()

ilSettingsTemplate::getConfig ( )

Returns the template config associated with this template or NULL if none is given.

Definition at line 174 of file class.ilSettingsTemplate.php.

References $config.

Referenced by setSetting().

                                : ?ilSettingsTemplateConfig
     {
         return $this->config;
     }

Here is the caller graph for this function:

◆ getDescription()

ilSettingsTemplate::getDescription ( )

Definition at line 102 of file class.ilSettingsTemplate.php.

References $description.

Referenced by create(), and update().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getHiddenTabs()

ilSettingsTemplate::getHiddenTabs ( )

Definition at line 165 of file class.ilSettingsTemplate.php.

References $hidden_tab.

Referenced by insertHiddenTabs().

                                    : array
     {
         return $this->hidden_tab;
     }

Here is the caller graph for this function:

◆ getId()

ilSettingsTemplate::getId ( )

Definition at line 62 of file class.ilSettingsTemplate.php.

References $id.

Referenced by create(), and update().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getSettings()

ilSettingsTemplate::getSettings ( )

Definition at line 150 of file class.ilSettingsTemplate.php.

References $setting.

Referenced by insertSettings().

                                  : array
     {
         return $this->setting;
     }

Here is the caller graph for this function:

◆ getTitle()

ilSettingsTemplate::getTitle ( )

Definition at line 82 of file class.ilSettingsTemplate.php.

References $title.

Referenced by create(), and update().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

ilSettingsTemplate::getType ( )

Definition at line 92 of file class.ilSettingsTemplate.php.

References $type.

Referenced by create(), and update().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ insertHiddenTabs()

ilSettingsTemplate::insertHiddenTabs ( )

Definition at line 302 of file class.ilSettingsTemplate.php.

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

Referenced by create(), and update().

                                       : void
     {
         $ilDB = $this->db;
 
         foreach ($this->getHiddenTabs() as $tab_id) {
             $ilDB->manipulate("INSERT INTO adm_set_templ_hide_tab " .
                 "(template_id, tab_id) VALUES (" .
                 $ilDB->quote($this->getId(), "integer") . "," .
                 $ilDB->quote($tab_id, "text") .
                 ")");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ insertSettings()

ilSettingsTemplate::insertSettings ( )

private

Definition at line 287 of file class.ilSettingsTemplate.php.

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

Referenced by create(), and update().

                                      : void
     {
         $ilDB = $this->db;
 
         foreach ($this->getSettings() as $s => $set) {
             $ilDB->manipulate("INSERT INTO adm_set_templ_value " .
                 "(template_id, setting, value, hide) VALUES (" .
                 $ilDB->quote($this->getId(), "integer") . "," .
                 $ilDB->quote($s, "text") . "," .
                 $ilDB->quote($set["value"], "text") . "," .
                 $ilDB->quote($set["hide"], "integer") .
                 ")");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAvailable()

ilSettingsTemplate::isAvailable ( )

Definition at line 107 of file class.ilSettingsTemplate.php.

References $available.

                                  : bool
     {
         return $this->available;
     }

◆ lookupDescription()

static ilSettingsTemplate::lookupDescription ( int $a_id )

static

Definition at line 383 of file class.ilSettingsTemplate.php.

                                                        : string
     {
         return self::lookupProperty($a_id, 'description');
     }

◆ lookupProperty()

static ilSettingsTemplate::lookupProperty	(	int	$a_id,
		string	$a_prop
	)

staticprotected

Definition at line 362 of file class.ilSettingsTemplate.php.

References $DIC, and $ilDB.

      : string {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $set = $ilDB->query(
             "SELECT $a_prop FROM adm_settings_template WHERE " .
             " id = " . $ilDB->quote($a_id, "integer")
         );
         $rec = $ilDB->fetchAssoc($set);
         return $rec[$a_prop];
     }

◆ lookupTitle()

static ilSettingsTemplate::lookupTitle ( int $a_id )

static

Definition at line 378 of file class.ilSettingsTemplate.php.

Referenced by ilSettingsTemplateGUI\confirmSettingsTemplateDeletion().

                                                  : string
     {
         return self::lookupProperty($a_id, 'title');
     }

Here is the caller graph for this function:

◆ read()

ilSettingsTemplate::read ( )

Definition at line 187 of file class.ilSettingsTemplate.php.

References $db, $ilDB, addHiddenTab(), setAutoGenerated(), setDescription(), setSetting(), setTitle(), and setType().

Referenced by __construct().

                           : void
     {
         $ilDB = $this->db;
 
         // read template
         $set = $ilDB->query(
             "SELECT * FROM adm_settings_template WHERE " .
             " id = " . $ilDB->quote($this->getId(), "integer")
         );
         if ($ilDB->numRows($set) === 0) {
             $this->available = false;
             return;
         }
 
         $rec = $ilDB->fetchAssoc($set);
         $this->setTitle($rec["title"]);
         $this->setType($rec["type"]);
         $this->setDescription($rec["description"] ?? '');
         // begin-patch lok
         $this->setAutoGenerated((bool) $rec['auto_generated']);
         // end-patch lok
 
         // read template setttings
         $set = $ilDB->query(
             "SELECT * FROM adm_set_templ_value WHERE " .
             " template_id = " . $ilDB->quote($this->getId(), "integer")
         );
         while ($rec = $ilDB->fetchAssoc($set)) {
             $this->setSetting(
                 $rec["setting"],
                 $rec["value"],
                 (bool) $rec["hide"]
             );
         }
 
         // read hidden tabs
         $set = $ilDB->query(
             "SELECT * FROM adm_set_templ_hide_tab WHERE " .
             " template_id = " . $ilDB->quote($this->getId(), "integer")
         );
         while ($rec = $ilDB->fetchAssoc($set)) {
             $this->addHiddenTab($rec["tab_id"]);
         }
         $this->available = true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAllHiddenTabs()

ilSettingsTemplate::removeAllHiddenTabs ( )

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

Referenced by ilSettingsTemplateGUI\setValuesFromForm().

                                          : void
     {
         $this->hidden_tab = [];
     }

Here is the caller graph for this function:

◆ removeAllSettings()

ilSettingsTemplate::removeAllSettings ( )

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

Referenced by ilSettingsTemplateGUI\setValuesFromForm().

                                        : void
     {
         $this->setting = [];
     }

Here is the caller graph for this function:

◆ removeSetting()

ilSettingsTemplate::removeSetting ( string $a_setting )

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

                                                     : void
     {
         unset($this->setting[$a_setting]);
     }

◆ setAutoGenerated()

ilSettingsTemplate::setAutoGenerated ( bool $a_status )

Definition at line 67 of file class.ilSettingsTemplate.php.

Referenced by read().

                                                     : void
     {
         $this->auto_generated = $a_status;
     }

Here is the caller graph for this function:

◆ setConfig()

ilSettingsTemplate::setConfig ( ilSettingsTemplateConfig $config )

Sets the template config for this template.

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

References $config.

Referenced by __construct().

                                                                : void
     {
         $this->config = $config;
     }

Here is the caller graph for this function:

◆ setDescription()

ilSettingsTemplate::setDescription ( string $a_val )

Definition at line 97 of file class.ilSettingsTemplate.php.

Referenced by read(), and ilSettingsTemplateGUI\setValuesFromForm().

                                                  : void
     {
         $this->description = $a_val;
     }

Here is the caller graph for this function:

◆ setId()

ilSettingsTemplate::setId ( int $a_val )

Definition at line 57 of file class.ilSettingsTemplate.php.

Referenced by __construct(), and create().

                                      : void
     {
         $this->id = $a_val;
     }

Here is the caller graph for this function:

◆ setSetting()

ilSettingsTemplate::setSetting	(	string	$a_setting,
			$a_value,
		bool	$a_hide = `false`
	)

Set setting.

Parameters

array | string $a_value

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

References ILIAS\LTI\ToolProvider\$settings, ilSettingsTemplateConfig\CHECKBOX, and getConfig().

Referenced by read(), and ilSettingsTemplateGUI\setValuesFromForm().

      : void {
         if ($this->getConfig()) {
             $settings = $this->getConfig()->getSettings();
 
             if (isset($settings[$a_setting]['type']) &&
                 $settings[$a_setting]['type'] === ilSettingsTemplateConfig::CHECKBOX) {
                 if (is_array($a_value)) {
                     $a_value = serialize($a_value);
                 } else {
                     $a_value = unserialize($a_value, ['allowed_classes' => false]);
                 }
             }
         }
 
         $this->setting[$a_setting] = [
             "value" => $a_value,
             "hide" => $a_hide
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTitle()

ilSettingsTemplate::setTitle ( string $a_val )

Definition at line 77 of file class.ilSettingsTemplate.php.

Referenced by read(), and ilSettingsTemplateGUI\setValuesFromForm().

                                            : void
     {
         $this->title = $a_val;
     }

Here is the caller graph for this function:

◆ setType()

ilSettingsTemplate::setType ( string $a_val )

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

Referenced by read(), and ilSettingsTemplateGUI\saveSettingsTemplate().

                                           : void
     {
         $this->type = $a_val;
     }

Here is the caller graph for this function:

◆ translate()

static ilSettingsTemplate::translate ( string $a_title_desc )

static

Definition at line 388 of file class.ilSettingsTemplate.php.

References $DIC.

Referenced by ilSettingsTemplateTableGUI\fillRow().

                                                           : string
     {
         global $DIC;
 
         if (str_starts_with($a_title_desc, 'il_')) {
             return $DIC->language()->txt($a_title_desc);
         }
         return $a_title_desc;
     }

Here is the caller graph for this function:

◆ update()

ilSettingsTemplate::update ( )

Definition at line 257 of file class.ilSettingsTemplate.php.

References $db, $ilDB, getAutoGenerated(), getDescription(), getId(), getTitle(), getType(), insertHiddenTabs(), and insertSettings().

                             : void
     {
         $ilDB = $this->db;
 
         // update template
         $ilDB->update("adm_settings_template", [
             "title" => ["text", $this->getTitle()],
             "type" => ["text", $this->getType()],
             // begin-patch lok
             "description" => ["clob", $this->getDescription()],
             'auto_generated' => ['integer', $this->getAutoGenerated()]
         ], [
             "id" => ["integer", $this->getId()],
         ]);
 
         // delete settings and hidden tabs
         $ilDB->manipulate(
             "DELETE FROM adm_set_templ_value WHERE "
             . " template_id = " . $ilDB->quote($this->getId(), "integer")
         );
         $ilDB->manipulate(
             "DELETE FROM adm_set_templ_hide_tab WHERE "
             . " template_id = " . $ilDB->quote($this->getId(), "integer")
         );
 
         // insert settings and hidden tabs
         $this->insertSettings();
         $this->insertHiddenTabs();
     }

Here is the call graph for this function:

Field Documentation

◆ $auto_generated

bool ilSettingsTemplate::$auto_generated = false

private

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

Referenced by getAutoGenerated().

◆ $available

bool ilSettingsTemplate::$available = true

private

Definition at line 39 of file class.ilSettingsTemplate.php.

Referenced by isAvailable().

◆ $config

ilSettingsTemplateConfig ilSettingsTemplate::$config = null

private

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

Referenced by getConfig(), and setConfig().

◆ $db

ilDBInterface ilSettingsTemplate::$db

protected

Definition at line 29 of file class.ilSettingsTemplate.php.

Referenced by create(), delete(), insertHiddenTabs(), insertSettings(), read(), and update().

◆ $description

string ilSettingsTemplate::$description = ''

private

Definition at line 33 of file class.ilSettingsTemplate.php.

Referenced by getDescription().

◆ $hidden_tab

array ilSettingsTemplate::$hidden_tab = []

private

Definition at line 36 of file class.ilSettingsTemplate.php.

Referenced by getHiddenTabs().

◆ $id

int ilSettingsTemplate::$id

private

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

Referenced by getId().

◆ $setting

array ilSettingsTemplate::$setting = []

private

Definition at line 34 of file class.ilSettingsTemplate.php.

Referenced by getSettings().

◆ $title

string ilSettingsTemplate::$title = ''

private

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

Referenced by getTitle().

◆ $type

string ilSettingsTemplate::$type = ''

private

Definition at line 31 of file class.ilSettingsTemplate.php.

Referenced by getType().

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

Services/Administration/classes/class.ilSettingsTemplate.php

Public Member Functions

Static Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addHiddenTab()

◆ create()

◆ delete()

◆ getAllSettingsTemplates()

◆ getAutoGenerated()

◆ getConfig()

◆ getDescription()

◆ getHiddenTabs()

◆ getId()

◆ getSettings()

◆ getTitle()

◆ getType()

◆ insertHiddenTabs()

◆ insertSettings()

◆ isAvailable()

◆ lookupDescription()

◆ lookupProperty()

◆ lookupTitle()

◆ read()

◆ removeAllHiddenTabs()

◆ removeAllSettings()

◆ removeSetting()

◆ setAutoGenerated()

◆ setConfig()

◆ setDescription()

◆ setId()

◆ setSetting()

◆ setTitle()

◆ setType()

◆ translate()

◆ update()

Field Documentation

◆ $auto_generated

◆ $available

◆ $config

◆ $db

◆ $description

◆ $hidden_tab

◆ $id

◆ $setting

◆ $title

◆ $type