Class ilExcCriteriaCatalogueGUI. More...

Collaboration diagram for ilExcCriteriaCatalogueGUI:

Public Member Functions
	executeCommand ()

Protected Member Functions
	view ()

	saveOrder ()

	confirmDeletion ()

	delete ()

	initForm (?ilExcCriteriaCatalogue $a_cat_obj=null)

	add (?ilPropertyFormGUI $a_form=null)

	exportForm (ilExcCriteriaCatalogue $a_cat_obj, ilPropertyFormGUI $a_form)

	importForm (?ilExcCriteriaCatalogue $a_cat_obj=null)

	create ()

	getCurrentCatalogue ()

	edit (?ilPropertyFormGUI $a_form=null)

	update ()

Protected Attributes
ilCtrl	$ctrl

ilTabsGUI	$tabs

ilLanguage	$lng

ilToolbarGUI	$toolbar

ilGlobalTemplateInterface	$tpl

ilObjExercise	$exc_obj

GUIRequest	$request

Detailed Description

Class ilExcCriteriaCatalogueGUI.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om ilExcCriteriaCatalogueGUI: ilExcCriteriaGUI

Definition at line 27 of file class.ilExcCriteriaCatalogueGUI.php.

Member Function Documentation

◆ add()

ilExcCriteriaCatalogueGUI::add ( ?ilPropertyFormGUI $a_form = null )

protected

Definition at line 202 of file class.ilExcCriteriaCatalogueGUI.php.

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

                                                              : void
     {
         $tpl = $this->tpl;
 
         if (!$a_form) {
             $a_form = $this->initForm();
         }
 
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

◆ confirmDeletion()

ilExcCriteriaCatalogueGUI::confirmDeletion ( )

protected

Definition at line 122 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $lng, $tpl, ilExcCriteriaCatalogue\getInstancesByParentId(), ILIAS\UICore\GlobalTemplate\setContent(), ILIAS\UICore\GlobalTemplate\setOnScreenMessage(), and ilLanguage\txt().

                                         : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
 
         $ids = $this->request->getCatalogueIds();
         if (count($ids) == 0) {
             $this->tpl->setOnScreenMessage('info', $lng->txt("select_one"), true);
             $ilCtrl->redirect($this, "view");
         }
 
         $confirmation_gui = new ilConfirmationGUI();
         $confirmation_gui->setFormAction($ilCtrl->getFormAction($this, "delete"));
         $confirmation_gui->setHeaderText($lng->txt("exc_criteria_catalogue_deletion_confirmation"));
         $confirmation_gui->setCancel($lng->txt("cancel"), "view");
         $confirmation_gui->setConfirm($lng->txt("delete"), "delete");
 
         foreach (ilExcCriteriaCatalogue::getInstancesByParentId($this->exc_obj->getId()) as $item) {
             if (in_array($item->getId(), $ids)) {
                 $confirmation_gui->addItem("id[]", $item->getId(), $item->getTitle());
             }
         }
 
         $tpl->setContent($confirmation_gui->getHTML());
     }

Here is the call graph for this function:

◆ create()

ilExcCriteriaCatalogueGUI::create ( )

protected

Definition at line 251 of file class.ilExcCriteriaCatalogueGUI.php.

References importForm().

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

Here is the call graph for this function:

◆ delete()

ilExcCriteriaCatalogueGUI::delete ( )

protected

Definition at line 149 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $lng, ilExcCriteriaCatalogue\getInstancesByParentId(), and ilLanguage\txt().

                                : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $ids = $this->request->getCatalogueIds();
         if (count($ids) == 0) {
             $ilCtrl->redirect($this, "view");
         }
 
         foreach (ilExcCriteriaCatalogue::getInstancesByParentId($this->exc_obj->getId()) as $item) {
             if (in_array($item->getId(), $ids)) {
                 $item->delete();
             }
         }
 
         $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ edit()

ilExcCriteriaCatalogueGUI::edit ( ?ilPropertyFormGUI $a_form = null )

protected

Definition at line 274 of file class.ilExcCriteriaCatalogueGUI.php.

