class.ilObjStudyProgrammeAutoCategoriesGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Button\Shy;
use ILIAS\UI\Component\Link\Link;
use ILIAS\UI\Component\Dropdown\Standard;
use ILIAS\UI\Component\Signal;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use ILIAS\UI\Component\MessageBox;
use ILIAS\UI\Component\Button;
use ILIAS\UI\Component\Modal\RoundTrip;

class ilObjStudyProgrammeAutoCategoriesGUI
{
    private const F_CATEGORY_REF = 'f_cr';
    private const F_CATEGORY_ORIGINAL_REF = 'f_cr_org';
    public const CHECKBOX_CATEGORY_REF_IDS = 'c_catids';

    private const CMD_VIEW = 'view';
    private const CMD_SAVE = 'save';
    private const CMD_GET_ASYNC_MODAL = 'getAsyncModalOutput';
    private const CMD_DELETE = 'delete';
    private const CMD_DELETE_CONFIRMATION = 'deleteConfirmation';
    private const CMD_PROFILE_NOT_PUBLIC = 'profile_not_public';

    public ilGlobalTemplateInterface $tpl;
    public ilCtrl $ctrl;
    public ilToolbarGUI $toolbar;
    public ilLanguage $lng;
    public ?int $prg_ref_id;
    public ?ilObjStudyProgramme $object = null;
    protected MessageBox\Factory $message_box_factory;
    protected Button\Factory $button_factory;
    public ILIAS\UI\Factory $ui_factory;
    public ILIAS\UI\Renderer $ui_renderer;
    protected Psr\Http\Message\ServerRequestInterface $request;
    protected ilTree $tree;
    protected ILIAS\HTTP\Wrapper\RequestWrapper $request_wrapper;
    protected ILIAS\Refinery\Factory $refinery;


    public function __construct(
        ilGlobalTemplateInterface $tpl,
        ilCtrl $ilCtrl,
        ilToolbarGUI $ilToolbar,
        ilLanguage $lng,
        Factory $ui_factory,
        MessageBox\Factory $message_box_factory,
        Button\Factory $button_factory,
        Renderer $ui_renderer,
        Psr\Http\Message\ServerRequestInterface $request,
        ilTree $tree,
        ILIAS\HTTP\Wrapper\RequestWrapper $request_wrapper,
        ILIAS\Refinery\Factory $refinery
    ) {
        $this->tpl = $tpl;
        $this->ctrl = $ilCtrl;
        $this->toolbar = $ilToolbar;
        $this->lng = $lng;
        $this->ui_factory = $ui_factory;
        $this->message_box_factory = $message_box_factory;
        $this->button_factory = $button_factory;
        $this->ui_renderer = $ui_renderer;
        $this->request = $request;
        $this->tree = $tree;
        $this->request_wrapper = $request_wrapper;
        $this->refinery = $refinery;
    }

    public function executeCommand(): void
    {
        $cmd = $this->ctrl->getCmd();
        $next_class = $this->ctrl->getNextClass($this);

        switch ($next_class) {
            case "ilpropertyformgui":
                $form = $this->getForm();
                $this->ctrl->forwardCommand($form);
                break;
            default:
                switch ($cmd) {
                    case self::CMD_VIEW:
                    case self::CMD_DELETE:
                    case self::CMD_DELETE_CONFIRMATION:
                    case self::CMD_GET_ASYNC_MODAL:
                        $this->$cmd();
                        break;
                    case self::CMD_SAVE:
                        $this->$cmd();
                        $this->ctrl->redirect($this, 'view');
                        break;
                    case self::CMD_PROFILE_NOT_PUBLIC:
                        $this->view(true);
                        break;
                    default:
                        throw new ilException("ilObjStudyProgrammeAutoCategoriesGUI: Command not supported: $cmd");
                }
        }
    }

    protected function view(bool $profile_not_public = false): void
    {
        if ($profile_not_public) {
            $this->tpl->setOnScreenMessage("info", $this->lng->txt('prg_profile_not_public'));
        }

        $collected_modals = [];

        $modal = $this->getModal();
        $this->getToolbar($modal->getShowSignal());
        $collected_modals[] = $modal;

        $data = [];
        foreach ($this->getObject()->getAutomaticContentCategories() as $ac) {
            $ref_id = $ac->getCategoryRefId();
            if (ilObject::_lookupType($ref_id, true) !== 'cat' || $this->tree->isDeleted($ref_id)) {
                continue;
            }
            [$title, $link] = $this->getItemPath($ref_id);
            $usr = $this->getUserRepresentation($ac->getLastEditorId());
            $modal = $this->getModal($ref_id);
            $collected_modals[] = $modal;
            $actions = $this->getItemAction(
                $ac->getCategoryRefId(),
                $modal->getShowSignal()
            );

            $data[] = [
                $ac,
                $this->ui_renderer->render($link),
                $this->ui_renderer->render($usr),
                $this->ui_renderer->render($actions),
                $title
            ];
        }
        usort($data, static function (array $a, array $b): int {
            return strnatcasecmp($a[4], $b[4]);
        });

        $table = new ilStudyProgrammeAutoCategoriesTableGUI($this, "view", "");
        $table->setData($data);

        $this->tpl->setContent(
            $this->ui_renderer->render($collected_modals)
            . $table->getHTML()
        );
    }

