Settings UI class for system styles. More...

Collaboration diagram for ilContentStyleSettingsGUI:

Public Member Functions
	__construct (ilObjStyleSettingsGUI $a_parent_gui)

	executeCommand ()

	checkPermission (string $a_perm, bool $a_throw_exc=true)
	Check permission. More...

	createStyle ()

	edit ()
	List styles. More...

	import ()

	moveLMStyles ()
	move learning modules from one style to another More...

	moveIndividualStyles ()
	move all learning modules with individual styles to new style More...

	confirmDeleteIndividualStyles ()

	deleteStyle ()
	display deletion confirmation screen More...

	confirmedDelete ()
	delete selected style objects More...

	toggleGlobalDefault ()
	Toggle global default style. More...

	toggleGlobalFixed ()
	Toggle global fixed style. More...

	saveActiveStyles ()

	showActions (bool $with_subobjects=false)
	show possible action (form buttons) More...

	cancelDelete ()

	setScope ()

	saveScope ()

Protected Member Functions
	getImportForm ()

Protected Attributes
InternalGUIService	$gui

ilContentStyleSettings	$cs_settings

ilObjStyleSettingsGUI	$parent_gui

int	$obj_id

StandardGUIRequest	$request

ilSetting	$settings

ilTree	$tree

ilCtrl	$ctrl

ilRbacSystem	$rbacsystem

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ILIAS DI Container	$DIC

int	$ref_id

Detailed Description

Settings UI class for system styles.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilContentStyleSettingsGUI: ilObjStyleSheetGUI ilContentStyleSettingsGUI: ilRepoStandardUploadHandlerGUI

Definition at line 31 of file class.ilContentStyleSettingsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilContentStyleSettingsGUI::__construct ( ilObjStyleSettingsGUI $a_parent_gui )

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

References $DIC, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
 
         $this->tree = $DIC->repositoryTree();
         $this->settings = $DIC->settings();
 
         $this->parent_gui = $a_parent_gui;
         $this->ctrl = $DIC->ctrl();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->toolbar = $DIC->toolbar();
         $this->lng = $DIC->language();
         $this->tpl = $DIC->ui()->mainTemplate();
         $this->request = $DIC->contentStyle()
                              ->internal()
                              ->gui()
                              ->standardRequest();
 
         $this->ref_id = $this->request->getRefId();
         $this->obj_id = $this->request->getObjId();        // note that reference ID is the id of the style settings node and object ID may be a style sheet object ID
 
         $this->cs_settings = new ilContentStyleSettings();
         $this->gui = $DIC->contentStyle()->internal()->gui();
     }

Here is the call graph for this function:

Member Function Documentation

◆ cancelDelete()

ilContentStyleSettingsGUI::cancelDelete ( )

Definition at line 455 of file class.ilContentStyleSettingsGUI.php.

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

                                   : void
     {
         $this->tpl->setOnScreenMessage('info', $this->lng->txt("msg_cancel"), true);
         $this->ctrl->redirect($this, "edit");
     }

Here is the call graph for this function:

◆ checkPermission()

ilContentStyleSettingsGUI::checkPermission	(	string	$a_perm,
		bool	$a_throw_exc = `true`
	)

Check permission.

Exceptions

ilObjectException

Definition at line 120 of file class.ilContentStyleSettingsGUI.php.

References ILIAS\Repository\lng().

