class.ilObjQuestionPoolSettingsGeneralGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Input\Container\Form\Standard as Form;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\UI\Renderer as UIRenderer;
use Psr\Http\Message\ServerRequestInterface as HttpRequest;
use ILIAS\UI\Component\MessageBox\MessageBox;

class ilObjQuestionPoolSettingsGeneralGUI
{
    public const CMD_SHOW_GENERAL_FORM = 'showForm';
    public const CMD_SAVE_GENERAL_FORM = 'saveForm';
    public const TAB_COMMON_SETTINGS = 'settings';
    protected ilObjQuestionPool|ilObject $poolOBJ;

    public function __construct(
        private readonly ilCtrl $ctrl,
        private readonly ilAccessHandler $access,
        private readonly ilLanguage $lng,
        private readonly ilGlobalTemplateInterface $tpl,
        private readonly ilTabsGUI $tabs,
        private readonly ilObjQuestionPoolGUI $poolGUI,
        private readonly Refinery $refinery,
        private readonly UIFactory $ui_factory,
        private readonly UIRenderer $ui_renderer,
        private readonly HttpRequest $http_request,
    ) {
        $this->poolOBJ = $poolGUI->getObject();
    }

    public function executeCommand(): void
    {
        // allow only write access

        if (!$this->access->checkAccess('write', '', $this->poolGUI->getRefId())) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('cannot_edit_question_pool'), true);
            $this->ctrl->redirectByClass(
                [
                    ilRepositoryGUI::class,
                    self::class,
                    ilInfoScreenGUI::class
                ],
                'showSummary'
            );
        }

        $this->tabs->activateTab('settings');
        $this->tabs->activateSubTab('qpl_settings_subtab_general');

        // process command

        $nextClass = $this->ctrl->getNextClass();

        switch ($nextClass) {
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_SHOW_GENERAL_FORM) . 'Cmd';
                $this->$cmd();
        }
    }

    private function showFormCmd(?Form $form = null): void
    {
        $this->tabs->activateSubTab(self::TAB_COMMON_SETTINGS);
        if ($form === null) {
            $form = $this->buildForm();
        }
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

    private function saveFormCmd(): void
    {
        $form = $this->buildForm()->withRequest($this->http_request);
        $result = $form->getInputGroup()->getContent();

        if (!$result->isOK()) {
            $this->tpl->setOnScreenMessage(MessageBox::FAILURE, $this->lng->txt('form_input_not_valid'));
            $this->showFormCmd($form);
            return;
        }

        $this->performSaveForm($result->value());
        $this->tpl->setOnScreenMessage(MessageBox::SUCCESS, $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, self::CMD_SHOW_GENERAL_FORM);

    }

    private function performSaveForm($data): void
    {
        $title_and_description = $data['general_settings']['title_and_description'] ?? null;
        if ($title_and_description instanceof ilObjectPropertyTitleAndDescription) {
            $this->poolOBJ->getObjectProperties()->storePropertyTitleAndDescription(
                $title_and_description
            );
        }

        $this->poolOBJ->getObjectProperties()->storePropertyIsOnline(
            $data['availability']['online'] ?? $this->poolOBJ->getObjectProperties()->getPropertyIsOnline()->withOffline()
        );

        $display_settings = $data['display_settings'] ?? [];
        if (isset($display_settings['tile_image'])) {
            $this->poolOBJ->getObjectProperties()->storePropertyTileImage($display_settings['tile_image']);
        }

        $this->poolOBJ->setSkillServiceEnabled($data['additional_features']['skill_service'] ?? false);

        $this->poolOBJ->saveToDb();
    }

    private function buildForm(): Form
    {
        $items = [];

        $title_and_description = $this->poolOBJ->getObjectProperties()->getPropertyTitleAndDescription()->toForm(
            $this->lng,
            $this->ui_factory->input()->field(),
            $this->refinery
        );

        $items['general_settings'] = $this->ui_factory->input()->field()->section(
            [
                'title_and_description' => $title_and_description
            ],
            $this->lng->txt('qpl_form_general_settings')
        );

        $online = $this->poolOBJ->getObjectProperties()->getPropertyIsOnline()->toForm(
            $this->lng,
            $this->ui_factory->input()->field(),
            $this->refinery
        );
        $availability = $this->ui_factory->input()->field()->section(
            ['online' => $online],
            $this->lng->txt('qpl_settings_availability')
        );
        $items['availability'] = $availability;

        $timg = $this->poolOBJ->getObjectProperties()->getPropertyTileImage()->toForm(
            $this->lng,
            $this->ui_factory->input()->field(),
            $this->refinery
        );
        $items['display_settings'] = $this->ui_factory->input()->field()->section(
            ['tile_image' => $timg],
            $this->lng->txt('tst_presentation_settings_section')
        );

        $additional_features_inputs = [];

        if (ilObjQuestionPool::isSkillManagementGloballyActivated()) {
            $additional_features_inputs['skill_service'] = $this->ui_factory->input()->field()->checkbox(
                $this->lng->txt('tst_activate_skill_service')
            )->withValue($this->poolOBJ->isSkillServiceEnabled());
        }

        $items['additional_features'] = $this->ui_factory->input()->field()->section(
            $additional_features_inputs,
            $this->lng->txt('obj_features')
        );

        return $this->ui_factory->input()->container()->form()->standard(
            $this->ctrl->getFormAction($this, self::CMD_SAVE_GENERAL_FORM),
            $items
        );
    }
}