    protected function save(): void
    {
        $form = $this->getForm();
        $form->setValuesByPost();
        $form->checkInput();

        $cat_ref_id = $form->getInput(self::F_CATEGORY_REF);
        $current_ref_id = $form->getInput(self::F_CATEGORY_ORIGINAL_REF);

        if (ilObject::_lookupType((int) $cat_ref_id, true) !== 'cat') {
            $this->tpl->setOnScreenMessage(
                "failure",
                sprintf($this->lng->txt('not_a_valid_cat_id'), $cat_ref_id),
                true
            );
            return;
        }

        if (!is_null($current_ref_id) && $current_ref_id !== $cat_ref_id) {
            $ids = [(int) $current_ref_id];
            $this->getObject()->deleteAutomaticContentCategories($ids);
        }

        $this->getObject()->storeAutomaticContentCategory((int) $cat_ref_id);
    }

    protected function deleteConfirmation(): void
    {
        $get = $this->request->getQueryParams();
        $post = $this->request->getParsedBody();
        $field = self::CHECKBOX_CATEGORY_REF_IDS;

        $field_ids_in_get = array_key_exists($field, $get);
        $field_ids_in_post = array_key_exists($field, $post);

        $msg = '';
        $cat_ids = '';
        if ($field_ids_in_get) {
            $cat_ids = $get[$field];
            $msg = $this->lng->txt('prg_delete_single_confirmation');
        } elseif ($field_ids_in_post) {
            $cat_ids = implode(' ', $post[$field]);
            $msg = $this->lng->txt('prg_delete_confirmation');
        } else {
            $this->tpl->setOnScreenMessage("info", $this->lng->txt('prg_delete_nothing_selected'), true);
            $this->ctrl->redirect($this, self::CMD_VIEW);
        }

        $cat_ids = base64_encode($cat_ids);

        $this->ctrl->setParameterByClass(self::class, $field, $cat_ids);
        $delete = $this->ctrl->getFormActionByClass(self::class, self::CMD_DELETE);
        $cancel = $this->ctrl->getFormActionByClass(self::class, self::CMD_VIEW);
        $this->ctrl->clearParameterByClass(self::class, $field);

        $buttons = [
            $this->button_factory->standard($this->lng->txt('prg_confirm_delete'), $delete),
            $this->button_factory->standard($this->lng->txt('prg_cancel'), $cancel)
        ];

        $message_box = $this->message_box_factory->confirmation($msg)->withButtons($buttons);

        $this->tpl->setContent($this->ui_renderer->render($message_box));
    }

    protected function delete(): void
    {
        $field = self::CHECKBOX_CATEGORY_REF_IDS;
        $get = $this->request->getQueryParams();

        if (!array_key_exists($field, $get)) {
            $this->tpl->setOnScreenMessage("failure", $this->lng->txt('prg_delete_failure'), true);
            $this->ctrl->redirect($this, self::CMD_VIEW);
        }

        $cat_ids = base64_decode($get[$field]);
        $cat_ids = explode(' ', trim($cat_ids));
        $cat_ids = array_map('intval', $cat_ids);

        $this->getObject()->deleteAutomaticContentCategories($cat_ids);

        $msg = $this->lng->txt('prg_delete_single_success');
        if (count($cat_ids) > 1) {
            $msg = $this->lng->txt('prg_delete_success');
        }

        $this->tpl->setOnScreenMessage("success", $msg, true);
        $this->ctrl->redirect($this, self::CMD_VIEW);
    }

    public function setRefId(int $prg_ref_id): void
    {
        $this->prg_ref_id = $prg_ref_id;
    }

    protected function getObject(): ilObjStudyProgramme
    {
        if ($this->object === null ||
            $this->object->getRefId() !== $this->prg_ref_id
        ) {
            $this->object = ilObjStudyProgramme::getInstanceByRefId($this->prg_ref_id);
        }
        return $this->object;
    }

    protected function getModal(int $current_ref_id = null): RoundTrip
    {
        if (!is_null($current_ref_id)) {
            $this->ctrl->setParameter($this, self::CHECKBOX_CATEGORY_REF_IDS, (string) $current_ref_id);
        }
        $link = $this->ctrl->getLinkTarget($this, "getAsyncModalOutput", "", true);
        $this->ctrl->setParameter($this, self::CHECKBOX_CATEGORY_REF_IDS, null);
        return $this->ui_factory->modal()->roundtrip(
            '',
            []
        )->withAsyncRenderUrl(
            $link
        );
    }

