class.ilDidacticTemplateSetting.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilDidacticTemplateSetting
{
    public const TYPE_CREATION = 1;

    private int $id = 0;
    private bool $enabled = false;
    private string $title = '';
    private string $description = '';
    private string $info = '';
    private int $type = self::TYPE_CREATION;
    private array $assignments = [];
    private array $effective_from = [];
    private bool $auto_generated = false;
    private bool $exclusive = false;
    private string $icon_ide = '';

    private ?ilDidacticTemplateIconHandler $iconHandler = null;

    private ilLanguage $lng;
    private ilObjUser $user;
    private ilDBInterface $db;
    private ilSetting $setting;
    private ilTree $tree;

    public function __construct(int $a_id = 0)
    {
        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);
    }

    public function getIconHandler(): ilDidacticTemplateIconHandler
    {
        return $this->iconHandler;
    }

    protected function setId(int $a_id): void
    {
        $this->id = $a_id;
    }

    public function getId(): int
    {
        return $this->id;
    }

    public function enable(bool $a_status): void
    {
        $this->enabled = $a_status;
    }

    public function isEnabled(): bool
    {
        return $this->enabled;
    }

    public function setTitle(string $a_title): void
    {
        $this->title = $a_title;
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function getPresentationTitle(string $a_lng = ""): string
    {
        if ($this->isAutoGenerated()) {
            return $this->lng->txt($this->getTitle());
        }

        $tit = $this->getPresentation('title', $a_lng);
        return $tit ?: $this->getTitle();
    }

    public function getDescription(): string
    {
        return $this->description;
    }

    public function getPresentationDescription(string $a_lng = ""): string
    {
        if ($this->isAutoGenerated()) {
            return $this->lng->txt($this->getDescription());
        }

        $desc = $this->getPresentation('description', $a_lng);
        return $desc ?: $this->getDescription();
    }

    public function setDescription(string $a_description): void
    {
        $this->description = $a_description;
    }

    public function setInfo(string $a_info): void
    {
        $this->info = $a_info;
    }

    public function getInfo(): string
    {
        return $this->info;
    }

    public function setType(int $a_type): void
    {
        $this->type = $a_type;
    }

    public function getType(): int
    {
        return $this->type;
    }

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

        return true;
    }

    public function setAssignments(array $a_ass): void
    {
        $this->assignments = $a_ass;
    }

    public function getAssignments(): array
    {
        return $this->assignments;
    }

    public function addAssignment(string $a_obj_type): void
    {
        $this->assignments[] = $a_obj_type;
    }

    public function getEffectiveFrom(): array
    {
        return $this->effective_from;
    }

    public function setEffectiveFrom(array $effective_from): void
    {
        $this->effective_from = $effective_from;
    }

    public function isAutoGenerated(): bool
    {
        return $this->auto_generated;
    }

    private function setAutoGenerated(bool $auto_generated): void
    {
        $this->auto_generated = $auto_generated;
    }

    public function isExclusive(): bool
    {
        return $this->exclusive;
    }

    public function setExclusive(bool $exclusive): void
    {
        $this->exclusive = $exclusive;
    }

    public function setIconIdentifier(string $icon_identifier): void
    {
        $this->icon_ide = $icon_identifier;
    }

    public function getIconIdentifier(): string
    {
        return $this->icon_ide;
    }

    public function getTranslations(): 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;
    }

    protected function getPresentation(string $a_value, string $a_lng): 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] ?? '';
    }

    public function delete(): 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;
    }

    public function save(): 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;
    }

    private function saveAssignments(): bool
    {
        if ($this->isAutoGenerated()) {
            return false;
        }

        foreach ($this->getAssignments() as $ass) {
            $this->saveAssignment($ass);
        }

        return true;
    }

    private function saveAssignment(string $a_obj_type): 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);
    }

    protected function saveEffectiveNodes(): 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);
    }

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

        return true;
    }

    protected function readEffectiveNodes(): 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);
    }

    private function deleteAssignments(): 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;
    }

    public function update(): 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;
    }

    protected function read(): 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;
    }

    public function toXml(ilXmlWriter $writer): 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;
    }

    public function __clone()
    {
        $this->setId(0);

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

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

    public function isEffective(int $a_node_id): 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;
    }
}