ilDidacticTemplateSettingsGUI Class Reference

Settings for a single didactic template. More...

Collaboration diagram for ilDidacticTemplateSettingsGUI:

Public Member Functions
	__construct (ilObjectGUI $a_parent_obj)
	executeCommand ()
	applyFilter ()
	resetFilter ()
	showEditImportForm (?ilPropertyFormGUI $form=null)
	editImportForm ()
	editImport (ilDidacticTemplateSetting $a_settings)

Protected Member Functions
	initReferenceFromRequest ()
	initTemplatesFromRequest ()
	transforms selected tpls from post to SplFixedArray More...
	initTemplateFromRequest ()
	handleTableActions ()
	overview ()
	showImportForm (?ilPropertyFormGUI $form=null)
	createImportForm ()
	checkInput (ilPropertyFormGUI $form, ilDidacticTemplateImport $import)
	importTemplate ()
	editTemplate (?int $template_id=null, ?ilPropertyFormGUI $form=null)
	updateTemplate ()
	handleUpdateFailure (ilPropertyFormGUI $form)
	initEditTemplate (ilDidacticTemplateSetting $set)
	copyTemplate (int $template_id)
	exportTemplate (int $template_id)
	confirmDelete (array $template_ids)
	deleteTemplates ()
	activateTemplates (array $template_ids)
	deactivateTemplates (array $template_ids)
	setEditTabs (string $a_tab_active="edit")

Protected Attributes
UIRenderer	$renderer
UIFactory	$ui_factory
StaticURLService	$static_url
DataFactory	$data_factory

Private Attributes
ilLogger	$logger
ilDidacticTemplateSetting	$setting = null
Container	$dic
ilLanguage	$lng
ilRbacSystem	$rbacsystem
ilCtrl	$ctrl
ilAccessHandler	$access
ilToolbarGUI	$toolbar
ilObjectDefinition	$objDefinition
GlobalHttpState	$http
Factory	$refinery
ilGlobalTemplateInterface	$tpl
ilTabsGUI	$tabs
FileUpload	$upload
LOMServices	$lom_services
int	$ref_id

Detailed Description

Settings for a single didactic template.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

ilDidacticTemplateSettingsGUI: ilObjRoleFolderGUI ilDidacticTemplateSettingsGUI: ilMultilingualismGUI, ilPropertyFormGUI

Definition at line 43 of file class.ilDidacticTemplateSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilDidacticTemplateSettingsGUI::__construct

(

ilObjectGUI

$a_parent_obj

)

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ILIAS\Repository\refinery(), renderer(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\upload().

    {
        global $DIC;
        $this->lng = $DIC->language();
        $this->rbacsystem = $DIC->rbac()->system();
        $this->ctrl = $DIC->ctrl();
        $this->objDefinition = $DIC['objDefinition'];
        $this->access = $DIC->access();
        $this->toolbar = $DIC->toolbar();
        $this->http = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->logger = $DIC->logger()->otpl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->upload = $DIC->upload();
        $this->renderer = $DIC->ui()->renderer();
        $this->ui_factory = $DIC->ui()->factory();
        $this->lom_services = $DIC->learningObjectMetadata();
        $this->static_url = $DIC['static_url'];
        $this->data_factory = new DataFactory();
    }

Here is the call graph for this function:

Member Function Documentation

activateTemplates()

ilDidacticTemplateSettingsGUI::activateTemplates ( array  $template_ids )

protected

Parameters

string[]

$template_ids

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

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\setOnScreenMessage().

Referenced by handleTableActions().

                                                             : void
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->ctrl->redirect($this, "overview");
        }
        if (0 === count($template_ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'overview');
            return;
        }
        foreach ($template_ids as $tplid) {
            $tpl = new ilDidacticTemplateSetting((int) $tplid);
            $tpl->enable(true);
            $tpl->update();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('didactic_activated_msg'), true);
        $this->ctrl->redirect($this, 'overview');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

applyFilter()

ilDidacticTemplateSettingsGUI::applyFilter

(

)

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

References overview().

                                 : void
    {
        $this->overview();
    }

Here is the call graph for this function:

checkInput()

ilDidacticTemplateSettingsGUI::checkInput ( ilPropertyFormGUI  $form, ilDidacticTemplateImport  $import  )

protected

Definition at line 290 of file class.ilDidacticTemplateSettingsGUI.php.

References ilPropertyFormGUI\checkInput(), ILIAS\Export\ImportStatus\FAILED, ilPropertyFormGUI\getInput(), ilFileUtils\ilTempnam(), ilFileUtils\moveUploadedFile(), ilDidacticTemplateImport\setInputFile(), ilPropertyFormGUI\setValuesByPost(), and ilDidacticTemplateImport\validateImportFile().

