Collaboration diagram for ilDidacticTemplateSetting:

Public Member Functions
	__construct (int $a_id=0)
	Constructor. More...

	getIconHandler ()

	getId ()

	enable (bool $a_status)

	isEnabled ()

	setTitle (string $a_title)

	getTitle ()

	getPresentationTitle (string $a_lng="")

	getDescription ()

	getPresentationDescription (string $a_lng="")

	setDescription (string $a_description)

	setInfo (string $a_info)
	Set installation info text. More...

	getInfo ()
	Get installation info text. More...

	setType (int $a_type)

	getType ()

	hasIconSupport (ilObjectDefinition $definition)

	setAssignments (array $a_ass)

	getAssignments ()

	addAssignment (string $a_obj_type)

	getEffectiveFrom ()

	setEffectiveFrom (array $effective_from)

	isAutoGenerated ()

	isExclusive ()

	setExclusive (bool $exclusive)

	setIconIdentifier (string $icon_identifier)

	getIconIdentifier ()

	getTranslations ()
	Get all translations from this object. More...

	delete ()

	save ()

	update ()

	toXml (ilXmlWriter $writer)

	__clone ()

	getTranslationObject ()

	isEffective (int $a_node_id)

Data Fields
const	TYPE_CREATION = 1

Protected Member Functions
	setId (int $a_id)

	getPresentation (string $a_value, string $a_lng)

	saveEffectiveNodes ()

	deleteEffectiveNodes ()

	readEffectiveNodes ()

	read ()

Private Member Functions
	setAutoGenerated (bool $auto_generated)

	saveAssignments ()
	Save assignments in DB. More...

	saveAssignment (string $a_obj_type)
	Add one object assignment. More...

	deleteAssignments ()
	Delete assignments. More...

Private Attributes
int	$id = 0

bool	$enabled = false

string	$title = ''

string	$description = ''

string	$info = ''

int	$type = self::TYPE_CREATION

array	$assignments = []

array	$effective_from = []

bool	$auto_generated = false

bool	$exclusive = false

string	$icon_ide = ''

ilDidacticTemplateIconHandler	$iconHandler = null

ilLanguage	$lng

ilObjUser	$user

ilDBInterface	$db

ilSetting	$setting

ilTree	$tree

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateSetting::__construct ( int $a_id = 0 )

Constructor.

Parameters

int $a_id

Definition at line 56 of file class.ilDidacticTemplateSetting.php.

References $DIC, ILIAS\Repository\lng(), read(), setId(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->user = $DIC->user();
         $this->db = $DIC->database();
         $this->setting = $DIC->settings();
         $this->tree = $DIC->repositoryTree();
 
         $this->setId($a_id);
         $this->read();
         $this->iconHandler = new ilDidacticTemplateIconHandler($this);
     }

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDidacticTemplateSetting::__clone ( )

Definition at line 530 of file class.ilDidacticTemplateSetting.php.

References ilDidacticTemplateCopier\appendCopyInfo(), enable(), getTitle(), setAutoGenerated(), setId(), and setTitle().

     {
         $this->setId(0);
 
         $this->setTitle(ilDidacticTemplateCopier::appendCopyInfo($this->getTitle()));
         $this->enable(false);
         $this->setAutoGenerated(false);
         $this->iconHandler = new ilDidacticTemplateIconHandler($this);
     }

Here is the call graph for this function:

◆ addAssignment()

ilDidacticTemplateSetting::addAssignment ( string $a_obj_type )

Definition at line 192 of file class.ilDidacticTemplateSetting.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ delete()

ilDidacticTemplateSetting::delete ( )

Definition at line 284 of file class.ilDidacticTemplateSetting.php.

References ilDidacticTemplateObjSettings\deleteByTemplateId(), deleteEffectiveNodes(), ilDidacticTemplateActionFactory\getActionsByTemplateId(), getIconHandler(), getId(), getTranslationObject(), and isAutoGenerated().