Referenced by confirmDeleteIndividualStyles(), confirmedDelete(), deleteStyle(), edit(), moveIndividualStyles(), moveLMStyles(), saveScope(), setScope(), toggleGlobalDefault(), and toggleGlobalFixed().

                                                                              : bool
     {
         if (!$this->rbacsystem->checkAccess($a_perm, $this->ref_id)) {
             if ($a_throw_exc) {
                 throw new ilObjectException($this->lng->txt("permission_denied"));
             }
             return false;
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeleteIndividualStyles()

ilContentStyleSettingsGUI::confirmDeleteIndividualStyles ( )

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

References ilObject\_lookupTitle(), checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by moveLMStyles().

                                                    : void
     {
         $this->checkPermission("sty_write_content");
 
         $this->ctrl->setParameter($this, "to_style", $this->request->getToStyleId());
 
         $cgui = new ilConfirmationGUI();
         $cgui->setFormAction($this->ctrl->getFormAction($this));
         $cgui->setHeaderText($this->lng->txt("sty_confirm_del_ind_styles") . ": " .
             sprintf(
                 $this->lng->txt("sty_confirm_del_ind_styles_desc"),
                 ilObject::_lookupTitle($this->request->getToStyleId())
             ));
         $cgui->setCancel($this->lng->txt("cancel"), "edit");
         $cgui->setConfirm($this->lng->txt("ok"), "moveIndividualStyles");
         $this->tpl->setContent($cgui->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedDelete()

ilContentStyleSettingsGUI::confirmedDelete ( )

delete selected style objects

Definition at line 338 of file class.ilContentStyleSettingsGUI.php.

References $id, checkPermission(), ILIAS\Repository\ctrl(), and ilObjectFactory\getInstanceByObjId().

                                      : void
     {
         $this->checkPermission("sty_write_content");
 
         $ids = $this->request->getIds();
         foreach ($ids as $id) {
             $set = new ilContentStyleSettings();
             $set->removeStyle($id);
             $set->update();
 
             $style_obj = ilObjectFactory::getInstanceByObjId($id);
             $style_obj->delete();
         }
 
         $this->ctrl->redirect($this, "edit");
     }

Here is the call graph for this function:

◆ createStyle()

ilContentStyleSettingsGUI::createStyle ( )

Definition at line 131 of file class.ilContentStyleSettingsGUI.php.

References $ctrl, and ilCtrl\redirectByClass().

                                  : void
     {
         $ilCtrl = $this->ctrl;
 
         //      $ilCtrl->setParameterByClass("ilobjstylesheetgui", "new_type", "sty");
         $ilCtrl->redirectByClass("ilobjstylesheetgui", "create");
     }

Here is the call graph for this function:

◆ deleteStyle()

ilContentStyleSettingsGUI::deleteStyle ( )

display deletion confirmation screen

Definition at line 309 of file class.ilContentStyleSettingsGUI.php.

References $id, ilObject\_lookupTitle(), checkPermission(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                  : void
     {
         $this->checkPermission("sty_write_content");
 
         $ids = $this->request->getIds();
         if (count($ids) == 0) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt("no_checkbox"), true);
             $this->ctrl->redirect($this, "edit");
         }
 
         // display confirmation message
         $cgui = new ilConfirmationGUI();
         $cgui->setFormAction($this->ctrl->getFormAction($this));
         $cgui->setHeaderText($this->lng->txt("info_delete_sure"));
         $cgui->setCancel($this->lng->txt("cancel"), "cancelDelete");
         $cgui->setConfirm($this->lng->txt("confirm"), "confirmedDelete");
 
         foreach ($ids as $id) {
             $caption = ilObject::_lookupTitle($id);
 
             $cgui->addItem("id[]", (string) $id, $caption);
         }
 
         $this->tpl->setContent($cgui->getHTML());
     }

Here is the call graph for this function:

◆ edit()

ilContentStyleSettingsGUI::edit ( )

List styles.

Definition at line 142 of file class.ilContentStyleSettingsGUI.php.

References $data, ilObjContentObject\_getNrLMsIndividualStyles(), ilObjContentObject\_getNrLMsNoStyle(), ilObjContentObject\_getNrOfAssignedLMs(), ilObjStyleSheet\_lookupActive(), checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilSelectInputGUI\setOptions(), and ILIAS\Repository\toolbar().

                           : void
     {
         $this->checkPermission("visible,read");
 
         // @todo: check these, they are checked later, but never (ILIAS 6) set
         $fixed_style = 0;
         $default_style = 0;
 
         // this may not be cool, if styles are organised as (independent) Service
         $from_styles = $to_styles = $data = array();
         $styles = $this->cs_settings->getStyles();
         foreach ($styles as $style) {
             $style["active"] = ilObjStyleSheet::_lookupActive((int) $style["id"]);
             $style["lm_nr"] = ilObjContentObject::_getNrOfAssignedLMs((int) $style["id"]);
             $data[$style["title"] . ":" . $style["id"]]
                 = $style;
             if ($style["lm_nr"] > 0) {
                 $from_styles[$style["id"]] = $style["title"];
             }
             if ($style["active"] > 0) {
                 $to_styles[$style["id"]] = $style["title"];
             }
         }
 
         // number of individual styles
         if ($fixed_style <= 0) {
             $data[-1] =
                 array("title" => $this->lng->txt("sty_individual_styles"),
                       "id" => 0,
                       "lm_nr" => ilObjContentObject::_getNrLMsIndividualStyles()
                 );
             $from_styles[-1] = $this->lng->txt("sty_individual_styles");
         }
 
         // number of default style (fallback default style)
         if ($default_style <= 0 && $fixed_style <= 0) {
             $data[0] =
                 array("title" => $this->lng->txt("sty_default_style"),
                       "id" => 0,
                       "lm_nr" => ilObjContentObject::_getNrLMsNoStyle()
                 );
             $from_styles[0] = $this->lng->txt("sty_default_style");
             $to_styles[0] = $this->lng->txt("sty_default_style");
         }
 
         $rendered_modal = "";
         if ($this->checkPermission("sty_write_content", false)) {
             $this->toolbar->addButton(
                 $this->lng->txt("sty_add_content_style"),
                 $this->ctrl->getLinkTarget($this, "createStyle")
             );
 
             /*
             $modal = $this->gui->modal($this->lng->txt("import"))
                       ->form($this->getImportForm());
             $modal_c = $modal->getTriggerButtonComponents($this->lng->txt("import"), false);
             $this->toolbar->addComponent($modal_c["button"]);
             $rendered_modal = $this->gui->ui()->renderer()->render($modal_c["modal"]);*/
 
             $this->toolbar->addSeparator();
 
             // from styles selector
             $si = new ilSelectInputGUI(
                 $this->lng->txt("sty_move_lm_styles") . ": " . $this->lng->txt("sty_from"),
                 "from_style"
             );
             $si->setOptions($from_styles);
             $this->toolbar->addInputItem($si, true);
 
             // from styles selector
             $si = new ilSelectInputGUI($this->lng->txt("sty_to"), "to_style");
             $si->setOptions($to_styles);
             $this->toolbar->addInputItem($si, true);
             $this->toolbar->addFormButton($this->lng->txt("sty_move_style"), "moveLMStyles");
 
             $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
         }
 
         $table = new ilContentStylesTableGUI($this, "edit", $data);
         $this->tpl->setContent($table->getHTML() . $rendered_modal);
     }

Here is the call graph for this function:

◆ executeCommand()

ilContentStyleSettingsGUI::executeCommand ( )

Definition at line 73 of file class.ilContentStyleSettingsGUI.php.

References ILIAS\Repository\ctrl(), and getImportForm().

                                     : void
     {
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd("edit");
 
         switch ($next_class) {
             case "ilobjstylesheetgui":
                 $this->ctrl->setReturn($this, "edit");
                 $style_gui = new ilObjStyleSheetGUI("", $this->obj_id, false);
                 $this->ctrl->forwardCommand($style_gui);
                 break;
 
             case strtolower(ilRepoStandardUploadHandlerGUI::class):
                 $form = $this->getImportForm();
                 $gui = $form->getRepoStandardUploadHandlerGUI("import_file");
                 $this->ctrl->forwardCommand($gui);
                 break;
 
 
             default:
                 $this->parent_gui->prepareOutput();
                 if (in_array($cmd, array("edit",
                                          "delete",
                                          "toggleGlobalDefault",
                                          "toggleGlobalFixed",
                                          "setScope",
                                          "saveScope",
                                          "saveActiveStyles",
                                          "createStyle",
                                          "moveLMStyles",
                                          "moveIndividualStyles",
                                          "deleteStyle",
                                          "cancelDelete",
                                          "confirmedDelete",
                                          "import"
                 ))) {
                     $this->$cmd();
                 } else {
                     die("Unknown command " . $cmd);
                 }
         }
     }

Here is the call graph for this function:

◆ getImportForm()

ilContentStyleSettingsGUI::getImportForm ( )

protected

Definition at line 224 of file class.ilContentStyleSettingsGUI.php.

References ILIAS\Repository\lng().

Referenced by executeCommand(), and import().

                                       : FormAdapterGUI
     {
         $gui = new ilObjStyleSheetGUI("", 0, false);
         return $this->gui->form([self::class], "import")
                          ->file(
                              "import_file",
                              $this->lng->txt("import"),
                              $gui->handleImport(...),  // Placeholder for upload handler
                              "obj_id",
                              "",
                              1,
                              ["application/zip"]
                          );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ import()

ilContentStyleSettingsGUI::import ( )

Definition at line 239 of file class.ilContentStyleSettingsGUI.php.

References ilObjStyleSheet\_writeStandard(), ILIAS\Repository\ctrl(), getImportForm(), ilObjectFactory\getInstanceByRefId(), and ILIAS\Repository\int().

                             : void
     {
         $form = $this->getImportForm();
         if ($form->isValid()) {
             if ($this->request->getRefId() > 0) {
                 $fold = ilObjectFactory::getInstanceByRefId($this->request->getRefId());
                 if ($fold->getType() == "stys") {
                     $obj_id = (int) $form->getData("import_file");
                     $cont_style_settings = new ilContentStyleSettings();
                     $cont_style_settings->addStyle($obj_id);
                     $cont_style_settings->update();
                     ilObjStyleSheet::_writeStandard($obj_id, true);
                     $this->ctrl->redirectByClass(self::class, "");
                 }
             }
         }
     }

Here is the call graph for this function:

◆ moveIndividualStyles()

ilContentStyleSettingsGUI::moveIndividualStyles ( )

move all learning modules with individual styles to new style

Definition at line 280 of file class.ilContentStyleSettingsGUI.php.

References ilObjContentObject\_moveLMStyles(), checkPermission(), and ILIAS\Repository\ctrl().

                                           : void
     {
         $this->checkPermission("sty_write_content");
 
         ilObjContentObject::_moveLMStyles(-1, $this->request->getToStyleId());
         $this->ctrl->redirect($this, "edit");
     }

Here is the call graph for this function:

◆ moveLMStyles()

ilContentStyleSettingsGUI::moveLMStyles ( )

move learning modules from one style to another

Definition at line 261 of file class.ilContentStyleSettingsGUI.php.

References ilObjContentObject\_moveLMStyles(), checkPermission(), confirmDeleteIndividualStyles(), and ILIAS\Repository\ctrl().

                                   : void
     {
         $this->checkPermission("sty_write_content");
 
         if ($this->request->getFromStyleId() == -1) {
             $this->confirmDeleteIndividualStyles();
             return;
         }
 
         ilObjContentObject::_moveLMStyles(
             $this->request->getFromStyleId(),
             $this->request->getToStyleId()
         );
         $this->ctrl->redirect($this, "edit");
     }

Here is the call graph for this function:

◆ saveActiveStyles()

ilContentStyleSettingsGUI::saveActiveStyles ( )

Definition at line 402 of file class.ilContentStyleSettingsGUI.php.

References ilObjStyleSheet\_writeActive(), ILIAS\Repository\ctrl(), and ilUtil\redirect().

                                       : void
     {
         $styles = $this->cs_settings->getStyles();
         foreach ($styles as $style) {
             if ($this->request->getSelectedStandard($style["id"]) == 1) {
                 ilObjStyleSheet::_writeActive((int) $style["id"], true);
             } else {
                 ilObjStyleSheet::_writeActive((int) $style["id"], false);
             }
         }
         ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", ""));
     }

Here is the call graph for this function:

◆ saveScope()

ilContentStyleSettingsGUI::saveScope ( )

Definition at line 482 of file class.ilContentStyleSettingsGUI.php.

References $tree, ilObjStyleSheet\_writeScope(), checkPermission(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilTree\readRootId(), and ilUtil\redirect().

                                : void
     {
         $tree = $this->tree;
 
         $this->checkPermission("sty_write_content");
 
         $cat_id = $this->request->getCatId();
         if ($cat_id == $tree->readRootId()) {
             $cat_id = 0;
         }
 
         ilObjStyleSheet::_writeScope($this->request->getId(), $cat_id);
 
         $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
 
         ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", ""));
     }

Here is the call graph for this function:

◆ setScope()

ilContentStyleSettingsGUI::setScope ( )

Definition at line 461 of file class.ilContentStyleSettingsGUI.php.

References $ctrl, $tpl, checkPermission(), and ILIAS\UICore\GlobalTemplate\setContent().

                               : void
     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
 
         $this->checkPermission("sty_write_content");
 
         $ilCtrl->saveParameter($this, "id");
         $exp = new ilRepositorySelectorExplorerGUI(
             $this,
             "setScope",
             $this,
             "saveScope",
             "cat"
         );
         $exp->setTypeWhiteList(array("root", "cat"));
         if (!$exp->handleCommand()) {
             $tpl->setContent($exp->getHTML());
         }
     }

Here is the call graph for this function:

◆ showActions()

ilContentStyleSettingsGUI::showActions ( bool $with_subobjects = false )

show possible action (form buttons)

Definition at line 418 of file class.ilContentStyleSettingsGUI.php.

References ilUtil\getImagePath(), and ILIAS\Repository\lng().

                                                               : void
     {
         // delete
         $this->tpl->setCurrentBlock("tbl_action_btn");
         $this->tpl->setVariable("BTN_NAME", "deleteStyle");
         $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("delete"));
         $this->tpl->parseCurrentBlock();
 
         // set global default
         $this->tpl->setCurrentBlock("tbl_action_btn");
         $this->tpl->setVariable("BTN_NAME", "toggleGlobalDefault");
         $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("toggleGlobalDefault"));
         $this->tpl->parseCurrentBlock();
 
         // set global default
         $this->tpl->setCurrentBlock("tbl_action_btn");
         $this->tpl->setVariable("BTN_NAME", "toggleGlobalFixed");
         $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("toggleGlobalFixed"));
         $this->tpl->parseCurrentBlock();
 
         // set global default
         $this->tpl->setCurrentBlock("tbl_action_btn");
         $this->tpl->setVariable("BTN_NAME", "setScope");
         $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("sty_set_scope"));
         $this->tpl->parseCurrentBlock();
 
         // save active styles
         $this->tpl->setCurrentBlock("tbl_action_btn");
         $this->tpl->setVariable("BTN_NAME", "saveActiveStyles");
         $this->tpl->setVariable("BTN_VALUE", $this->lng->txt("sty_save_active_styles"));
         $this->tpl->parseCurrentBlock();
 
         $this->tpl->setCurrentBlock("tbl_action_row");
         $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("nav/arrow_downright.svg"));
         $this->tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