Referenced by importTemplate().

     : ilImportStatusCollection {
        $status = new ilImportStatusFactory();

        if (!$form->checkInput()) {
            $form->setValuesByPost();
            return $status->collection();
        }

        $file = $form->getInput('file');
        $tmp = ilFileUtils::ilTempnam() . '.xml';

        // move uploaded file
        ilFileUtils::moveUploadedFile(
            $file['tmp_name'],
            $file['name'],
            $tmp
        );
        $import->setInputFile($tmp);
        $statuses = $import->validateImportFile();

        if (!$statuses->hasStatusType(ImportStatusType::FAILED)) {
            $statuses = $statuses->withAddedStatus($status->handler()
                ->withType(ImportStatusType::SUCCESS)
                ->withContent($status->content()->builder()->string()->withString('')));
        }
        return $statuses;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDelete()

ilDidacticTemplateSettingsGUI::confirmDelete ( array  $template_ids )

protected

Parameters

string[]

$template_ids

Definition at line 631 of file class.ilDidacticTemplateSettingsGUI.php.

References $id, ILIAS\Repository\ctrl(), exit, ilDidacticTemplateSettings\getInstance(), ILIAS\Repository\lng(), and renderer().

Referenced by handleTableActions().

                                                         : never
    {
        $this->ctrl->setParameterByClass(ilDidacticTemplateSettingsGUI::class, 'tpls', implode(',', $template_ids));
        $del_action = $this->ctrl->getLinkTarget($this, 'deleteTemplates');
        $this->ctrl->clearParameterByClass(ilDidacticTemplateSettingsGUI::class, 'tpls');
        $items = [];
        $tpls = ilDidacticTemplateSettings::getInstance();
        $tpls->readInactive();
        $templates = $tpls->getTemplates();
        foreach ($templates as $template) {
            foreach ($template_ids as $id) {
                if ((int) $id !== $template->getId()) {
                    continue;
                }
                $items[] = $this->ui_factory->modal()->interruptiveItem()->standard(
                    $id,
                    $template->getTitle()
                );
            }
        }
        echo($this->renderer->renderAsync([
            $this->ui_factory->modal()->interruptive(
                $this->lng->txt('delete'),
                $this->lng->txt('modal_confirm_deletion_text'),
                $del_action
            )
                ->withAffectedItems($items)
                ->withAdditionalOnLoadCode(static fn($id): string => "console.log('ASYNC JS');")
        ]));
        exit();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

copyTemplate()

ilDidacticTemplateSettingsGUI::copyTemplate ( int  $template_id )

protected

Definition at line 604 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilDidacticTemplateSetting\getId(), ILIAS\Repository\lng(), and ilDidacticTemplateCopier\start().

Referenced by handleTableActions().

                                                     : void
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->ctrl->redirect($this, "overview");
        }
        $setting = ($this->setting = new ilDidacticTemplateSetting($template_id));
        $copier = new ilDidacticTemplateCopier($setting->getId());
        $copier->start();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('didactic_copy_suc_message'), true);
        $this->ctrl->redirect($this, 'overview');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createImportForm()

ilDidacticTemplateSettingsGUI::createImportForm ( )

protected

Definition at line 265 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilImageFileInputGUI\setAllowDeletion(), and ilFileInputGUI\setSuffixes().

Referenced by importTemplate(), and showImportForm().

                                         : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setShowTopButtons(false);
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('didactic_import_table_title'));
        $form->addCommandButton('importTemplate', $this->lng->txt('import'));
        $form->addCommandButton('overview', $this->lng->txt('cancel'));

        $file = new ilFileInputGUI($this->lng->txt('import_file'), 'file');
        $file->setSuffixes(['xml']);
        $file->setRequired(true);
        $form->addItem($file);

        $icon = new ilImageFileInputGUI($this->lng->txt('icon'), 'icon');
        $icon->setAllowDeletion(false);
        $icon->setSuffixes(['svg']);
        $icon->setInfo($this->lng->txt('didactic_icon_info'));
        $form->addItem($icon);

        $created = true;

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deactivateTemplates()

ilDidacticTemplateSettingsGUI::deactivateTemplates ( array  $template_ids )

protected

Parameters

string[]

$template_ids

Definition at line 710 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\setOnScreenMessage().

Referenced by handleTableActions().

                                                               : void
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->ctrl->redirect($this, "overview");
        }
        if (0 === count($template_ids)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'overview');
        }
        foreach ($template_ids as $tplid) {
            $tpl = new ilDidacticTemplateSetting((int) $tplid);
            $tpl->enable(false);
            $tpl->update();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('didactic_deactivated_msg'), true);
        $this->ctrl->redirect($this, 'overview');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteTemplates()

