PersonalSettingsTableApplyAction.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
namespace ILIAS\Test\Settings\Templates;
 
use ILIAS\Language\Language;
use ILIAS\Test\Participants\ParticipantTableActions;
use ILIAS\Test\Scoring\Marks\MarksRepository;
use ILIAS\Test\Settings\MainSettings\MainSettingsRepository;
use ILIAS\Test\Settings\ScoreReporting\ScoreSettingsRepository;
use ILIAS\UI\Component\Modal\Modal;
use ILIAS\UI\Component\Table\Action\Action;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\URLBuilder;
use ILIAS\UI\URLBuilderToken;
use ILIAS\UICore\GlobalTemplate;
use Psr\Http\Message\ServerRequestInterface;
 
class PersonalSettingsTableApplyAction implements TableAction
{
    public const string ACTION_ID = 'apply_template';
 
    public function __construct(
        private readonly Language $lng,
        private readonly UIFactory $ui_factory,
        private readonly \ilTestQuestionSetConfigFactory $question_set_config_factory,
        private readonly GlobalTemplate $tpl,
        private readonly \ilObjTest $test_obj,
        private readonly PersonalSettingsRepository $repository,
        private readonly MainSettingsRepository $main_settings_repository,
        private readonly ScoreSettingsRepository $score_settings_repository,
        private readonly MarksRepository $marks_repository,
    ) {
    }
 
    public function getActionId(): string
    {
        return self::ACTION_ID;
    }
 
    public function buildTableAction(
        URLBuilder $url_builder,
        URLBuilderToken $row_id_token,
        URLBuilderToken $action_token,
        URLBuilderToken $action_type_token
    ): Action {
        return $this->ui_factory->table()->action()->single(
            $this->lng->txt('personal_settings_apply'),
            $url_builder
                ->withParameter($action_token, self::ACTION_ID)
                ->withParameter($action_type_token, ParticipantTableActions::SHOW_ACTION),
            $row_id_token
        )->withAsync();
    }
 
    public function buildModal(
        URLBuilder $url_builder,
        array $selected_templates
    ): ?Modal {
        $template = $this->checkSelectedTemplate($selected_templates);
        $question_set_type_changed = $this->hasDifferentQuestionSetType($template->getSettingsId());
 
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('confirm'),
            $this->lng->txt($question_set_type_changed ? 'personal_settings_apply_changed_confirmation' : 'personal_settings_apply_confirmation'),
            $url_builder->buildURI()->__toString()
        )->withAffectedItems(
            [
                $this->ui_factory->modal()->interruptiveItem()->standard(
                    (string) $template->getId(),
                    $template->getName(),
                    null,
                    sprintf($this->lng->txt('personal_settings_apply_description'), $this->test_obj->getTitle()),
                ),
            ]
        )->withActionButtonLabel($this->lng->txt('apply'));
    }
 
    public function onSubmit(
        URLBuilder $url_builder,
        ServerRequestInterface $request,
        array $selected_templates,
    ): ?Modal {
        $template = $this->checkSelectedTemplate($selected_templates);
 
        $old_question_set_config = $this->hasDifferentQuestionSetType($template->getSettingsId()) ?
            $this->question_set_config_factory->getQuestionSetConfig() :
            null;
 
        $test_settings_id = $this->test_obj->getMainSettings()->getId();
        $main_settings = $this->main_settings_repository->getById($template->getSettingsId());
        $score_settings = $this->score_settings_repository->getById($template->getSettingsId());
 
        $mark_schema = $this->marks_repository->getMarkSchemaBySteps(
            $this->repository->lookupMarkSteps($template->getId())
        );
 
        $this->main_settings_repository->store($main_settings->withId($test_settings_id));
        $this->score_settings_repository->store($score_settings->withId($test_settings_id));
        $this->marks_repository->storeMarkSchema($mark_schema->withTestId($this->test_obj->getTestId()));
 
        if ($old_question_set_config && $old_question_set_config->doesQuestionSetRelatedDataExist()) {
            $old_question_set_config->removeQuestionSetRelatedData();
        }
 
        $this->tpl->setOnScreenMessage(
            GlobalTemplate::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('personal_settings_apply_success'),
            true
        );
        return null;
    }
 
    private function checkSelectedTemplate(array $selected_templates): PersonalSettingsTemplate
    {
        if (count($selected_templates) !== 1) {
            throw new \InvalidArgumentException('personal_settings_invalid_selection');
        }
 
        // Do not apply if user datasets exist
        if ($this->test_obj->evalTotalPersons() > 0) {
            throw new \InvalidArgumentException('personal_settings_apply_not_possible');
        }
 
        return reset($selected_templates);
    }
 
    private function hasDifferentQuestionSetType(int $template_settings_id): bool
    {
        $template_main_settings = $this->main_settings_repository->getById($template_settings_id);
        return $template_main_settings->getGeneralSettings()->getQuestionSetType() !== $this->test_obj->getQuestionSetType();
    }
}