◆ toggleGlobalDefault()

ilContentStyleSettingsGUI::toggleGlobalDefault ( )

Toggle global default style.

Definition at line 358 of file class.ilContentStyleSettingsGUI.php.

References $ilSetting, $lng, $settings, checkPermission(), ILIAS\Repository\ctrl(), ilUtil\redirect(), and ilLanguage\txt().

                                          : void
     {
         $ilSetting = $this->settings;
         $lng = $this->lng;
 
         $this->checkPermission("sty_write_content");
 
         if ($this->request->getId() > 0) {
             $ilSetting->delete("fixed_content_style_id");
             $def_style = $ilSetting->get("default_content_style_id");
 
             if ($def_style != $this->request->getId()) {
                 $ilSetting->set("default_content_style_id", (string) $this->request->getId());
             } else {
                 $ilSetting->delete("default_content_style_id");
             }
             $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
         }
         ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", ""));
     }

Here is the call graph for this function:

◆ toggleGlobalFixed()

ilContentStyleSettingsGUI::toggleGlobalFixed ( )

Toggle global fixed style.

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

References $ilSetting, $lng, $settings, checkPermission(), ILIAS\Repository\ctrl(), ilUtil\redirect(), and ilLanguage\txt().

                                        : void
     {
         $ilSetting = $this->settings;
         $lng = $this->lng;
 
         $this->checkPermission("sty_write_content");
 
         if ($this->request->getId() > 0) {
             $ilSetting->delete("default_content_style_id");
             $fixed_style = $ilSetting->get("fixed_content_style_id");
             if ($fixed_style == $this->request->getId()) {
                 $ilSetting->delete("fixed_content_style_id");
             } else {
                 $ilSetting->set("fixed_content_style_id", (string) $this->request->getId());
             }
             $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
         }
         ilUtil::redirect($this->ctrl->getLinkTarget($this, "edit", ""));
     }