ilDidacticTemplateSettingsGUI::deleteTemplates ( )

protected

Parameters

string[]

$template_ids

Definition at line 666 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), initTemplatesFromRequest(), ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\setOnScreenMessage().

                                        : void
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->ctrl->redirect($this, "overview");
        }
        $template_ids = $this->initTemplatesFromRequest();
        if (0 === count($template_ids) || $template_ids[0] === '') {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            //$this->ctrl->redirect($this, 'overview');
            return;
        }
        foreach ($template_ids as $tplid) {
            $tpl = new ilDidacticTemplateSetting((int) $tplid);
            $tpl->delete();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('didactic_delete_msg'), true);
        $this->ctrl->redirect($this, 'overview');
    }

Here is the call graph for this function:

editImport()

ilDidacticTemplateSettingsGUI::editImport

(

ilDidacticTemplateSetting

$a_settings

)

Definition at line 793 of file class.ilDidacticTemplateSettingsGUI.php.

References ilDidacticTemplateObjSettings\assignTemplate(), ILIAS\Repository\ctrl(), ilDidacticTemplateSetting\delete(), ilDidacticTemplateObjSettings\getAssignmentsByTemplateID(), ilDidacticTemplateSetting\getId(), and ilDidacticTemplateObjSettings\transferAutoGenerateStatus().

Referenced by importTemplate().

                                                                     : void
    {
        ilDidacticTemplateObjSettings::transferAutoGenerateStatus($a_settings->getId(), $a_settings->getId());
        $assignments = ilDidacticTemplateObjSettings::getAssignmentsByTemplateID($a_settings->getId());
        $a_settings->delete();
        foreach ($assignments as $obj) {
            ilDidacticTemplateObjSettings::assignTemplate($obj["ref_id"], $obj["obj_id"], $a_settings->getId());
        }
        $this->ctrl->setParameter($this, "tplid", $a_settings->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editImportForm()

ilDidacticTemplateSettingsGUI::editImportForm

(

)

Definition at line 775 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by importTemplate(), and showEditImportForm().

                                    : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setShowTopButtons(false);
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('didactic_import_table_title'));
        $form->addCommandButton('importTemplate', $this->lng->txt('import'));
        $form->addCommandButton('overview', $this->lng->txt('cancel'));

        $file = new ilFileInputGUI($this->lng->txt('didactic_template_update_import'), 'file');
        $file->setRequired(true);
        $file->setSuffixes(['xml']);
        $file->setInfo($this->lng->txt('didactic_template_update_import_info'));
        $form->addItem($file);

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

editTemplate()

ilDidacticTemplateSettingsGUI::editTemplate ( ?int  $template_id = null, ?ilPropertyFormGUI  $form = null  )

protected

Definition at line 385 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\ctrl(), initEditTemplate(), initTemplateFromRequest(), ILIAS\Repository\lng(), null, and setEditTabs().

Referenced by handleTableActions(), and handleUpdateFailure().

                                                                                              : void
    {
        $setting = null;
        if (is_null($template_id)) {
            $setting = $this->initTemplateFromRequest();
        } else {
            $setting = ($this->setting = new ilDidacticTemplateSetting($template_id));
            $this->ctrl->setParameter($this, 'tplid', $template_id);
        }
        if (!$setting instanceof ilDidacticTemplateSetting) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'overview');
        }
        $this->setEditTabs("edit");
        $this->ctrl->saveParameter($this, 'tplid');
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initEditTemplate($this->setting);
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilDidacticTemplateSettingsGUI::executeCommand

(

)

PhpMissingBreakStatementInspection

Definition at line 126 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), initEditTemplate(), initReferenceFromRequest(), initTemplateFromRequest(), ilDidacticTemplateSetting\isAutoGenerated(), setEditTabs(), and ilMultilingualismGUI\setStartValues().

                                    : string
    {
        $this->initReferenceFromRequest();

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        switch ($next_class) {
            case "ilpropertyformgui":
                $setting = $this->initTemplateFromRequest();
                if (!$setting instanceof ilDidacticTemplateSetting) {
                    $setting = new ilDidacticTemplateSetting();
                }
                $form = $this->initEditTemplate($setting);
                $this->ctrl->forwardCommand($form);
                // no break
            case 'ilmultilingualismgui':
                $setting = $this->initTemplateFromRequest();
                if (
                    !$this->access->checkAccess('write', '', $this->ref_id) ||
                    !$setting instanceof ilDidacticTemplateSetting ||
                    $setting->isAutoGenerated()) {
                    $this->ctrl->redirect($this, "overview");
                }
                $this->setEditTabs("settings_trans");
                $transgui = new ilMultilingualismGUI($this->setting->getId(), 'dtpl');
                $defaultl = $this->setting->getTranslationObject()->getDefaultLanguage();
                $transgui->setStartValues(
                    $this->setting->getPresentationTitle($defaultl),
                    $this->setting->getPresentationDescription($defaultl)
                );
                $this->ctrl->forwardCommand($transgui);
                break;
            default:
                if (!$cmd) {
                    $cmd = 'overview';
                }
                $this->$cmd();
                break;
        }
        return '';
    }

