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 ()

	overview ()

	showImportForm (ilPropertyFormGUI $form=null)

	createImportForm ()

	importTemplate ()

	editTemplate (ilPropertyFormGUI $form=null)

	updateTemplate ()

	handleUpdateFailure (ilPropertyFormGUI $form)

	initEditTemplate (ilDidacticTemplateSetting $set)

	copyTemplate ()

	exportTemplate ()

	confirmDelete ()

	deleteTemplates ()

	activateTemplates ()

	deactivateTemplates ()

	setEditTabs (string $a_tab_active="edit")

Private Attributes
ilLogger	$logger

ilObjectGUI	$parent_object

ilDidacticTemplateSetting	$setting = null

Container	$dic

ilLanguage	$lng

ilRbacSystem	$rbacsystem

ilCtrl	$ctrl

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ilObjectDefinition	$objDefinition

RequestInterface	$request

GlobalHttpState	$http

Factory	$refinery

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

FileUpload	$upload

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 33 of file class.ilDidacticTemplateSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilDidacticTemplateSettingsGUI::__construct ( ilObjectGUI $a_parent_obj )

Definition at line 54 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(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), and ILIAS\Repository\upload().

     {
         global $DIC;
         $this->parent_object = $a_parent_obj;
         $this->lng = $DIC->language();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->ctrl = $DIC->ctrl();
         $this->objDefinition = $DIC['objDefinition'];
         $this->request = $DIC->http()->request();
         $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();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activateTemplates()

ilDidacticTemplateSettingsGUI::activateTemplates ( )

protected

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

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

                                           : void
     {
         if (!$this->access->checkAccess('write', '', $this->ref_id)) {
             $this->ctrl->redirect($this, "overview");
         }
         $templates = $this->initTemplatesFromRequest();
         if (0 === count($templates)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'overview');
             return;
         }
 
         foreach ($templates 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:

◆ applyFilter()

ilDidacticTemplateSettingsGUI::applyFilter ( )

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

References overview().

                                  : void
     {
         $table = new ilDidacticTemplateSettingsTableGUI($this, 'overview', $this->ref_id);
         $table->init();
         $table->resetOffset();
         $table->writeFilterToSession();
         $this->overview();
     }

Here is the call graph for this function:

◆ confirmDelete()

ilDidacticTemplateSettingsGUI::confirmDelete ( )

protected

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

References ILIAS\Repository\ctrl(), initTemplatesFromRequest(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setOnScreenMessage().

                                       : void
     {
         $templates = $this->initTemplatesFromRequest();
         if (0 === count($templates)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'overview');
             return;
         }
 
         $confirm = new ilConfirmationGUI();
         $confirm->setHeaderText($this->lng->txt('didactic_confirm_delete_msg'));
         $confirm->setFormAction($this->ctrl->getFormAction($this));
         $confirm->setConfirm($this->lng->txt('delete'), 'deleteTemplates');
         $confirm->setCancel($this->lng->txt('cancel'), 'overview');
 
         $forbidden = [];
         foreach ($templates as $tplid) {
             $tpl = new ilDidacticTemplateSetting((int) $tplid);
 
             if (!$tpl->isAutoGenerated()) {
                 $confirm->addItem('tpls[]', (string) $tpl->getId(), $tpl->getPresentationTitle());
             } else {
                 $forbidden[] = $tpl->getId();
             }
         }
 
         if (count($forbidden) > 0 && count($templates) === 1) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('didactic_cannot_delete_auto_generated'), true);
             $this->ctrl->redirect($this, "overview");
         } elseif (count($forbidden) > 0 && count($templates) > 1) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('didactic_cannot_delete_auto_generated_confirmation'));
         }
 
         $this->tpl->setOnScreenMessage('question', $this->lng->txt('didactic_confirm_delete_msg'));
         $this->tpl->setContent($confirm->getHTML());
     }

Here is the call graph for this function:

◆ copyTemplate()

ilDidacticTemplateSettingsGUI::copyTemplate ( )

