Collaboration diagram for ilDidacticTemplateSetting:

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

	getIconHandler ()

	getId ()
	Get id. More...

	enable ($a_status)
	Set enabled status. More...

	isEnabled ()
	Check if template is enabled. More...

	setTitle ($a_title)
	Set title. More...

	getTitle ()
	Get title. More...

	getPresentationTitle ($a_lng="")

	getDescription ()
	Get description. More...

	getPresentationDescription ($a_lng="")

	setDescription ($a_description)
	Set description. More...

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

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

	setType ($a_type)
	Set type. More...

	getType ()
	Get type. More...

	hasIconSupport (ilObjectDefinition $definition)

	setAssignments (array $a_ass)
	Set assignments. More...

	getAssignments ()
	Get object assignemnts. More...

	addAssignment ($a_obj_type)
	Add one assignment obj type. More...

	getEffectiveFrom ()

	setEffectiveFrom ($effective_from)

	isAutoGenerated ()

	isExclusive ()

	setExclusive ($exclusive)

	setIconIdentifier (string $icon_identifier)

	getIconIdentifier ()

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

	delete ()
	Delete settings. More...

	save ()
	Save settings. More...

	update ()
	Update settings @global ilDB $ilDB. More...

	toXml (ilXmlWriter $writer)
	Export. More...

	__clone ()
	Implemented clone method. More...

	getTranslationObject ()

	isEffective ($a_node_id)

Data Fields
const	TYPE_CREATION = 1

Protected Member Functions
	setId ($a_id)
	Set id. More...

	getPresentation ($a_value, $a_lng)

	saveEffectiveNodes ()

	deleteEffectiveNodes ()

	readEffectiveNodes ()

	read ()
	read settings from db More...

Private Member Functions
	setAutoGenerated ($auto_generated)
	DO NOT CHANGE THIS VALUE. More...

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

	saveAssignment ($a_obj_type)
	Add one object assignment @global ilDB $ilDB. More...

	deleteAssignments ()
	Delete assignments @global ilDB $ilDB. More...

Private Attributes
	$id = 0

	$enabled = false

	$title = ''

	$description = ''

	$info = ''

	$type = self::TYPE_CREATION

	$assignments = array()

	$effective_from = array()

	$auto_generated = false

	$exclusive = false

	$icon_ide = ''

	$iconHandler = null

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateSetting::__construct ( $a_id = 0 )

Constructor.

Parameters

int $a_id

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

    {
        $this->setId($a_id);
        $this->read();
        $this->iconHandler = new ilDidacticTemplateIconHandler($this);
    }

References read(), and setId().

Here is the call graph for this function:

Member Function Documentation

◆ __clone()

ilDidacticTemplateSetting::__clone ( )

Implemented clone method.

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

    {
        $this->setId(0);
        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateCopier.php';
        $this->setTitle(ilDidacticTemplateCopier::appendCopyInfo($this->getTitle()));
        $this->enable(false);
        $this->setAutoGenerated(false);
        $this->iconHandler = new ilDidacticTemplateIconHandler($this);
    }

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

Here is the call graph for this function:

◆ addAssignment()

ilDidacticTemplateSetting::addAssignment ( $a_obj_type )

Add one assignment obj type.

Parameters

string $a_obj_type

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

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

Referenced by read().

Here is the caller graph for this function:

◆ delete()

ilDidacticTemplateSetting::delete ( )

Delete settings.

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($this->isAutoGenerated()) {
            return false;
        }
 
        // Delete settings
        $query = 'DELETE FROM didactic_tpl_settings ' .
            'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
 
        // Delete obj assignments
        $query = 'DELETE FROM didactic_tpl_sa ' .
            'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
 
        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateActionFactory.php';
        foreach (ilDidacticTemplateActionFactory::getActionsByTemplateId($this->getId()) as $action) {
            $action->delete();
        }
 
        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
        ilDidacticTemplateObjSettings::deleteByTemplateId($this->getId());
 
        $this->getTranslationObject()->delete();
        $this->deleteEffectiveNodes();
        $this->getIconHandler()->delete();
        return true;
    }

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

Referenced by ilDidacticTemplateImport\parseActions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAssignments()

ilDidacticTemplateSetting::deleteAssignments ( )

private

Delete assignments @global ilDB $ilDB.

Returns: bool

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($this->isAutoGenerated()) {
            return false;
        }
 
        $query = 'DELETE FROM didactic_tpl_sa ' .
            'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
        return true;
    }

References $DIC, $ilDB, $query, getId(), and isAutoGenerated().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteEffectiveNodes()

ilDidacticTemplateSetting::deleteEffectiveNodes ( )

protected

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = 'DELETE FROM didactic_tpl_en ' .
            'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
        return true;
    }

References $DIC, $ilDB, $query, and getId().