Here is the call graph for this function:

exportTemplate()

ilDidacticTemplateSettingsGUI::exportTemplate ( int  $template_id )

protected

Definition at line 616 of file class.ilDidacticTemplateSettingsGUI.php.

References ilUtil\deliverData(), ilDidacticTemplateSetting\getId(), and ilDidacticTemplateXmlWriter\write().

Referenced by handleTableActions().

                                                       : void
    {
        $setting = ($this->setting = new ilDidacticTemplateSetting($template_id));
        $writer = new ilDidacticTemplateXmlWriter($setting->getId());
        $writer->write();
        ilUtil::deliverData(
            $writer->xmlDumpMem(true),
            $writer->getSetting()->getTitle() . '.xml',
            'application/xml'
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

handleTableActions()

ilDidacticTemplateSettingsGUI::handleTableActions ( )

protected

Definition at line 170 of file class.ilDidacticTemplateSettingsGUI.php.

References activateTemplates(), confirmDelete(), copyTemplate(), deactivateTemplates(), editTemplate(), exportTemplate(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                           : void
    {
        $query = $this->http->wrapper()->query();
        if (!$query->has('didactic_template_table_action')) {
            return;
        }
        $action = $query->retrieve('didactic_template_table_action', $this->refinery->to()->string());

        $ids = $this->http->wrapper()->query()->retrieve(
            'didactic_template_template_ids',
            $this->refinery->custom()->transformation(function ($q_ids) {
                if (is_array($q_ids)) {
                    return $q_ids;
                }
                return strlen($q_ids) > 0 ? explode(',', $q_ids) : [];
            })
        );

        switch ($action) {
            case 'editTemplate':
                $this->editTemplate((int) $ids[0]);
                break;
            case 'exportTemplate':
                $this->exportTemplate((int) $ids[0]);
                break;
            case 'copyTemplate':
                $this->copyTemplate((int) $ids[0]);
                break;
            case 'activateTemplates':
                $this->activateTemplates($ids);
                break;
            case 'deactivateTemplates':
                $this->deactivateTemplates($ids);
                break;
            case 'confirmDelete':
                $this->confirmDelete($ids);
                break;
        }
    }

Here is the call graph for this function:

handleUpdateFailure()

ilDidacticTemplateSettingsGUI::handleUpdateFailure ( ilPropertyFormGUI  $form )

protected

Definition at line 469 of file class.ilDidacticTemplateSettingsGUI.php.

References editTemplate(), ILIAS\Repository\lng(), null, and ilPropertyFormGUI\setValuesByPost().

Referenced by updateTemplate().

                                                                   : void
    {
        $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
        $form->setValuesByPost();
        $this->editTemplate(null, $form);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importTemplate()

ilDidacticTemplateSettingsGUI::importTemplate ( )

protected

Definition at line 321 of file class.ilDidacticTemplateSettingsGUI.php.

References Vendor\Package\$e, ILIAS\Repository\access(), checkInput(), createImportForm(), ILIAS\Repository\ctrl(), editImport(), editImportForm(), ILIAS\Export\ImportStatus\FAILED, ilDidacticTemplateImport\IMPORT_FILE, initTemplateFromRequest(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), showEditImportForm(), showImportForm(), and ILIAS\Repository\upload().

                                       : void
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->ctrl->redirect($this, "overview");
        }

        $setting = $this->initTemplateFromRequest();
        if ($setting instanceof ilDidacticTemplateSetting) {
            $form = $this->editImportForm();
        } else {
            $form = $this->createImportForm();
        }

        $import = new ilDidacticTemplateImport(ilDidacticTemplateImport::IMPORT_FILE);
        $statuses = $this->checkInput($form, $import);

        if (!$statuses->hasStatusType(ImportStatusType::SUCCESS)) {
            $error_msg = ($statuses->getCollectionOfAllByType(ImportStatusType::FAILED)->count() > 0)
                ? $statuses
                ->withNumberingEnabled(true)
                ->toString(ImportStatusType::FAILED)
                : '';
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('didactic_import_failed') . $error_msg
            );
            if ($setting instanceof ilDidacticTemplateSetting) {
                $this->showEditImportForm($form);
            } else {
                $this->showImportForm($form);
            }
            return;
        }

        try {
            $settings = $import->import();
            if ($setting instanceof ilDidacticTemplateSetting) {
                $this->editImport($settings);
            } elseif ($settings->hasIconSupport($this->objDefinition)) {
                $settings->getIconHandler()->handleUpload($this->upload, $_FILES['icon']['tmp_name']);
            }
        } catch (ilDidacticTemplateImportException $e) {
            $this->logger->error('Import failed with message: ' . $e->getMessage());
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('didactic_import_failed') . ': ' . $e->getMessage(),
                true
            );
            $this->ctrl->redirect($this, 'importTemplate');
        }

        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('didactic_import_success'),
            true
        );

        if ($setting instanceof ilDidacticTemplateSetting) {
            $this->ctrl->redirect($this, 'editTemplate');
        } else {
            $this->ctrl->redirect($this, 'overview');
        }
    }

