Collaboration diagram for ilRatingCategoryGUI:

Public Member Functions
	__construct (int $a_parent_id, $a_export_callback=null, string $a_export_subobj_title=null)
	ilRatingCategoryGUI constructor. More...

	executeCommand ()
	execute command More...

Protected Member Functions
	listCategories ()

	initCategoryForm (int $a_id=null)

	add (ilPropertyFormGUI $a_form=null)

	save ()

	edit (ilPropertyFormGUI $a_form=null)

	update ()

	updateOrder ()

	confirmDelete ()

	delete ()

	export ()

Protected Attributes
ilLanguage	$lng

ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilToolbarGUI	$toolbar

int	$parent_id

	$export_callback

string	$export_subobj_title = null

int	$requested_cat_id

RequestInterface	$request

int	$cat_id

Detailed Description

Class ilRatingCategoryGUI.

User interface class for rating categories.

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

Definition at line 26 of file class.ilRatingCategoryGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRatingCategoryGUI::__construct	(	int	$a_parent_id,
			$a_export_callback = `null`,
		string	$a_export_subobj_title = `null`
	)

ilRatingCategoryGUI constructor.

Parameters

int	$a_parent_id
	?mixed	$a_export_callback
	?string	$a_export_subobj_title

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

References $DIC, $params, $parent_id, ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), and ILIAS\Repository\toolbar().

       {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->ctrl = $DIC->ctrl();
         $this->tpl = $DIC["tpl"];
         $this->toolbar = $DIC->toolbar();
         $this->request = $DIC->http()->request();
         $lng = $DIC->language();
 
         $this->parent_id = $a_parent_id;
         $this->export_callback = $a_export_callback;
         $this->export_subobj_title = $a_export_subobj_title;
 
         $lng->loadLanguageModule("rating");
 
         $params = $this->request->getQueryParams();
         $body = $this->request->getParsedBody();
         $this->requested_cat_id = (int) ($body["cat_id"] ?? ($params["cat_id"] ?? 0));
 
         if ($this->requested_cat_id) {
             $cat = new ilRatingCategory($this->requested_cat_id);
             if ($cat->getParentId() == $this->parent_id) {
                 $this->cat_id = $cat->getId();
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilRatingCategoryGUI::add ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 156 of file class.ilRatingCategoryGUI.php.

References $tpl, initCategoryForm(), and ilGlobalTemplateInterface\setContent().

Referenced by save(), and update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDelete()

ilRatingCategoryGUI::confirmDelete ( )

protected

Definition at line 245 of file class.ilRatingCategoryGUI.php.

References $ctrl, $lng, $tpl, listCategories(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                       : void
     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         if (!$this->cat_id) {
             $this->listCategories();
             return;
         }
 
         $cgui = new ilConfirmationGUI();
         $cgui->setHeaderText($lng->txt("rating_category_delete_sure") . "<br/>" .
             $lng->txt("info_delete_warning_no_trash"));
 
         $cgui->setFormAction($ilCtrl->getFormAction($this));
         $cgui->setCancel($lng->txt("cancel"), "listCategories");
         $cgui->setConfirm($lng->txt("confirm"), "delete");
 
         $cat = new ilRatingCategory($this->cat_id);
         $cgui->addItem("cat_id", $this->cat_id, $cat->getTitle());
 
         $tpl->setContent($cgui->getHTML());
     }

Here is the call graph for this function:

◆ delete()

ilRatingCategoryGUI::delete ( )

protected

Definition at line 270 of file class.ilRatingCategoryGUI.php.

References $ctrl, $lng, ilRatingCategory\delete(), ilRatingCategory\getAllForObject(), and ilLanguage\txt().

                                : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         if ($this->cat_id) {
             ilRatingCategory::delete($this->cat_id);
             $this->tpl->setOnScreenMessage('success', $lng->txt("rating_category_deleted"), true);
         }
 
         // fix order
         $cnt = 0;
         foreach (ilRatingCategory::getAllForObject($this->parent_id) as $item) {
             $cnt += 10;
 
             $cat = new ilRatingCategory($item["id"]);
             $cat->setPosition($cnt);
             $cat->update();
         }
 
         $ilCtrl->redirect($this, "listCategories");
     }

Here is the call graph for this function:

◆ edit()

ilRatingCategoryGUI::edit ( ilPropertyFormGUI $a_form = null )

protected

Definition at line 188 of file class.ilRatingCategoryGUI.php.

References $ctrl, $tpl, initCategoryForm(), ilGlobalTemplateInterface\setContent(), and ilCtrl\setParameter().

                                                              : void
     {
         $tpl = $this->tpl;
         $ilCtrl = $this->ctrl;
 
         $ilCtrl->setParameter($this, "cat_id", $this->cat_id);
 
         if (!$a_form) {
             $a_form = $this->initCategoryForm($this->cat_id);
         }
 
         $tpl->setContent($a_form->getHTML());
     }

Here is the call graph for this function:

◆ executeCommand()

ilRatingCategoryGUI::executeCommand ( )

execute command

Definition at line 80 of file class.ilRatingCategoryGUI.php.

References $ctrl, and ilCtrl\getNextClass().

                                     : void
     {
         $ilCtrl = $this->ctrl;
 
         $next_class = $ilCtrl->getNextClass($this);
         $cmd = $ilCtrl->getCmd("listCategories");
 
         switch ($next_class) {
             default:
                 $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ export()

ilRatingCategoryGUI::export ( )

protected

Definition at line 293 of file class.ilRatingCategoryGUI.php.

References $lng, ilObject\_lookupTitle(), ilObject\_lookupType(), ilRatingCategory\getAllForObject(), ilRating\getExportData(), IL_CAL_UNIX, and ilLanguage\txt().

                                : void
     {
         $lng = $this->lng;
 
         $excel = new ilExcel();
         $excel->addSheet($lng->txt("rating_categories"));
 
         // restrict to currently active (probably not needed - see delete())
         $active = array();
         foreach (ilRatingCategory::getAllForObject($this->parent_id) as $item) {
             $active[$item["id"]] = $item["title"];
         }
 
         // title row
         $row = 1;
         $excel->setCell($row, 0, $this->export_subobj_title . " (" . $lng->txt("id") . ")");
         $excel->setCell($row, 1, $this->export_subobj_title);
         $excel->setCell($row, 2, $lng->txt("rating_export_category") . " (" . $lng->txt("id") . ")");
         $excel->setCell($row, 3, $lng->txt("rating_export_category"));
         $excel->setCell($row, 4, $lng->txt("rating_export_date"));
         $excel->setCell($row, 5, $lng->txt("rating_export_rating"));
         $excel->setBold("A1:F1");
 
         // content rows
         foreach (ilRating::getExportData($this->parent_id, ilObject::_lookupType($this->parent_id), array_keys($active)) as $item) {
             // overall rating?
             if (!$item["sub_obj_id"]) {
                 continue;
             }
 
             $row++;
 
             $sub_obj_title = $item["sub_obj_type"];
             if ($this->export_callback) {
                 $sub_obj_title = call_user_func($this->export_callback, $item["sub_obj_id"], $item["sub_obj_type"]);
             }
 
             $excel->setCell($row, 0, (int) $item["sub_obj_id"]);
             $excel->setCell($row, 1, $sub_obj_title);
             $excel->setCell($row, 2, (int) $item["category_id"]);
             $excel->setCell($row, 3, $active[$item["category_id"]] ?? "");
             $excel->setCell($row, 4, new ilDateTime($item["tstamp"] ?? null, IL_CAL_UNIX));
             $excel->setCell($row, 5, $item["rating"] ?? "");
         }
 
         $excel->sendToClient(ilObject::_lookupTitle($this->parent_id));
     }

Here is the call graph for this function:

◆ initCategoryForm()

ilRatingCategoryGUI::initCategoryForm ( int $a_id = null )

protected

Definition at line 118 of file class.ilRatingCategoryGUI.php.

References $ctrl, $lng, ilObject\LONG_DESC_LENGTH, ilTextAreaInputGUI\setCols(), and ilLanguage\txt().

Referenced by add(), edit(), save(), and update().

                                                          : ilPropertyFormGUI
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $form = new ilPropertyFormGUI();
         $form->setTarget("_top");
         $form->setFormAction($ilCtrl->getFormAction($this, "save"));
         $form->setTitle($lng->txt("rating_category_" . ($a_id ? "edit" : "create")));
 
         // title
         $ti = new ilTextInputGUI($lng->txt("title"), "title");
         $ti->setMaxLength(128);
         $ti->setSize(40);
         $ti->setRequired(true);
         $form->addItem($ti);
 
         // description
         $ta = new ilTextAreaInputGUI($lng->txt("description"), "desc");
         $ta->setCols(40);
         $ta->setRows(2);
         $ta->setMaxNumOfChars(ilObject::LONG_DESC_LENGTH);
         $form->addItem($ta);
 
         if (!$a_id) {
             $form->addCommandButton("save", $lng->txt("rating_category_add"));
         } else {
             $cat = new ilRatingCategory($a_id);
             $ti->setValue($cat->getTitle());
             $ta->setValue($cat->getDescription());
 
             $form->addCommandButton("update", $lng->txt("rating_category_update"));
         }
         $form->addCommandButton("listCategories", $lng->txt("cancel"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listCategories()

ilRatingCategoryGUI::listCategories ( )

protected

Definition at line 94 of file class.ilRatingCategoryGUI.php.

References $ctrl, $lng, $toolbar, $tpl, ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

Referenced by confirmDelete().

                                        : void
     {
         $tpl = $this->tpl;
         $ilToolbar = $this->toolbar;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $ilToolbar->addButton(
             $lng->txt("rating_add_category"),
             $ilCtrl->getLinkTarget($this, "add")
         );
 
         $ilToolbar->addSeparator();
 
         $ilToolbar->addButton(
             $lng->txt("export"),
             $ilCtrl->getLinkTarget($this, "export")
         );
 
         $table = new ilRatingCategoryTableGUI($this, "listCategories", $this->parent_id);
         $tpl->setContent($table->getHTML());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilRatingCategoryGUI::save ( )

protected

Definition at line 167 of file class.ilRatingCategoryGUI.php.

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

                              : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $form = $this->initCategoryForm();
         if ($form->checkInput()) {
             $cat = new ilRatingCategory();
             $cat->setParentId($this->parent_id);
             $cat->setTitle($form->getInput("title"));
             $cat->setDescription($form->getInput("desc"));
             $cat->save();
 
             $this->tpl->setOnScreenMessage('success', $lng->txt("rating_category_created"));
             $ilCtrl->redirect($this, "listCategories");
         }
 
         $form->setValuesByPost();
         $this->add($form);
     }

Here is the call graph for this function:

◆ update()

ilRatingCategoryGUI::update ( )

protected

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

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

                                : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $form = $this->initCategoryForm($this->cat_id);
         if ($form->checkInput()) {
             $cat = new ilRatingCategory($this->cat_id);
             $cat->setTitle($form->getInput("title"));
             $cat->setDescription($form->getInput("desc"));
             $cat->update();
 
             $this->tpl->setOnScreenMessage('success', $lng->txt("rating_category_updated"));
             $ilCtrl->redirect($this, "listCategories");
         }
 
         $form->setValuesByPost();
         $this->add($form);
     }

Here is the call graph for this function:

◆ updateOrder()

ilRatingCategoryGUI::updateOrder ( )

protected

Definition at line 222 of file class.ilRatingCategoryGUI.php.

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

                                     : void
     {
         $ilCtrl = $this->ctrl;
         $lng = $this->lng;
 
         $body = $this->request->getParsedBody();
         $order = $body["pos"];
         asort($order);
 
         $cnt = 0;
         foreach ($order as $id => $pos) {
             $cat = new ilRatingCategory($id);
             if ($cat->getParentId() == $this->parent_id) {
                 $cnt += 10;
                 $cat->setPosition($cnt);
                 $cat->update();
             }
         }
 
         $this->tpl->setOnScreenMessage('success', $lng->txt("settings_saved"), true);
         $ilCtrl->redirect($this, "listCategories");
     }