protected

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

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

                                      : void
     {
         if (!$this->access->checkAccess('write', '', $this->ref_id)) {
             $this->ctrl->redirect($this, "overview");
         }
 
         $setting = $this->initTemplateFromRequest();
         if (!$setting instanceof ilDidacticTemplateSetting) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->ctrl->redirect($this, 'overview');
             return;
         }
 
         $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:

◆ createImportForm()

ilDidacticTemplateSettingsGUI::createImportForm ( )

protected

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

References ILIAS\LTI\ToolProvider\$created, 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 ( )

protected

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

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

                                             : void
     {
         if (!$this->access->checkAccess('write', '', $this->ref_id)) {
             $this->ctrl->redirect($this, "overview");
         }
 
         $templates = $this->initTemplatesFromRequest();
         if (0 === count($templates)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'overview');
         }
         foreach ($templates 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:

◆ deleteTemplates()

ilDidacticTemplateSettingsGUI::deleteTemplates ( )

protected

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

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

                                         : void
     {
         if (!$this->access->checkAccess('write', '', $this->ref_id)) {
             $this->ctrl->redirect($this, "overview");
         }
         $templates = $this->initTemplatesFromRequest();
         if (0 === count($templates)) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
             $this->ctrl->redirect($this, 'overview');
             return;
         }
 
         foreach ($templates 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 721 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 703 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 ( ilPropertyFormGUI $form = null )

protected

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

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

Referenced by handleUpdateFailure().

                                                                    : void
     {
         $setting = $this->initTemplateFromRequest();
         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 115 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 ( )

protected

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

References ILIAS\Repository\ctrl(), ilUtil\deliverData(), ilDidacticTemplateSetting\getId(), initTemplateFromRequest(), ILIAS\Repository\lng(), and ilDidacticTemplateXmlWriter\write().

                                        : void
     {
         $setting = $this->initTemplateFromRequest();
         if (!$setting instanceof ilDidacticTemplateSetting) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
             $this->ctrl->redirect($this, 'overview');
             return;
         }
         $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:

◆ handleUpdateFailure()

ilDidacticTemplateSettingsGUI::handleUpdateFailure ( ilPropertyFormGUI $form )

protected

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

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

Referenced by updateTemplate().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importTemplate()

ilDidacticTemplateSettingsGUI::importTemplate ( )

protected

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

References Vendor\Package\$e, ILIAS\LTI\ToolProvider\$settings, ILIAS\Repository\access(), createImportForm(), ILIAS\Repository\ctrl(), editImport(), editImportForm(), ilFileUtils\ilTempnam(), ilDidacticTemplateImport\IMPORT_FILE, initTemplateFromRequest(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), ilFileUtils\moveUploadedFile(), 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();
         }
 
         if (!$form->checkInput()) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
             $form->setValuesByPost();
 
             if ($setting instanceof ilDidacticTemplateSetting) {
                 $this->showEditImportForm($form);
             } else {
                 $this->showImportForm($form);
             }
             return;
         }
 
         // Do import
         $import = new ilDidacticTemplateImport(ilDidacticTemplateImport::IMPORT_FILE);
 
         $file = $form->getInput('file');
         $tmp = ilFileUtils::ilTempnam() . '.xml';
 
         // move uploaded file
         ilFileUtils::moveUploadedFile(
             $file['tmp_name'],
             $file['name'],
             $tmp
         );
         $import->setInputFile($tmp);
 
         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());
             $form->setValuesByPost();
 
             if ($setting instanceof ilDidacticTemplateSetting) {
                 $this->showEditImportForm($form);
             } else {
                 $this->showImportForm($form);
             }
             return;
         }
 
         $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 395 of file class.ilDidacticTemplateSettingsGUI.php.

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) {
                 $languages = ilMDLanguageItem::_getLanguages();
                 $title->setInfo($this->lng->txt("language") . ": " . $languages[$def["lang_code"]] .
                     ' <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 73 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 102 of file class.ilDidacticTemplateSettingsGUI.php.

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

Referenced by copyTemplate(), editTemplate(), executeCommand(), exportTemplate(), 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 86 of file class.ilDidacticTemplateSettingsGUI.php.

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

Referenced by activateTemplates(), confirmDelete(), deactivateTemplates(), and deleteTemplates().

                                                  : SplFixedArray
     {
         if ($this->http->wrapper()->post()->has('tpls')) {
             return SplFixedArray::fromArray(
                 $this->http->wrapper()->post()->retrieve(
                     'tpls',
                     $this->refinery->kindlyTo()->listOf(
                         $this->refinery->kindlyTo()->int()
                     )
                 )
             );
         }
 
         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 159 of file class.ilDidacticTemplateSettingsGUI.php.

References ILIAS\Repository\ctrl(), ilDidacticTemplateSettingsTableFilter\init(), ILIAS\Repository\lng(), 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();
 
         $table = new ilDidacticTemplateSettingsTableGUI($this, 'overview', $this->ref_id);
         $table->init();
         $table->parse($filter);
 
         $this->tpl->setContent(
             $filter->render() . $table->getHTML()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilDidacticTemplateSettingsGUI::resetFilter ( )

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

References overview().

                                  : void
     {
         $table = new ilDidacticTemplateSettingsTableGUI($this, 'overview', $this->ref_id);
         $table->init();
         $table->resetOffset();
         $table->resetFilter();
         $this->overview();
     }

Here is the call graph for this function:

◆ setEditTabs()

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

protected

Definition at line 656 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 693 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 198 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 325 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 42 of file class.ilDidacticTemplateSettingsGUI.php.

◆ $ctrl

ilCtrl ilDidacticTemplateSettingsGUI::$ctrl

private

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

◆ $dic

Container ilDidacticTemplateSettingsGUI::$dic

private

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

◆ $http

GlobalHttpState ilDidacticTemplateSettingsGUI::$http

private

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

◆ $lng

ilLanguage ilDidacticTemplateSettingsGUI::$lng

private

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

◆ $logger

ilLogger ilDidacticTemplateSettingsGUI::$logger

private

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

◆ $objDefinition

ilObjectDefinition ilDidacticTemplateSettingsGUI::$objDefinition

private

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

◆ $parent_object

ilObjectGUI ilDidacticTemplateSettingsGUI::$parent_object

private

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

◆ $rbacsystem

ilRbacSystem ilDidacticTemplateSettingsGUI::$rbacsystem

private

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

◆ $ref_id

int ilDidacticTemplateSettingsGUI::$ref_id

private

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

◆ $refinery

Factory ilDidacticTemplateSettingsGUI::$refinery

private

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

◆ $request

RequestInterface ilDidacticTemplateSettingsGUI::$request

private

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

◆ $setting

ilDidacticTemplateSetting ilDidacticTemplateSettingsGUI::$setting = null

private

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

◆ $tabs

ilTabsGUI ilDidacticTemplateSettingsGUI::$tabs

private

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

◆ $toolbar

ilToolbarGUI ilDidacticTemplateSettingsGUI::$toolbar

private

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

◆ $tpl

ilGlobalTemplateInterface ilDidacticTemplateSettingsGUI::$tpl

private

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

◆ $upload

FileUpload ilDidacticTemplateSettingsGUI::$upload

private

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

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

Services/DidacticTemplate/classes/Setting/class.ilDidacticTemplateSettingsGUI.php

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ activateTemplates()

◆ applyFilter()

◆ confirmDelete()

◆ copyTemplate()

◆ createImportForm()

◆ deactivateTemplates()

◆ deleteTemplates()

◆ editImport()

◆ editImportForm()

◆ editTemplate()

◆ executeCommand()

◆ exportTemplate()

◆ handleUpdateFailure()

◆ importTemplate()

◆ initEditTemplate()

◆ initReferenceFromRequest()

◆ initTemplateFromRequest()

◆ initTemplatesFromRequest()

◆ overview()

◆ resetFilter()

◆ setEditTabs()

◆ showEditImportForm()

◆ showImportForm()

◆ updateTemplate()

Field Documentation

◆ $access

◆ $ctrl

◆ $dic

◆ $http

◆ $lng

◆ $logger

◆ $objDefinition

◆ $parent_object

◆ $rbacsystem

◆ $ref_id

◆ $refinery

◆ $request

◆ $setting

◆ $tabs

◆ $toolbar

◆ $tpl

◆ $upload