    protected function getAsyncModalOutput(): void
    {
        $current_ref_id = null;
        if ($this->request_wrapper->has(self::CHECKBOX_CATEGORY_REF_IDS)) {
            $current_ref_id = $this->request_wrapper->retrieve(
                self::CHECKBOX_CATEGORY_REF_IDS,
                $this->refinery->kindlyTo()->int()
            );
        }
        $form = $this->getForm($current_ref_id);
        $form_id = "form_" . $form->getId();
        $submit = $this->ui_factory->button()->primary($this->lng->txt('add'), "#")->withOnLoadCode(
            function ($id) use ($form_id) {
                return "$('#$id').click(function() { document.getElementById('$form_id').submit(); return false; });";
            }
        );
        $modal = $this->ui_factory->modal()
            ->roundtrip(
                $this->lng->txt('modal_categories_title'),
                $this->ui_factory->legacy($form->getHtml())
            )
            ->withActionButtons([$submit])
            ->withAdditionalOnLoadCode(
                function ($id) use ($form) {
                    $selector_post_var = self::F_CATEGORY_REF;
                    $js = $form->getItemByPostVar($selector_post_var)->getOnloadCode();
                    return implode(';', $js);
                }
            );


        echo $this->ui_renderer->renderAsync($modal);
        exit;
    }

    protected function getForm(?int $current_ref_id = null): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();

        $form->setId(uniqid((string) $current_ref_id, true));

        $form->setFormAction($this->ctrl->getFormAction($this, "save"));
        $cat = new ilRepositorySelector2InputGUI(
            $this->lng->txt("category"),
            self::F_CATEGORY_REF,
            false
        );
        $cat->getExplorerGUI()->setSelectableTypes(["cat"]);
        $cat->getExplorerGUI()->setTypeWhiteList(["root", "cat"]);
        if ($current_ref_id !== null) {
            $cat->getExplorerGUI()->setPathOpen($current_ref_id);
            $cat->setValue($current_ref_id);
        }
        $cat->getExplorerGUI()->setRootId(ROOT_FOLDER_ID);
        $cat->getExplorerGUI()->setAjax(false);
        $form->addItem($cat);

        $hi = new ilHiddenInputGUI(self::F_CATEGORY_ORIGINAL_REF);
        $hi->setValue((string)$current_ref_id ?? "");
        $form->addItem($hi);

        return $form;
    }

    protected function getToolbar(Signal $add_cat_signal): void
    {
        $btn = $this->ui_factory->button()->primary($this->lng->txt('add_category'), '')
                                ->withOnClick($add_cat_signal);
        $this->toolbar->addComponent($btn);
    }

    protected function getItemAction(
        int $cat_ref_id,
        Signal $signal
    ): Standard {
        $items = [];
        $items[] = $this->ui_factory
            ->button()
            ->shy($this->lng->txt('edit'), '')
            ->withOnClick($signal)
        ;

        $this->ctrl->setParameterByClass(self::class, self::CHECKBOX_CATEGORY_REF_IDS, $cat_ref_id);
        $link = $this->ctrl->getLinkTarget($this, self::CMD_DELETE_CONFIRMATION);
        $this->ctrl->clearParameterByClass(self::class, self::CHECKBOX_CATEGORY_REF_IDS);

        $items[] = $this->ui_factory
            ->button()
            ->shy($this->lng->txt('delete'), $link)
        ;

        return $this->ui_factory->dropdown()->standard($items);
    }

    protected function getUserRepresentation(int $usr_id): Link
    {
        $username = ilObjUser::_lookupName($usr_id);
        $editor = implode(' ', [
            $username['firstname'],
            $username['lastname'],
            '(' . $username['login'] . ')'
        ]);
        $usr = ilObjectFactory::getInstanceByObjId($usr_id);
        $url = ilLink::_getStaticLink($usr_id, 'usr');
        if (!$usr->hasPublicProfile()) {
            $url = $this->ctrl->getLinkTarget($this, self::CMD_PROFILE_NOT_PUBLIC);
        }
        return $this->ui_factory->link()->standard($editor, $url);
    }

    protected function getItemPath(int $cat_ref_id): array
    {
        $url = ilLink::_getStaticLink($cat_ref_id, 'cat');

        $hops = array_map(
            static function (array $c): string {
                return ilObject::_lookupTitle((int)$c["obj_id"]);
            },
            $this->tree->getPathFull($cat_ref_id)
        );
        $path = implode(' > ', $hops);
        return [$path, $this->ui_factory->link()->standard($path, $url)];
    }
}