ilRatingCategoryGUI Class Reference

Class ilRatingCategoryGUI. More...

Inheritance diagram for ilRatingCategoryGUI:

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...
	handleTableActions ()
	getRatingCategoryOrderingTable ()
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. More...
	getUnsafeGetCommands ()
	This method must return a list of unsafe GET commands. More...
	getSafePostCommands ()
	This method must return a list of safe POST commands. 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
readonly 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

Private Attributes
readonly UIFactory	$ui_factory
readonly UIRenderer	$ui_renderer
readonly Refinery	$refinery
readonly HttpServices	$http

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 32 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

?mixed	$a_export_callback
?string	$a_export_subobj_title

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

      {
        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();
            }
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

add()

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

protected

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

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

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

Referenced by save(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDelete()

ilRatingCategoryGUI::confirmDelete ( )

protected

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

                                      : 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());
    }

References $cat_id, $ctrl, $lng, $tpl, ILIAS\FileDelivery\http(), listCategories(), ILIAS\Repository\refinery(), ILIAS\UICore\GlobalTemplate\setContent(), and ilLanguage\txt().

Here is the call graph for this function:

delete()

ilRatingCategoryGUI::delete ( )

protected

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

                               : 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");
    }

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

Here is the call graph for this function:

edit()

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

protected

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

                                                              : 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());
    }

References $cat_id, $ctrl, $tpl, ILIAS\FileDelivery\http(), initCategoryForm(), ILIAS\Repository\refinery(), and ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

executeCommand()

ilRatingCategoryGUI::executeCommand

(

)

execute command

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

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

References $ctrl, and ilCtrl\getNextClass().

Here is the call graph for this function:

export()

ilRatingCategoryGUI::export ( )

protected

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

                               : 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));
    }

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

Here is the call graph for this function:

getRatingCategoryOrderingTable()

ilRatingCategoryGUI::getRatingCategoryOrderingTable

(

)

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

                                                    : RatingCategoryOrderingTable
    {
        return new RatingCategoryOrderingTable(
            $this->parent_id,
            $this->ui_factory,
            $this->lng,
            $this->ctrl,
            new DataFactory(),
            $this->http->request()
        )
        ;
    }

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

Referenced by updateOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

getSafePostCommands()

ilRatingCategoryGUI::getSafePostCommands

(

)

This method must return a list of safe POST commands.

Safe post commands returned by this method will no longer be CSRF protected and will NOT be appended by an ilCtrlToken.

Returns

string[]

Implements ilCtrlSecurityInterface.

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

                                         : array
    {
        return [];
    }

getUnsafeGetCommands()

ilRatingCategoryGUI::getUnsafeGetCommands

(

)

This method must return a list of unsafe GET commands.

Unsafe get commands returned by this method will now be CSRF protected, which means an ilCtrlToken is appended each time a link-target is generated to the class implementing this interface with a command from that list.

Tokens will be validated in

See also

ilCtrlInterface::getCmd(), whereas the fallback command will be used if the CSRF validation fails.

Returns

string[]

Implements ilCtrlSecurityInterface.

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

                                          : array
    {
        return ['handleTableActions'];
    }

handleTableActions()

ilRatingCategoryGUI::handleTableActions

(

)

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

                                        : 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();
        }
    }

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

Here is the call graph for this function:

initCategoryForm()

ilRatingCategoryGUI::initCategoryForm ( ?int  $a_id = null )

protected

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

                                                          : 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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

listCategories()

ilRatingCategoryGUI::listCategories ( )

protected

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

                                       : 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()));
    }

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

Referenced by confirmDelete().

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilRatingCategoryGUI::save ( )

protected

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

                             : 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);
    }

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

Here is the call graph for this function:

update()

ilRatingCategoryGUI::update ( )

protected

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

                               : 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);
    }

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

Here is the call graph for this function:

updateOrder()

ilRatingCategoryGUI::updateOrder ( )

protected

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

                                    : 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');
    }

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

Here is the call graph for this function:

Field Documentation

$cat_id

int ilRatingCategoryGUI::$cat_id

protected

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

Referenced by confirmDelete(), and edit().

$ctrl

ilCtrl ilRatingCategoryGUI::$ctrl

protected

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

Referenced by confirmDelete(), delete(), edit(), executeCommand(), initCategoryForm(), listCategories(), save(), update(), and updateOrder().

$export_callback

ilRatingCategoryGUI::$export_callback

protected

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

$export_subobj_title

string ilRatingCategoryGUI::$export_subobj_title = null

protected

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

$http

readonly HttpServices ilRatingCategoryGUI::$http

private

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

$lng

readonly ilLanguage ilRatingCategoryGUI::$lng

protected

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

Referenced by __construct(), confirmDelete(), delete(), export(), initCategoryForm(), listCategories(), save(), update(), and updateOrder().

$parent_id

int ilRatingCategoryGUI::$parent_id

protected

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

$refinery

readonly Refinery ilRatingCategoryGUI::$refinery

private

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

$request

RequestInterface ilRatingCategoryGUI::$request

protected

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

$requested_cat_id

int ilRatingCategoryGUI::$requested_cat_id

protected

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

$toolbar

ilToolbarGUI ilRatingCategoryGUI::$toolbar

protected

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

Referenced by listCategories().

$tpl

ilGlobalTemplateInterface ilRatingCategoryGUI::$tpl

protected

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

Referenced by add(), confirmDelete(), edit(), and listCategories().

$ui_factory

readonly UIFactory ilRatingCategoryGUI::$ui_factory

private

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

$ui_renderer

readonly UIRenderer ilRatingCategoryGUI::$ui_renderer

private

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

---

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

• components/ILIAS/Rating/classes/class.ilRatingCategoryGUI.php