class.ilDidacticTemplateSettingsTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilDidacticTemplateSettingsTableGUI extends ilTable2GUI
{
    private $ref_id;

    private ilAccessHandler $access;

    public function __construct(object $a_parent_obj, string $a_parent_cmd, int $ref_id)
    {
        global $DIC;
        $this->ref_id = $ref_id;
        parent::__construct($a_parent_obj, $a_parent_cmd);
        $this->setId('tbl_didactic_tpl_settings');

        $this->access = $DIC->access();
    }

    public function init(): void
    {
        $this->addColumn('', 'f', '1px');
        $this->lng->loadLanguageModule('search');
        $this->lng->loadLanguageModule('meta');
        $this->addColumn($this->lng->txt('icon'), '', '5%');
        $this->addColumn($this->lng->txt('search_title_description'), 'title', '30%');
        $this->addColumn($this->lng->txt('didactic_applicable_for'), 'applicable', '20%');
        $this->addColumn($this->lng->txt('didactic_scope'), 'scope', '20%');
        $this->addColumn($this->lng->txt('active'), 'active', '10%');
        $this->addColumn($this->lng->txt('actions'), '', '15%');

        $this->setTitle($this->lng->txt('didactic_available_templates'));

        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $this->addMultiCommand('activateTemplates', $this->lng->txt('activate'));
            $this->addMultiCommand('deactivateTemplates', $this->lng->txt('deactivate'));
            $this->addMultiCommand('confirmDelete', $this->lng->txt('delete'));

            $this->setSelectAllCheckbox('tpls');
        }
        $this->setRowTemplate('tpl.didactic_template_overview_row.html', 'Services/DidacticTemplate');
        $this->setDefaultOrderField('title');
        $this->setDefaultOrderDirection('asc');
        $this->setFormAction($this->ctrl->getFormAction($this->getParentObject()));
    }

    public function parse(ilDidacticTemplateSettingsTableFilter $filter): void
    {
        $tpls = ilDidacticTemplateSettings::getInstance();
        $tpls->readInactive();
        $templates = $filter->filter($tpls->getTemplates());

        $counter = 0;
        $data = [];
        foreach ($templates as $tpl) {
            /* @var $tpl ilDidacticTemplateSetting */
            $data[$counter]['id'] = $tpl->getId();
            $data[$counter]['icon'] = $tpl->getIconHandler()->getAbsolutePath();
            $data[$counter]['title'] = $tpl->getPresentationTitle();
            $data[$counter]['description'] = $tpl->getPresentationDescription();
            $data[$counter]['info'] = $tpl->getInfo();
            $data[$counter]['enabled'] = (int) $tpl->isEnabled();
            $data[$counter]['assignments'] = $tpl->getAssignments();

            $atxt = '';
            foreach ($tpl->getAssignments() as $obj_type) {
                $atxt .= ($this->lng->txt('objs_' . $obj_type) . '<br/>');
            }
            $data[$counter]['applicable'] = $atxt;
            $data[$counter]['automatic_generated'] = $tpl->isAutoGenerated();
            $data[$counter]['scope'] = (array) $tpl->getEffectiveFrom();

            ++$counter;
        }

        $this->setData($data);
    }

    protected function fillRow(array $a_set): void
    {
        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tpl->setVariable('VAL_ID', $a_set['id']);
        }

        $this->tpl->setVariable('VAL_TITLE', $a_set['title']);
        $this->tpl->setVariable('VAL_DESC', $a_set['description']);

        if (($a_set['icon'] ?? '') !== '') {
            $this->tpl->setVariable('ICON_SRC', $a_set['icon']);
            foreach ((array) $a_set['assignments'] as $obj_type) {
                $this->tpl->setVariable('ICON_ALT', $this->lng->txt('objs_' . $obj_type));
            }
        }

        foreach ((array) explode("\n", $a_set['info']) as $info) {
            $trimmed_info = trim($info);
            if ($trimmed_info) {
                $this->tpl->setCurrentBlock('info');
                $this->tpl->setVariable('VAL_INFO', $trimmed_info);
                $this->tpl->parseCurrentBlock();
            }
        }

        if ($a_set['automatic_generated']) {
            $this->tpl->setVariable("VAL_AUTOMATIC_GENERATED", $this->lng->txt("didactic_auto_generated"));
        }

        $this->tpl->setVariable(
            'VAL_IMAGE',
            $a_set['enabled'] ?
                ilUtil::getImagePath('icon_ok.svg') :
                ilUtil::getImagePath('icon_not_ok.svg')
        );
        $this->tpl->setVariable(
            'VAL_ENABLED_TXT',
            $a_set['enabled'] ?
                $this->lng->txt('active') :
                $this->lng->txt('inactive')
        );

        $atxt = '';
        foreach ((array) $a_set['assignments'] as $obj_type) {
            $atxt .= ($this->lng->txt('objs_' . $obj_type) . '<br/>');
        }
        $this->tpl->setVariable('VAL_APPLICABLE', $atxt);

        $this->ctrl->setParameterByClass(
            get_class($this->getParentObject()),
            'tplid',
            $a_set['id']
        );

        if (count($a_set['scope'])) {
            $this->tpl->setCurrentBlock('scope_txt');
            $this->tpl->setVariable('LOCAL_OR_GLOBAL', $this->lng->txt('didactic_scope_list_header'));
            $this->tpl->parseCurrentBlock();

            foreach ($a_set['scope'] as $ref_id) {
                $this->tpl->setCurrentBlock('scope_entry');
                $this->tpl->setVariable('LINK_HREF', ilLink::_getLink($ref_id));
                $this->tpl->setVariable('LINK_NAME', ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)));
                $this->tpl->parseCurrentBlock();
            }
        } else {
            $this->tpl->setCurrentBlock('scope_txt');
            $this->tpl->setVariable(
                'LOCAL_OR_GLOBAL',
                isset($a_set['local']) ? $this->lng->txt('meta_local') : $this->lng->txt('meta_global')
            );
            $this->tpl->parseCurrentBlock();
        }

        if ($this->access->checkAccess('write', '', $this->ref_id)) {
            $actions = new ilAdvancedSelectionListGUI();
            $actions->setId((string) $a_set['id']);
            $actions->setListTitle($this->lng->txt("actions"));
            // Edit
            $actions->addItem(
                $this->lng->txt('settings'),
                '',
                $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'editTemplate')
            );

            // Copy
            $actions->addItem(
                $this->lng->txt('copy'),
                '',
                $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'copyTemplate')
            );

            // Export
            if (!$a_set['automatic_generated']) {
                $actions->addItem(
                    $this->lng->txt('didactic_do_export'),
                    '',
                    $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'exportTemplate')
                );
            }
            $this->tpl->setVariable('ACTION_DROPDOWN', $actions->getHTML());
        } elseif (!$a_set['automatic_generated']) {
            //don't use dropdown if just one item is given ...
            // Export
            $this->tpl->setCurrentBlock('action_link');
            $this->tpl->setVariable(
                'A_LINK',
                $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'exportTemplate')
            );
            $this->tpl->setVariable('A_TEXT', $this->lng->txt('didactic_do_export'));
            $this->tpl->parseCurrentBlock();
        } else {
            $this->tpl->touchBlock('action_link');
        }
    }
}