Referenced by delete(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ enable()

ilDidacticTemplateSetting::enable ( $a_status )

Set enabled status.

Parameters

bool $a_status

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

    {
        $this->enabled = $a_status;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

◆ getAssignments()

ilDidacticTemplateSetting::getAssignments ( )

Get object assignemnts.

Returns: array

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

    {
        return (array) $this->assignments;
    }

References $assignments.

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

Here is the caller graph for this function:

◆ getDescription()

ilDidacticTemplateSetting::getDescription ( )

Get description.

Returns: string

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

    {
        return $this->description;
    }

References $description.

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

Here is the caller graph for this function:

◆ getEffectiveFrom()

ilDidacticTemplateSetting::getEffectiveFrom ( )

Returns: int[]

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

    {
        return $this->effective_from;
    }

References $effective_from.

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

Here is the caller graph for this function:

◆ getIconHandler()

ilDidacticTemplateSetting::getIconHandler ( )

Returns: ilDidacticTemplateIconHandler

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

                                     : ilDidacticTemplateIconHandler
    {
        return $this->iconHandler;
    }

References $iconHandler.

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

Here is the caller graph for this function:

◆ getIconIdentifier()

ilDidacticTemplateSetting::getIconIdentifier ( )

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

                                        : string
    {
        return $this->icon_ide;
    }

References $icon_ide.

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

Here is the caller graph for this function:

◆ getId()

ilDidacticTemplateSetting::getId ( )

Get id.

Returns: int

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

    {
        return $this->id;
    }

References $id.

Referenced by delete(), deleteAssignments(), deleteEffectiveNodes(), getTranslationObject(), ilDidacticTemplateImport\parseActions(), read(), readEffectiveNodes(), save(), saveAssignment(), saveEffectiveNodes(), toXml(), and update().

Here is the caller graph for this function:

◆ getInfo()

ilDidacticTemplateSetting::getInfo ( )

Get installation info text.

Returns: string

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

    {
        return $this->info;
    }

References $info.

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

Here is the caller graph for this function:

◆ getPresentation()

ilDidacticTemplateSetting::getPresentation	(	$a_value,
		$a_lng
	)

protected

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

    {
        $lang = $this->getTranslationObject()->getLanguages();
 
        if (!$lang) {
            return "";
        }
 
        if (!$a_lng) {
            global $DIC;
 
            $ilUser = $DIC['ilUser'];
            $a_lng = $ilUser->getCurrentLanguage();
        }
 
        if (isset($lang[$a_lng][$a_value])) {
            return $lang[$a_lng][$a_value] ;
        } else {
            return $lang[$a_lng][$this->getTranslationObject()->getDefaultLanguage()];
        }
    }

References $DIC, $ilUser, $lang, and getTranslationObject().

Referenced by getPresentationDescription(), and getPresentationTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPresentationDescription()

ilDidacticTemplateSetting::getPresentationDescription ( $a_lng = "" )

Parameters

string $a_lng

Returns: string

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

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

References $DIC, $lng, getDescription(), getPresentation(), and isAutoGenerated().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPresentationTitle()

ilDidacticTemplateSetting::getPresentationTitle ( $a_lng = "" )

Parameters

string $a_lng

Returns: string

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

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

References $DIC, $lng, getPresentation(), getTitle(), and isAutoGenerated().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilDidacticTemplateSetting::getTitle ( )

Get title.

Returns: string

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

    {
        return $this->title;
    }

References $title.

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

Here is the caller graph for this function:

◆ getTranslationObject()

ilDidacticTemplateSetting::getTranslationObject ( )

Returns: ilMultilingualism

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

    {
        include_once("./Services/Multilingualism/classes/class.ilMultilingualism.php");
        return ilMultilingualism::getInstance($this->getId(), "dtpl");
    }

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

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

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

@access public

Returns: array

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

    {
        $trans = $this->getTranslationObject();
        $lang = $trans->getLanguages();
 
        foreach ($lang as $k => $v) {
            if ($v['lang_default']) {
                $lang[0] = $lang[$k];
            }
        }
 
        // 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;
    }

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

Referenced by ilDidacticTemplateSettingsGUI\initEditTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilDidacticTemplateSetting::getType ( )

Get type.

Returns: int

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

    {
        return $this->type;
    }

References $type.

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

Here is the caller graph for this function:

◆ hasIconSupport()

ilDidacticTemplateSetting::hasIconSupport ( ilObjectDefinition $definition )

Parameters

ilObjectDefinition $definition

Returns: bool

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

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

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

Here is the call graph for this function:

◆ isAutoGenerated()

ilDidacticTemplateSetting::isAutoGenerated ( )

Returns: bool

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

    {
        return $this->auto_generated;
    }

References $auto_generated.

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

Here is the caller graph for this function:

◆ isEffective()

ilDidacticTemplateSetting::isEffective ( $a_node_id )

Parameters

int $a_node_id

Returns: bool

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

    {
        global $DIC;
 
        $tree = $DIC['tree'];
 
        if (!count($this->getEffectiveFrom()) || in_array($a_node_id, $this->getEffectiveFrom())) {
            return true;
        }
        
        foreach ($this->getEffectiveFrom() as $node) {
            if ($tree->isGrandChild($node, $a_node_id)) {
                return true;
            }
        }
        
        return false;
    }

References $DIC, and getEffectiveFrom().

Here is the call graph for this function:

◆ isEnabled()

ilDidacticTemplateSetting::isEnabled ( )

Check if template is enabled.

Returns: bool

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

    {
        return $this->enabled;
    }

References $enabled.

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

Here is the caller graph for this function:

◆ isExclusive()

ilDidacticTemplateSetting::isExclusive ( )

Returns: boolean

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

    {
        return $this->exclusive;
    }

References $exclusive.

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

Here is the caller graph for this function:

◆ read()

ilDidacticTemplateSetting::read ( )

protected

read settings from db

Returns: bool

Read settings

Read assigned objects

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if (!$this->getId()) {
            return false;
        }
 
        $query = 'SELECT * FROM didactic_tpl_settings dtpl ' .
            'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setType($row->type);
            $this->enable($row->enabled);
            $this->setTitle($row->title);
            $this->setDescription($row->description);
            $this->setInfo($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 = ' . $ilDB->quote($this->getId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->addAssignment($row->obj_type);
        }
        
        $this->readEffectiveNodes();
 
        return true;
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readEffectiveNodes()

ilDidacticTemplateSetting::readEffectiveNodes ( )

protected

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

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

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, getId(), and setEffectiveFrom().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilDidacticTemplateSetting::save ( )

Save settings.

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

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

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

Here is the call graph for this function:

◆ saveAssignment()

ilDidacticTemplateSetting::saveAssignment ( $a_obj_type )

private

Add one object assignment @global ilDB $ilDB.

Parameters

string $a_obj_type

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

    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        if ($this->isAutoGenerated()) {
            return;
        }
 
        $query = 'INSERT INTO didactic_tpl_sa (id,obj_type) ' .
            'VALUES( ' .
            $ilDB->quote($this->getId(), 'integer') . ', ' .
            $ilDB->quote($a_obj_type, 'text') .
            ')';
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, $query, getId(), and isAutoGenerated().

Referenced by saveAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveAssignments()

ilDidacticTemplateSetting::saveAssignments ( )

private

Save assignments in DB.

Returns: bool

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

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

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

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveEffectiveNodes()

ilDidacticTemplateSetting::saveEffectiveNodes ( )

protected

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

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

References $DIC, $ilDB, $query, getEffectiveFrom(), and getId().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAssignments()

ilDidacticTemplateSetting::setAssignments ( array $a_ass )

Set assignments.

Parameters

array $a_ass

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

    {
        $this->assignments = (array) $a_ass;
    }

◆ setAutoGenerated()

ilDidacticTemplateSetting::setAutoGenerated ( $auto_generated )

private

DO NOT CHANGE THIS VALUE.

Parameters

bool $auto_generated

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

    {
        $this->auto_generated = $auto_generated;
    }

References $auto_generated.

Referenced by __clone(), and read().

Here is the caller graph for this function:

◆ setDescription()

ilDidacticTemplateSetting::setDescription ( $a_description )

Set description.

Parameters

string $a_description

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

    {
        $this->description = $a_description;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setEffectiveFrom()

ilDidacticTemplateSetting::setEffectiveFrom ( $effective_from )

Parameters

int[] $effective_from

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

    {
        $this->effective_from = $effective_from;
    }

References $effective_from.

Referenced by readEffectiveNodes().

Here is the caller graph for this function:

◆ setExclusive()

ilDidacticTemplateSetting::setExclusive ( $exclusive )

Parameters

boolean $exclusive

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

    {
        $this->exclusive = $exclusive;
    }

References $exclusive.

Referenced by read().

Here is the caller graph for this function:

◆ setIconIdentifier()

ilDidacticTemplateSetting::setIconIdentifier ( string $icon_identifier )

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

    {
        $this->icon_ide = $icon_identifier;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setId()

ilDidacticTemplateSetting::setId ( $a_id )

protected

Set id.

Parameters

int $a_id

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

    {
        $this->id = $a_id;
    }

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

Here is the caller graph for this function:

◆ setInfo()

ilDidacticTemplateSetting::setInfo ( $a_info )

Set installation info text.

Parameters

string $a_info

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

    {
        $this->info = $a_info;
    }

References info().

Referenced by read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setTitle()

ilDidacticTemplateSetting::setTitle ( $a_title )

Set title.

Parameters

string $a_title

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

    {
        $this->title = $a_title;
    }

Referenced by __clone(), and read().

Here is the caller graph for this function:

◆ setType()

ilDidacticTemplateSetting::setType ( $a_type )

Set type.

Parameters

int $a_type

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

    {
        $this->type = $a_type;
    }

Referenced by read().

Here is the caller graph for this function:

◆ toXml()

ilDidacticTemplateSetting::toXml ( ilXmlWriter $writer )

Export.

Parameters

ilXmlWriter $writer

Returns: ilXmlWriter

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

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

References $DIC, $ilSetting, $info, $type, ilDidacticTemplateActionFactory\getActionsByTemplateId(), getAssignments(), getDescription(), getEffectiveFrom(), getIconHandler(), getId(), getInfo(), getTitle(), getTranslationObject(), getType(), isExclusive(), TYPE_CREATION, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Here is the call graph for this function:

◆ update()

ilDidacticTemplateSetting::update ( )

Update settings @global ilDB $ilDB.

Returns: bool

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

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