Here is the call graph for this function:

initEditTemplate()

ilDidacticTemplateSettingsGUI::initEditTemplate ( ilDidacticTemplateSetting  $set )

protected

Definition at line 476 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\ctrl(), ilDidacticTemplateSetting\getAssignments(), ilDidacticTemplateSetting\getEffectiveFrom(), ilRepositorySelector2InputGUI\getExplorerGUI(), ilDidacticTemplateSetting\getIconHandler(), ilDidacticTemplateSetting\getInfo(), ilLoggerFactory\getLogger(), ilDidacticTemplateSetting\getPresentationDescription(), ilDidacticTemplateSetting\getPresentationTitle(), ilDidacticTemplateSetting\getTranslations(), ilDidacticTemplateSetting\isAutoGenerated(), ilDidacticTemplateSetting\isEnabled(), ilDidacticTemplateSetting\isExclusive(), ILIAS\Repository\lng(), ilObjectPlugin\lookupTxtById(), ilImageFileInputGUI\setImage(), ilFormPropertyGUI\setRequired(), and ilTextAreaInputGUI\setValue().

Referenced by editTemplate(), executeCommand(), and updateTemplate().

                                                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setShowTopButtons(false);
        $form->setFormAction($this->ctrl->getFormAction($this, 'updateTemplate'));
        $form->setTitle($this->lng->txt('didactic_edit_tpl'));
        $form->addCommandButton('updateTemplate', $this->lng->txt('save'));
        $form->addCommandButton('overview', $this->lng->txt('cancel'));

        // title
        $title = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $title->setSize(40);
        $title->setMaxLength(64);
        $title->setRequired(true);
        //use presentation title if autogenerated is set
        $title->setDisabled($set->isAutoGenerated());

        $def = [];
        if (!$set->isAutoGenerated()) {
            $trans = $set->getTranslations();
            $def = $trans[0]; // default

            if (count($trans) > 1) {
                $language = '';
                foreach ($this->lom_services->dataHelper()->getAllLanguages() as $lom_lang) {
                    if ($lom_lang->value() === ($def["lang_code"] ?? '')) {
                        $language = $lom_lang->presentableLabel();
                    }
                }
                $title->setInfo($this->lng->txt("language") . ": " . $language .
                    ' <a href="' . $this->ctrl->getLinkTargetByClass("ilmultilingualismgui", "listTranslations") .
                    '">&raquo; ' . $this->lng->txt("more_translations") . '</a>');
            }
        }

        if ($set->isAutoGenerated()) {
            $title->setValue($set->getPresentationTitle());
        } elseif (isset($def['title'])) {
            $title->setValue($def["title"]);
        }

        $form->addItem($title);

        // desc
        $desc = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        //use presentation title if autogenerated is set
        if ($set->isAutoGenerated()) {
            $desc->setValue($set->getPresentationDescription());
        } elseif (isset($def['description'])) {
            $desc->setValue($def["description"]);
        }
        $desc->setRows(3);
        $desc->setDisabled($set->isAutoGenerated());
        $form->addItem($desc);

        $icon = new ilImageFileInputGUI($this->lng->txt('didactic_icon'), 'icon');
        $icon->setImage($set->getIconHandler()->getAbsolutePath());
        $icon->setInfo($this->lng->txt('didactic_icon_info'));
        $icon->setAllowDeletion(true);
        $icon->setSuffixes(['svg']);
        $form->addItem($icon);

        // info
        $info = new ilTextAreaInputGUI($this->lng->txt('didactic_install_info'), 'info');
        $info->setValue($set->getInfo());
        $info->setRows(6);
        $form->addItem($info);

        //activate
        $enable = new ilCheckboxInputGUI($this->lng->txt('active'), 'enable');
        $enable->setChecked($set->isEnabled());
        $form->addItem($enable);

        // object type
        if (!$set->isAutoGenerated()) {
            $type = new ilSelectInputGUI($this->lng->txt('obj_type'), 'type');
            $type->setRequired(true);
            $type->setInfo($this->lng->txt('dtpl_obj_type_info'));
            $assigned = $set->getAssignments();
            $type->setValue($assigned[0] ?? '');
            $subs = $this->objDefinition->getSubObjectsRecursively('root', false);
            $options = [];
            foreach (array_merge($subs, ['fold' => 1]) as $obj => $null) {
                ilLoggerFactory::getLogger('root')->dump($null);
                if ($this->objDefinition->isPlugin($obj)) {
                    $options[$obj] = ilObjectPlugin::lookupTxtById($obj, "obj_" . $obj);
                } elseif ($this->objDefinition->isAllowedInRepository($obj)) {
                    $options[$obj] = $this->lng->txt('obj_' . $obj);
                }
            }
            asort($options);

            $type->setOptions($options);
            $form->addItem($type);

            $lokal_templates = new ilCheckboxInputGUI(
                $this->lng->txt("activate_local_didactic_template"),
                "local_template"
            );
            $lokal_templates->setChecked(count($set->getEffectiveFrom()) > 0);
            $lokal_templates->setInfo($this->lng->txt("activate_local_didactic_template_info"));

            //effective from (multinode)

            $effrom = new ilRepositorySelector2InputGUI($this->lng->txt("effective_form"), "effective_from", true);
            //$effrom->setMulti(true);
            $white_list = [];
            foreach ($this->objDefinition->getAllRepositoryTypes() as $type) {
                if ($this->objDefinition->isContainer($type)) {
                    $white_list[] = $type;
                }
            }
            $effrom->getExplorerGUI()->setTypeWhiteList($white_list);
            $effrom->setValue($set->getEffectiveFrom());

            $lokal_templates->addSubItem($effrom);
            $form->addItem($lokal_templates);

            $excl = new ilCheckboxInputGUI($this->lng->txt("activate_exclusive_template"), "exclusive_template");
            $excl->setInfo($this->lng->txt("activate_exclusive_template_info"));
            $excl->setChecked($set->isExclusive());

            $form->addItem($excl);
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initReferenceFromRequest()

ilDidacticTemplateSettingsGUI::initReferenceFromRequest ( )

protected

Definition at line 89 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by executeCommand().

                                                 : void
    {
        if ($this->http->wrapper()->query()->has('ref_id')) {
            $this->ref_id = $this->http->wrapper()->query()->retrieve(
                'ref_id',
                $this->refinery->kindlyTo()->int()
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTemplateFromRequest()

ilDidacticTemplateSettingsGUI::initTemplateFromRequest ( )

protected

Definition at line 113 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\FileDelivery\http(), null, and ILIAS\Repository\refinery().

Referenced by editTemplate(), executeCommand(), importTemplate(), showEditImportForm(), showImportForm(), and updateTemplate().

                                                : ?ilDidacticTemplateSetting
    {
        if ($this->http->wrapper()->query()->has('tplid')) {
            $tpl_id = $this->http->wrapper()->query()->retrieve(
                'tplid',
                $this->refinery->kindlyTo()->int()
            );
            return $this->setting = new ilDidacticTemplateSetting($tpl_id);
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTemplatesFromRequest()

ilDidacticTemplateSettingsGUI::initTemplatesFromRequest ( )

protected

transforms selected tpls from post to SplFixedArray

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

References ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

Referenced by deleteTemplates().

                                                 : SplFixedArray
    {
        if ($this->http->wrapper()->query()->has('tpls')) {
            return SplFixedArray::fromArray(explode(
                ',',
                $this->http->wrapper()->query()->retrieve('tpls', $this->refinery->custom()->transformation(fn($v) => $v))
            ));
        }
        return new SplFixedArray(0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

overview()

ilDidacticTemplateSettingsGUI::overview ( )

protected

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

References ILIAS\Repository\ctrl(), ilDidacticTemplateSettingsTableFilter\init(), ILIAS\Repository\lng(), renderer(), and ILIAS\Repository\toolbar().

Referenced by applyFilter(), and resetFilter().

                                 : void
    {
        if ($this->rbacsystem->checkAccess('write', $this->ref_id)) {
            $this->toolbar->addButton(
                $this->lng->txt('didactic_import_btn'),
                $this->ctrl->getLinkTarget($this, 'showImportForm')
            );
        }
        $filter = new ilDidacticTemplateSettingsTableFilter($this->ctrl->getFormAction($this, 'overview'));
        $filter->init();

        $data_retrieval = new ilDidacticTemplateSettingsTableDataRetrieval(
            $filter,
            $this->lng,
            $this->ui_factory,
            $this->renderer,
            $this->static_url,
            $this->data_factory
        );

        $table = new ilDidacticTemplateSettingsTableGUI($this, $this->ref_id);
        $this->tpl->setContent(
            $filter->render() . $table->getHTML($data_retrieval)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetFilter()

ilDidacticTemplateSettingsGUI::resetFilter

(

)

Definition at line 241 of file class.ilDidacticTemplateSettingsGUI.php.

References overview().

                                 : void
    {
        $this->overview();
    }

Here is the call graph for this function:

setEditTabs()

ilDidacticTemplateSettingsGUI::setEditTabs ( string  $a_tab_active = "edit" )

protected

Definition at line 728 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

Referenced by editTemplate(), executeCommand(), showEditImportForm(), and showImportForm().

                                                                 : void
    {
        $this->lng->loadLanguageModule('obj');
        $this->tabs->clearTargets();
        $this->tabs->setBackTarget(
            $this->lng->txt('didactic_back_to_overview'),
            $this->ctrl->getLinkTarget($this, 'overview')
        );
        $this->ctrl->saveParameter($this, "tplid");

        if (!$this->setting->isAutoGenerated()) {
            $this->tabs->addTab('edit', $this->lng->txt('settings'), $this->ctrl->getLinkTarget($this, 'editTemplate'));
            $this->tabs->addTab(
                'import',
                $this->lng->txt('import'),
                $this->ctrl->getLinkTarget($this, 'showEditImportForm')
            );

            if (in_array($a_tab_active, ['edit', 'settings_trans'])) {
                $this->tabs->addSubTab(
                    'edit',
                    $this->lng->txt('settings'),
                    $this->ctrl->getLinkTarget($this, 'editTemplate')
                );
                $this->tabs->addSubTab(
                    'settings_trans',
                    $this->lng->txt("obj_multilinguality"),
                    $this->ctrl->getLinkTargetByClass(["ilmultilingualismgui"], 'listTranslations')
                );
                $this->tabs->setTabActive('edit');
                $this->tabs->setSubTabActive($a_tab_active);
            } else {
                $this->tabs->setTabActive($a_tab_active);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showEditImportForm()

ilDidacticTemplateSettingsGUI::showEditImportForm

(

?ilPropertyFormGUI

$form = null

)

Definition at line 765 of file class.ilDidacticTemplateSettingsGUI.php.

References editImportForm(), initTemplateFromRequest(), and setEditTabs().

Referenced by importTemplate().

                                                                       : void
    {
        $this->initTemplateFromRequest();
        $this->setEditTabs("import");
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->editImportForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showImportForm()

ilDidacticTemplateSettingsGUI::showImportForm ( ?ilPropertyFormGUI  $form = null )

protected

Definition at line 246 of file class.ilDidacticTemplateSettingsGUI.php.

References createImportForm(), ILIAS\Repository\ctrl(), initTemplateFromRequest(), ILIAS\Repository\lng(), setEditTabs(), and ILIAS\Repository\tabs().

Referenced by importTemplate().

                                                                      : void
    {
        $setting = $this->initTemplateFromRequest();
        if ($setting instanceof ilDidacticTemplateSetting) {
            $this->setEditTabs('import');
        } else {
            $this->tabs->clearTargets();
            $this->tabs->setBackTarget(
                $this->lng->txt('didactic_back_to_overview'),
                $this->ctrl->getLinkTarget($this, 'overview')
            );
        }

        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->createImportForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateTemplate()

ilDidacticTemplateSettingsGUI::updateTemplate ( )

protected

Definition at line 406 of file class.ilDidacticTemplateSettingsGUI.php.

References $lang, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), handleUpdateFailure(), initEditTemplate(), initTemplateFromRequest(), ILIAS\Repository\lng(), and ILIAS\Repository\upload().

                                       : void
    {
        $setting = $this->initTemplateFromRequest();
        $this->ctrl->saveParameter($this, 'tplid');

        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->ctrl->redirect($this, "overview");
        }

        $form = $this->initEditTemplate($this->setting);

        if ($form->checkInput()) {
            $tmp_file = $_FILES['icon']['tmp_name'] ?? '';
            $upload_element = $form->getItemByPostVar('icon');
            if (
                ($tmp_file !== '' || ($tmp_file === '' && $this->setting->getIconIdentifier())) &&
                !$this->objDefinition->isContainer($form->getInput('type')) &&
                !$upload_element->getDeletionFlag()
            ) {
                $form->getItemByPostVar('icon')->setAlert($this->lng->txt('didactic_icon_error'));
                $this->handleUpdateFailure($form);
                return;
            }
            //change default entries if translation is active
            if (count($lang = $this->setting->getTranslationObject()->getLanguages())) {
                $this->setting->getTranslationObject()->setDefaultTitle($form->getInput('title'));
                $this->setting->getTranslationObject()->setDefaultDescription($form->getInput('description'));
                $this->setting->getTranslationObject()->save();
            }

            if (!$this->setting->isAutoGenerated()) {
                $this->setting->setTitle($form->getInput('title'));
                $this->setting->setDescription($form->getInput('description'));
            }

            $this->setting->setInfo($form->getInput('info'));
            $this->setting->enable((bool) $form->getInput('enable'));

            if (!$this->setting->isAutoGenerated()) {
                $this->setting->setAssignments([$form->getInput('type')]);
            }

            if ($form->getInput('local_template') && count($form->getInput('effective_from')) > 0) {
                $this->setting->setEffectiveFrom($form->getInput('effective_from'));
            } else {
                $this->setting->setEffectiveFrom([]);
            }

            $this->setting->setExclusive((bool) $form->getInput('exclusive_template'));

            $this->setting->update();

            $upload = $form->getItemByPostVar('icon');
            if ($upload->getDeletionFlag()) {
                $this->setting->getIconHandler()->delete();
            }
            $this->setting->getIconHandler()->handleUpload($this->upload, $_FILES['icon']['tmp_name']);
            $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'overview');
        }
        $this->handleUpdateFailure($form);
    }

Here is the call graph for this function:

Field Documentation

$access

ilAccessHandler ilDidacticTemplateSettingsGUI::$access

private

Definition at line 53 of file class.ilDidacticTemplateSettingsGUI.php.

$ctrl

ilCtrl ilDidacticTemplateSettingsGUI::$ctrl

private

Definition at line 52 of file class.ilDidacticTemplateSettingsGUI.php.

$data_factory

DataFactory ilDidacticTemplateSettingsGUI::$data_factory

protected

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

$dic

Container ilDidacticTemplateSettingsGUI::$dic

private

Definition at line 49 of file class.ilDidacticTemplateSettingsGUI.php.

$http

GlobalHttpState ilDidacticTemplateSettingsGUI::$http

private

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

$lng

ilLanguage ilDidacticTemplateSettingsGUI::$lng

private

Definition at line 50 of file class.ilDidacticTemplateSettingsGUI.php.

$logger

ilLogger ilDidacticTemplateSettingsGUI::$logger

private

Definition at line 47 of file class.ilDidacticTemplateSettingsGUI.php.

$lom_services

LOMServices ilDidacticTemplateSettingsGUI::$lom_services

private

Definition at line 61 of file class.ilDidacticTemplateSettingsGUI.php.

$objDefinition

ilObjectDefinition ilDidacticTemplateSettingsGUI::$objDefinition

private

Definition at line 55 of file class.ilDidacticTemplateSettingsGUI.php.

$rbacsystem

ilRbacSystem ilDidacticTemplateSettingsGUI::$rbacsystem

private

Definition at line 51 of file class.ilDidacticTemplateSettingsGUI.php.

$ref_id

int ilDidacticTemplateSettingsGUI::$ref_id

private

Definition at line 65 of file class.ilDidacticTemplateSettingsGUI.php.

$refinery

Factory ilDidacticTemplateSettingsGUI::$refinery

private

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

$renderer

UIRenderer ilDidacticTemplateSettingsGUI::$renderer

protected

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

$setting

ilDidacticTemplateSetting ilDidacticTemplateSettingsGUI::$setting = null

private

Definition at line 48 of file class.ilDidacticTemplateSettingsGUI.php.

$static_url

StaticURLService ilDidacticTemplateSettingsGUI::$static_url

protected

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

$tabs

ilTabsGUI ilDidacticTemplateSettingsGUI::$tabs

private

Definition at line 59 of file class.ilDidacticTemplateSettingsGUI.php.

$toolbar

ilToolbarGUI ilDidacticTemplateSettingsGUI::$toolbar

private

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

$tpl

ilGlobalTemplateInterface ilDidacticTemplateSettingsGUI::$tpl

private

Definition at line 58 of file class.ilDidacticTemplateSettingsGUI.php.

$ui_factory

UIFactory ilDidacticTemplateSettingsGUI::$ui_factory

protected

Definition at line 46 of file class.ilDidacticTemplateSettingsGUI.php.

$upload

FileUpload ilDidacticTemplateSettingsGUI::$upload

private

Definition at line 60 of file class.ilDidacticTemplateSettingsGUI.php.

---

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

• components/ILIAS/DidacticTemplate/classes/Setting/class.ilDidacticTemplateSettingsGUI.php