class.ilRatingCategoryGUI.php

Go to the documentation of this file.

<?php
 
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\Data\Factory as DataFactory;
use Psr\Http\Message\RequestInterface;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\HTTP\Services as HttpServices;
use ILIAS\Rating\RatingCategoryOrderingTable;
 
class ilRatingCategoryGUI implements ilCtrlSecurityInterface
{
    protected readonly ilLanguage $lng;
    private readonly UIFactory $ui_factory;
    private readonly UIRenderer $ui_renderer;
    private readonly Refinery $refinery;
    private readonly HttpServices $http;
    protected ilCtrl $ctrl;
    protected ilGlobalTemplateInterface $tpl;
    protected ilToolbarGUI $toolbar;
    protected int $parent_id; // [int]
    protected $export_callback; // [string|array]
    protected ?string $export_subobj_title = null;
    protected int $requested_cat_id;
    protected RequestInterface $request;
    protected int $cat_id;
 
    public function __construct(
        int $a_parent_id,
        $a_export_callback = null,
        ?string $a_export_subobj_title = null
    ) {
        global $DIC;
 
        $this->tpl = $DIC["tpl"];
        $this->http = $DIC->http();
        $this->ctrl = $DIC->ctrl();
        $this->lng = $DIC->language();
        $this->toolbar = $DIC->toolbar();
        $this->refinery = $DIC->refinery();
        $this->request = $DIC->http()->request();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
 
        $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();
            }
        }
    }
 
    public function executeCommand(): void
    {
        $ilCtrl = $this->ctrl;
 
        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd('listCategories');
 
        switch ($next_class) {
            default:
                $this->$cmd();
                break;
        }
    }
 
    public function handleTableActions(): void
    {
        $cmd = $this->http->wrapper()->query()->retrieve(
            'rating_category_ordering_table_action',
            $this->refinery->byTrying(
                [
                    $this->refinery->kindlyTo()->string(),
                    $this->refinery->always('')
            ]
            )
        );
 
        if ($cmd !== '') {
            $this->$cmd();
        }
    }
 
    protected function listCategories(): 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")
        );
 
        $tpl->setContent($this->ui_renderer->render($this->getRatingCategoryOrderingTable()->getComponent()));
    }
 
    public function getRatingCategoryOrderingTable(): RatingCategoryOrderingTable
    {
        return new RatingCategoryOrderingTable(
            $this->parent_id,
            $this->ui_factory,
            $this->lng,
            $this->ctrl,
            new DataFactory(),
            $this->http->request()
        )
        ;
    }
 
    protected function initCategoryForm(?int $a_id = null): 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;
    }
 
    protected function add(?ilPropertyFormGUI $a_form = null): void
    {
        $tpl = $this->tpl;
 
        if (!$a_form) {
            $a_form = $this->initCategoryForm();
        }
 
        $tpl->setContent($a_form->getHTML());
    }
 
    protected function save(): 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);
    }
 
    protected function edit(?ilPropertyFormGUI $a_form = null): void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
 
        $cat_id = $this->http->wrapper()->query()->has('rating_category_ordering_rating_ids') ?
            $this->http->wrapper()->query()->retrieve(
                'rating_category_ordering_rating_ids',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            ) : 0;
        $cat_id = $cat_id[0] ?? 0;
 
        $ilCtrl->setParameter($this, 'cat_id', $cat_id);
 
        if (!$a_form) {
            $a_form = $this->initCategoryForm($cat_id);
        }
 
        $tpl->setContent($a_form->getHTML());
    }
 
    protected function update(): 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);
    }
 
    protected function updateOrder(): void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $table = $this->getRatingCategoryOrderingTable();
        $data = $table->getComponent()->getData();
 
        $cnt = 0;
        foreach ($data as $id) {
            $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');
    }
 
    protected function confirmDelete(): void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        $cat_id = $this->http->wrapper()->query()->has('rating_category_ordering_rating_ids') ?
            $this->http->wrapper()->query()->retrieve(
                'rating_category_ordering_rating_ids',
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
            ) : 0;
        $cat_id = $cat_id[0] ?? 0;
 
        if (!$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($cat_id);
        $cgui->addItem('cat_id', $cat_id, $cat->getTitle());
 
        $tpl->setContent($cgui->getHTML());
    }
 
    protected function delete(): 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");
    }
 
    protected function export(): 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));
    }
 
    public function getUnsafeGetCommands(): array
    {
        return ['handleTableActions'];
    }
 
    public function getSafePostCommands(): array
    {
        return [];
    }
}