References $tpl, exportForm(), getCurrentCatalogue(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

                                                               : void
     {
         $tpl = $this->tpl;
 
         $cat_obj = $this->getCurrentCatalogue();
 
         if (!$a_form) {
             $a_form = $this->initForm($cat_obj);
             $this->exportForm($cat_obj, $a_form);
         }
 
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilExcCriteriaCatalogueGUI::executeCommand ( )

Exceptions

ilCtrlException

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

References $ctrl, $lng, $tabs, and ilLanguage\txt().

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $ilTabs = $this->tabs;
         $lng = $this->lng;
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd("view");
 
         switch ($next_class) {
             case "ilexccriteriagui":
                 $ilTabs->clearTargets();
                 $ilTabs->setBackTarget($lng->txt("back"), $ilCtrl->getLinkTarget($this, ""));
                 $ilCtrl->saveParameter($this, "cat_id");
                 $crit_gui = new ilExcCriteriaGUI($this->request->getCatalogueId());
                 $ilCtrl->forwardCommand($crit_gui);
                 break;
 
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ exportForm()

ilExcCriteriaCatalogueGUI::exportForm	(	ilExcCriteriaCatalogue	$a_cat_obj,
		ilPropertyFormGUI	$a_form
	)

protected

Definition at line 213 of file class.ilExcCriteriaCatalogueGUI.php.

References ilPropertyFormGUI\getItemByPostVar(), and ilExcCriteriaCatalogue\getTitle().

Referenced by edit().

      : void {
         $a_form->getItemByPostVar("title")->setValue($a_cat_obj->getTitle());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCurrentCatalogue()

ilExcCriteriaCatalogueGUI::getCurrentCatalogue ( )

protected

Definition at line 256 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $id, and null.

Referenced by edit(), and update().

                                             : ?ilExcCriteriaCatalogue
     {
         $ilCtrl = $this->ctrl;
 
         $id = $this->request->getCatalogueId();
         if ($id > 0) {
             $cat_obj = new ilExcCriteriaCatalogue($id);
             if ($cat_obj->getParent() == $this->exc_obj->getId()) {
                 $ilCtrl->setParameter($this, "cat_id", $id);
                 return $cat_obj;
             }
         }
 
         $ilCtrl->redirect($this, "view");
 
         return null;
     }

Here is the caller graph for this function:

◆ importForm()

ilExcCriteriaCatalogueGUI::importForm ( ?ilExcCriteriaCatalogue $a_cat_obj = null )

protected

Definition at line 220 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $lng, initForm(), null, and ilLanguage\txt().

Referenced by create(), and update().

      : void {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $is_edit = ($a_cat_obj !== null);
 
         $form = $this->initForm($a_cat_obj);
         if ($form->checkInput()) {
             if (!$is_edit) {
                 $a_cat_obj = new ilExcCriteriaCatalogue();
                 $a_cat_obj->setParent($this->exc_obj->getId());
             }
 
             $a_cat_obj->setTitle($form->getInput("title"));
 
             if (!$is_edit) {
                 $a_cat_obj->save();
             } else {
                 $a_cat_obj->update();
             }
 
             $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
             $ilCtrl->redirect($this, "view");
         }
 
         $form->setValuesByPost();
         $this->{$is_edit ? "edit" : "add"}($form);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

ilExcCriteriaCatalogueGUI::initForm ( ?ilExcCriteriaCatalogue $a_cat_obj = null )

protected

Definition at line 174 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $lng, null, and ilLanguage\txt().

Referenced by add(), edit(), and importForm().

      : ilPropertyFormGUI {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $form = new ilPropertyFormGUI();
 
         $is_edit = ($a_cat_obj !== null);
         if (!$is_edit) {
             $form->setFormAction($ilCtrl->getFormAction($this, "create"));
             $form->setTitle($lng->txt("exc_criteria_catalogue_create_form"));
             $form->addCommandButton("create", $lng->txt("create"));
         } else {
             $form->setFormAction($ilCtrl->getFormAction($this, "update"));
             $form->setTitle($lng->txt("exc_criteria_catalogue_update_form"));
             $form->addCommandButton("update", $lng->txt("save"));
         }
 
         $form->addCommandButton("view", $lng->txt("cancel"));
 
         $title = new ilTextInputGUI($lng->txt("title"), "title");
         $title->setRequired(true);
         $form->addItem($title);
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveOrder()

ilExcCriteriaCatalogueGUI::saveOrder ( )

protected

Definition at line 100 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $id, $lng, ilExcCriteriaCatalogue\getInstancesByParentId(), and ilLanguage\txt().

                                   : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $all_cat = ilExcCriteriaCatalogue::getInstancesByParentId($this->exc_obj->getId());
 
         $pos = 0;
         $req_positions = $this->request->getPositions();
         asort($req_positions);
         foreach (array_keys($req_positions) as $id) {
             if (array_key_exists($id, $all_cat)) {
                 $pos += 10;
                 $all_cat[$id]->setPosition($pos);
                 $all_cat[$id]->update();
             }
         }
 
         $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "view");
     }

Here is the call graph for this function:

◆ update()

ilExcCriteriaCatalogueGUI::update ( )

protected

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

References getCurrentCatalogue(), and importForm().

                                : void
     {
         $cat_obj = $this->getCurrentCatalogue();
         $this->importForm($cat_obj);
     }

Here is the call graph for this function:

◆ view()

ilExcCriteriaCatalogueGUI::view ( )

protected

Definition at line 84 of file class.ilExcCriteriaCatalogueGUI.php.

References $ctrl, $lng, $toolbar, $tpl, ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

                              : void
     {
         $ilToolbar = $this->toolbar;
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
         $tpl = $this->tpl;
 
         $ilToolbar->addButton(
             $lng->txt("exc_add_criteria_catalogue"),
             $ilCtrl->getLinkTarget($this, "add")
         );
 
         $tbl = new ilExcCriteriaCatalogueTableGUI($this, "view", $this->exc_obj->getId());
         $tpl->setContent($tbl->getHTML());
     }