Referenced by ilDidacticTemplateSettingsGUI\editImport(), and ilDidacticTemplateImport\parseLocalPolicyAction().

                             : bool
     {
         if ($this->isAutoGenerated()) {
             return false;
         }
 
         // Delete settings
         $query = 'DELETE FROM didactic_tpl_settings ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
 
         // Delete obj assignments
         $query = 'DELETE FROM didactic_tpl_sa ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
 
         foreach (ilDidacticTemplateActionFactory::getActionsByTemplateId($this->getId()) as $action) {
             $action->delete();
         }
         ilDidacticTemplateObjSettings::deleteByTemplateId($this->getId());
         $this->getTranslationObject()->delete();
         $this->deleteEffectiveNodes();
         $this->getIconHandler()->delete();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAssignments()

ilDidacticTemplateSetting::deleteAssignments ( )

private

Delete assignments.

Definition at line 412 of file class.ilDidacticTemplateSetting.php.

References getId(), and isAutoGenerated().

Referenced by update().

                                         : bool
     {
         if ($this->isAutoGenerated()) {
             return false;
         }
 
         $query = 'DELETE FROM didactic_tpl_sa ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteEffectiveNodes()

ilDidacticTemplateSetting::deleteEffectiveNodes ( )

protected

Definition at line 386 of file class.ilDidacticTemplateSetting.php.

References getId().

Referenced by delete(), and update().

                                              : bool
     {
         $query = 'DELETE FROM didactic_tpl_en ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable()

ilDidacticTemplateSetting::enable ( bool $a_status )

Definition at line 86 of file class.ilDidacticTemplateSetting.php.

Referenced by __clone(), and read().

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

Here is the caller graph for this function:

◆ getAssignments()

ilDidacticTemplateSetting::getAssignments ( )

Returns: string[]

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

References $assignments.

Referenced by ilDidacticTemplateImport\canUseIcons(), hasIconSupport(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilDidacticTemplateSettingsTableFilter\isFiltered(), saveAssignments(), and toXml().

                                     : array
     {
         return $this->assignments;
     }

Here is the caller graph for this function:

◆ getDescription()

ilDidacticTemplateSetting::getDescription ( )

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

References $description.

Referenced by getPresentationDescription(), getTranslations(), save(), toXml(), and update().

                                     : string
     {
         return $this->description;
     }

Here is the caller graph for this function:

◆ getEffectiveFrom()

ilDidacticTemplateSetting::getEffectiveFrom ( )

Returns: int[]

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

References $effective_from.

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate(), isEffective(), ilDidacticTemplateSettingsTableFilter\isFiltered(), saveEffectiveNodes(), and toXml().

                                       : array
     {
         return $this->effective_from;
     }

Here is the caller graph for this function:

◆ getIconHandler()

ilDidacticTemplateSetting::getIconHandler ( )

Definition at line 71 of file class.ilDidacticTemplateSetting.php.

References $iconHandler.

Referenced by ilDidacticTemplateIconHandler\copy(), delete(), ilDidacticTemplateSettingsGUI\initEditTemplate(), ilDidacticTemplateSettingsTableFilter\isFiltered(), and toXml().

                                     : ilDidacticTemplateIconHandler
     {
         return $this->iconHandler;
     }

Here is the caller graph for this function:

◆ getIconIdentifier()

ilDidacticTemplateSetting::getIconIdentifier ( )

Definition at line 238 of file class.ilDidacticTemplateSetting.php.

References $icon_ide.

Referenced by ilDidacticTemplateIconHandler\copy(), save(), and update().

                                        : string
     {
         return $this->icon_ide;
     }

Here is the caller graph for this function:

◆ getId()

ilDidacticTemplateSetting::getId ( )

Definition at line 81 of file class.ilDidacticTemplateSetting.php.

References $id.

Referenced by ilDidacticTemplateSettingsGUI\copyTemplate(), delete(), deleteAssignments(), deleteEffectiveNodes(), ilDidacticTemplateSettingsGUI\editImport(), ilDidacticTemplateSettingsGUI\exportTemplate(), getTranslationObject(), ilDidacticTemplateImport\parseBlockRoleAction(), ilDidacticTemplateImport\parseLocalPolicyAction(), ilDidacticTemplateImport\parseLocalRoleAction(), read(), readEffectiveNodes(), save(), saveAssignment(), saveEffectiveNodes(), toXml(), and update().

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getInfo()

ilDidacticTemplateSetting::getInfo ( )

Get installation info text.

Returns: string

Definition at line 149 of file class.ilDidacticTemplateSetting.php.

References $info.

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate(), ilDidacticTemplateSettingsTableFilter\isFiltered(), save(), toXml(), and update().

                              : string
     {
         return $this->info;
     }

Here is the caller graph for this function:

◆ getPresentation()

ilDidacticTemplateSetting::getPresentation	(	string	$a_value,
		string	$a_lng
	)

protected

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

References $lang, getTranslationObject(), and ILIAS\Repository\user().

Referenced by getPresentationDescription(), and getPresentationTitle().

                                                                       : string
     {
         $lang = $this->getTranslationObject()->getLanguages();
 
         if (!$lang) {
             return '';
         }
         if (!$a_lng) {
             $a_lng = $this->user->getCurrentLanguage();
         }
         if (!isset($lang[$a_lng])) {
             $a_lng = $this->getTranslationObject()->getDefaultLanguage();
         }
         return $lang[$a_lng][$a_value] ?? '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPresentationDescription()

ilDidacticTemplateSetting::getPresentationDescription ( string $a_lng = "" )

Definition at line 121 of file class.ilDidacticTemplateSetting.php.

References getDescription(), getPresentation(), isAutoGenerated(), and ILIAS\Repository\lng().

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate(), and ilDidacticTemplateSettingsTableFilter\isFiltered().

                                                                   : string
     {
         if ($this->isAutoGenerated()) {
             return $this->lng->txt($this->getDescription());
         }
 
         $desc = $this->getPresentation('description', $a_lng);
         return $desc ?: $this->getDescription();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPresentationTitle()

ilDidacticTemplateSetting::getPresentationTitle ( string $a_lng = "" )

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

References getPresentation(), getTitle(), isAutoGenerated(), and ILIAS\Repository\lng().

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate(), and ilDidacticTemplateSettingsTableFilter\isFiltered().

                                                             : string
     {
         if ($this->isAutoGenerated()) {
             return $this->lng->txt($this->getTitle());
         }
 
         $tit = $this->getPresentation('title', $a_lng);
         return $tit ?: $this->getTitle();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilDidacticTemplateSetting::getTitle ( )

Definition at line 101 of file class.ilDidacticTemplateSetting.php.

References $title.

Referenced by __clone(), getPresentationTitle(), getTranslations(), save(), toXml(), and update().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getTranslationObject()

ilDidacticTemplateSetting::getTranslationObject ( )

Definition at line 540 of file class.ilDidacticTemplateSetting.php.

References getId(), and ilMultilingualism\getInstance().

Referenced by delete(), getPresentation(), getTranslations(), and toXml().

                                           : ilMultilingualism
     {
         return ilMultilingualism::getInstance($this->getId(), "dtpl");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslations()

ilDidacticTemplateSetting::getTranslations ( )

Get all translations from this object.

Returns: array{title: string, description: string, lang_code: string, lang_default: bool}[]

Definition at line 247 of file class.ilDidacticTemplateSetting.php.

References $lang, getDescription(), getTitle(), and getTranslationObject().

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate().

                                      : array
     {
         $trans = $this->getTranslationObject();
         $lang = $trans->getLanguages();
 
         foreach ($lang as $k => $v) {
             if ($v['lang_default']) {
                 $lang[0] = $v;
             }
         }
 
         // fallback if translation object is empty
         if (!isset($lang[0])) {
             $lang[0]['title'] = $this->getTitle();
             $lang[0]['description'] = $this->getDescription();
             $lang[0]['lang_code'] = $trans->getDefaultLanguage();
         }
 
         return $lang;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateSetting::getType ( )

Definition at line 159 of file class.ilDidacticTemplateSetting.php.

References $type.

Referenced by save(), toXml(), and update().

                              : int
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ hasIconSupport()

ilDidacticTemplateSetting::hasIconSupport ( ilObjectDefinition $definition )

Definition at line 164 of file class.ilDidacticTemplateSetting.php.

References getAssignments(), and ilObjectDefinition\isContainer().

                                                                   : bool
     {
         foreach ($this->getAssignments() as $assignment) {
             if (!$definition->isContainer($assignment)) {
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

◆ isAutoGenerated()

ilDidacticTemplateSetting::isAutoGenerated ( )

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

References $auto_generated.

Referenced by delete(), deleteAssignments(), ilDidacticTemplateSettingsGUI\executeCommand(), getPresentationDescription(), getPresentationTitle(), ilDidacticTemplateSettingsGUI\initEditTemplate(), save(), saveAssignment(), and saveAssignments().

                                      : bool
     {
         return $this->auto_generated;
     }

Here is the caller graph for this function:

◆ isEffective()

ilDidacticTemplateSetting::isEffective ( int $a_node_id )

Definition at line 545 of file class.ilDidacticTemplateSetting.php.

References getEffectiveFrom().

                                                : bool
     {
         if (0 === count($this->getEffectiveFrom()) || in_array($a_node_id, $this->getEffectiveFrom())) {
             return true;
         }
 
         foreach ($this->getEffectiveFrom() as $node) {
             if ($this->tree->isGrandChild($node, $a_node_id)) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ isEnabled()

ilDidacticTemplateSetting::isEnabled ( )

Definition at line 91 of file class.ilDidacticTemplateSetting.php.

References $enabled.

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate(), ilDidacticTemplateSettingsTableFilter\isFiltered(), save(), and update().

                                : bool
     {
         return $this->enabled;
     }

Here is the caller graph for this function:

◆ isExclusive()

ilDidacticTemplateSetting::isExclusive ( )

Definition at line 223 of file class.ilDidacticTemplateSetting.php.

References $exclusive.

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate(), save(), toXml(), and update().

                                  : bool
     {
         return $this->exclusive;
     }

Here is the caller graph for this function:

◆ read()

ilDidacticTemplateSetting::read ( )

protected

Definition at line 446 of file class.ilDidacticTemplateSetting.php.

References $res, addAssignment(), enable(), ilDBConstants\FETCHMODE_OBJECT, getId(), readEffectiveNodes(), setAutoGenerated(), setDescription(), setExclusive(), setIconIdentifier(), setInfo(), setTitle(), and setType().

Referenced by __construct().

                              : bool
     {
         if (!$this->getId()) {
             return false;
         }
         $query = 'SELECT * FROM didactic_tpl_settings dtpl ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setType((int) $row->type);
             $this->enable((bool) $row->enabled);
             $this->setTitle((string) $row->title);
             $this->setDescription((string) $row->description);
             $this->setInfo((string) $row->info);
             $this->setAutoGenerated((bool) $row->auto_generated);
             $this->setExclusive((bool) $row->exclusive_tpl);
             $this->setIconIdentifier((string) $row->icon_ide);
         }
         $query = 'SELECT * FROM didactic_tpl_sa ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->addAssignment($row->obj_type);
         }
         $this->readEffectiveNodes();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEffectiveNodes()

ilDidacticTemplateSetting::readEffectiveNodes ( )

protected

Definition at line 395 of file class.ilDidacticTemplateSetting.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, getId(), ILIAS\Repository\int(), and setEffectiveFrom().

Referenced by read().

                                            : void
     {
         $effective_nodes = [];
 
         $query = 'SELECT * FROM didactic_tpl_en ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $effective_nodes[] = (int) $row->node;
         }
 
         $this->setEffectiveFrom($effective_nodes);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDidacticTemplateSetting::save ( )

Definition at line 311 of file class.ilDidacticTemplateSetting.php.

References getDescription(), getIconIdentifier(), getId(), getInfo(), getTitle(), getType(), isAutoGenerated(), isEnabled(), isExclusive(), saveAssignments(), setId(), and ilDBConstants\T_TEXT.

                           : bool
     {
         $this->setId($this->db->nextId('didactic_tpl_settings'));
         $query = 'INSERT INTO didactic_tpl_settings (id,enabled,title,description,info,type,auto_generated,exclusive_tpl,icon_ide) ' .
             'VALUES( ' .
             $this->db->quote($this->getId(), 'integer') . ', ' .
             $this->db->quote($this->isEnabled(), 'integer') . ', ' .
             $this->db->quote($this->getTitle(), 'text') . ', ' .
             $this->db->quote($this->getDescription(), 'text') . ', ' .
             $this->db->quote($this->getInfo(), 'text') . ', ' .
             $this->db->quote($this->getType(), 'integer') . ', ' .
             $this->db->quote((int) $this->isAutoGenerated(), 'integer') . ', ' .
             $this->db->quote((int) $this->isExclusive(), 'integer') . ', ' .
             $this->db->quote($this->getIconIdentifier(), ilDBConstants::T_TEXT) . ' ' .
             ')';
 
         $this->db->manipulate($query);
         $this->saveAssignments();
 
         return true;
     }

Here is the call graph for this function:

◆ saveAssignment()

ilDidacticTemplateSetting::saveAssignment ( string $a_obj_type )

private

Add one object assignment.

Parameters

string $a_obj_type

Definition at line 353 of file class.ilDidacticTemplateSetting.php.

References getId(), and isAutoGenerated().

Referenced by saveAssignments().

                                                        : void
     {
         if ($this->isAutoGenerated()) {
             return;
         }
 
         $query = 'INSERT INTO didactic_tpl_sa (id,obj_type) ' .
             'VALUES( ' .
             $this->db->quote($this->getId(), 'integer') . ', ' .
             $this->db->quote($a_obj_type, 'text') .
             ')';
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAssignments()

ilDidacticTemplateSetting::saveAssignments ( )

private

Save assignments in DB.

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

References getAssignments(), isAutoGenerated(), and saveAssignment().

Referenced by save(), and update().

                                       : bool
     {
         if ($this->isAutoGenerated()) {
             return false;
         }
 
         foreach ($this->getAssignments() as $ass) {
             $this->saveAssignment($ass);
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveEffectiveNodes()

ilDidacticTemplateSetting::saveEffectiveNodes ( )

protected

Definition at line 367 of file class.ilDidacticTemplateSetting.php.

References getEffectiveFrom(), and getId().

Referenced by update().

                                            : void
     {
         if (0 === count($this->getEffectiveFrom())) {
             return;
         }
         $values = [];
         foreach ($this->getEffectiveFrom() as $node) {
             $values[] = '( ' .
                 $this->db->quote($this->getId(), 'integer') . ', ' .
                 $this->db->quote($node, 'integer') .
                 ')';
         }
 
         $query = 'INSERT INTO didactic_tpl_en (id,node) ' .
             'VALUES ' . implode(', ', $values);
 
         $this->db->manipulate($query);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAssignments()

ilDidacticTemplateSetting::setAssignments ( array $a_ass )

Parameters

string[] $a_ass

Returns: void

Definition at line 179 of file class.ilDidacticTemplateSetting.php.

                                                 : void
     {
         $this->assignments = $a_ass;
     }

◆ setAutoGenerated()

ilDidacticTemplateSetting::setAutoGenerated ( bool $auto_generated )

private

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

References $auto_generated.

Referenced by __clone(), and read().

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

Here is the caller graph for this function:

◆ setDescription()

ilDidacticTemplateSetting::setDescription ( string $a_description )

Definition at line 131 of file class.ilDidacticTemplateSetting.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ setEffectiveFrom()

ilDidacticTemplateSetting::setEffectiveFrom ( array $effective_from )

Parameters

int[] $effective_from

Definition at line 208 of file class.ilDidacticTemplateSetting.php.

References $effective_from.

Referenced by readEffectiveNodes().

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

Here is the caller graph for this function:

◆ setExclusive()

ilDidacticTemplateSetting::setExclusive ( bool $exclusive )

Definition at line 228 of file class.ilDidacticTemplateSetting.php.

References $exclusive.

Referenced by read().

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

Here is the caller graph for this function:

◆ setIconIdentifier()

ilDidacticTemplateSetting::setIconIdentifier ( string $icon_identifier )

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

Referenced by read().

                                                               : void
     {
         $this->icon_ide = $icon_identifier;
     }

Here is the caller graph for this function:

◆ setId()

ilDidacticTemplateSetting::setId ( int $a_id )

protected

Definition at line 76 of file class.ilDidacticTemplateSetting.php.

Referenced by __clone(), __construct(), and save().

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

Here is the caller graph for this function:

◆ setInfo()

ilDidacticTemplateSetting::setInfo ( string $a_info )

Set installation info text.

Parameters

string $a_info

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

References ILIAS\UI\examples\MessageBox\Info\info().

Referenced by read().

                                            : void
     {
         $this->info = $a_info;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTitle()

ilDidacticTemplateSetting::setTitle ( string $a_title )

Definition at line 96 of file class.ilDidacticTemplateSetting.php.

Referenced by __clone(), and read().

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

Here is the caller graph for this function:

◆ setType()

ilDidacticTemplateSetting::setType ( int $a_type )

Definition at line 154 of file class.ilDidacticTemplateSetting.php.

Referenced by read().

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

Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateSetting::toXml ( ilXmlWriter $writer )

Definition at line 475 of file class.ilDidacticTemplateSetting.php.

References ilDidacticTemplateActionFactory\getActionsByTemplateId(), getAssignments(), getDescription(), getEffectiveFrom(), getIconHandler(), getId(), getInfo(), getTitle(), getTranslationObject(), getType(), isExclusive(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                               : ilXmlWriter
     {
         $type = '';
         switch ($this->getType()) {
             case self::TYPE_CREATION:
                 $type = 'creation';
                 break;
         }
         $writer->xmlStartTag('didacticTemplate', ['type' => $type]);
         $writer->xmlElement('title', [], $this->getTitle());
         $writer->xmlElement('description', [], $this->getDescription());
         $writer = $this->getIconHandler()->toXml($writer);
         $writer = $this->getTranslationObject()->toXml($writer);
 
         // info text with p-tags
         if ($this->getInfo() !== '') {
             $writer->xmlStartTag('info');
 
             $info_lines = (array) explode("\n", $this->getInfo());
             foreach ($info_lines as $info) {
                 $trimmed_info = trim($info);
                 if ($trimmed_info !== '') {
                     $writer->xmlElement('p', [], $trimmed_info);
                 }
             }
 
             $writer->xmlEndTag('info');
         }
         if ($this->isExclusive()) {
             $writer->xmlElement("exclusive");
         }
         if (count($this->getEffectiveFrom()) > 0) {
             $writer->xmlStartTag('effectiveFrom', ['nic_id' => $this->setting->get('inst_id')]);
 
             foreach ($this->getEffectiveFrom() as $node) {
                 $writer->xmlElement('node', [], $node);
             }
             $writer->xmlEndTag('effectiveFrom');
         }
         // Assignments
         $writer->xmlStartTag('assignments');
         foreach ($this->getAssignments() as $assignment) {
             $writer->xmlElement('assignment', [], $assignment);
         }
         $writer->xmlEndTag('assignments');
         $writer->xmlStartTag('actions');
         foreach (ilDidacticTemplateActionFactory::getActionsByTemplateId($this->getId()) as $action) {
             $action->toXml($writer);
         }
         $writer->xmlEndTag('actions');
         $writer->xmlEndTag('didacticTemplate');
 
         return $writer;
     }

Here is the call graph for this function:

◆ update()

ilDidacticTemplateSetting::update ( )

Definition at line 425 of file class.ilDidacticTemplateSetting.php.

References deleteAssignments(), deleteEffectiveNodes(), getDescription(), getIconIdentifier(), getId(), getInfo(), getTitle(), getType(), isEnabled(), isExclusive(), saveAssignments(), saveEffectiveNodes(), and ilDBConstants\T_TEXT.

                             : bool
     {
         $query = 'UPDATE didactic_tpl_settings ' .
             'SET ' .
             'enabled = ' . $this->db->quote($this->isEnabled(), 'integer') . ', ' .
             'title = ' . $this->db->quote($this->getTitle(), 'text') . ', ' .
             'description = ' . $this->db->quote($this->getDescription(), 'text') . ', ' .
             'info = ' . $this->db->quote($this->getInfo(), 'text') . ', ' .
             'type = ' . $this->db->quote($this->getType(), 'integer') . ', ' .
             'exclusive_tpl = ' . $this->db->quote((int) $this->isExclusive(), 'integer') . ', ' .
             'icon_ide = ' . $this->db->quote($this->getIconIdentifier(), ilDBConstants::T_TEXT) . ' ' .
             'WHERE id = ' . $this->db->quote($this->getId(), 'integer');
         $this->db->manipulate($query);
         $this->deleteAssignments();
         $this->saveAssignments();
         $this->deleteEffectiveNodes();
         $this->saveEffectiveNodes();
 
         return true;
     }