ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction Class Reference

Inheritance diagram for ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction:

Collaboration diagram for ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction:

Public Member Functions
	__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,)
	getActionId ()
	buildTableAction (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token)
	buildModal (URLBuilder $url_builder, array $selected_templates)
	onSubmit (URLBuilder $url_builder, ServerRequestInterface $request, array $selected_templates,)
	getActionId ()
	buildTableAction (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token)
	buildModal (URLBuilder $url_builder, array $selected_templates)
	onSubmit (URLBuilder $url_builder, ServerRequestInterface $request, array $selected_templates,)

Data Fields
const string	ACTION_ID = 'apply_template'

Private Member Functions
	checkSelectedTemplate (array $selected_templates)
	hasDifferentQuestionSetType (int $template_settings_id)

Detailed Description

Definition at line 36 of file PersonalSettingsTableApplyAction.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::__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
	)

Definition at line 40 of file PersonalSettingsTableApplyAction.php.

      {
    }

Member Function Documentation

buildModal()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::buildModal	(	URLBuilder	$url_builder,
		array	$selected_templates
	)

Parameters

array<PersonalSettingsTemplate>

$selected_templates

Implements ILIAS\Test\Settings\Templates\TableAction.

Definition at line 73 of file PersonalSettingsTableApplyAction.php.

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

buildTableAction()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::buildTableAction	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

Implements ILIAS\Test\Settings\Templates\TableAction.

Definition at line 58 of file PersonalSettingsTableApplyAction.php.

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

checkSelectedTemplate()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::checkSelectedTemplate ( array  $selected_templates )

private

Definition at line 131 of file PersonalSettingsTableApplyAction.php.

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

getActionId()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::getActionId

(

)

Implements ILIAS\Test\Settings\Templates\TableAction.

Definition at line 53 of file PersonalSettingsTableApplyAction.php.

                                 : string
    {
        return self::ACTION_ID;
    }

References ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction\ACTION_ID.

hasDifferentQuestionSetType()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::hasDifferentQuestionSetType ( int  $template_settings_id )

private

Definition at line 145 of file PersonalSettingsTableApplyAction.php.

                                                                           : bool
    {
        $template_main_settings = $this->main_settings_repository->getById($template_settings_id);
        return $template_main_settings->getGeneralSettings()->getQuestionSetType() !== $this->test_obj->getQuestionSetType();
    }

onSubmit()

ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::onSubmit	(	URLBuilder	$url_builder,
		ServerRequestInterface	$request,
		array	$selected_templates
	)

Parameters

array<PersonalSettingsTemplate>

$selected_templates

Implements ILIAS\Test\Settings\Templates\TableAction.

Definition at line 96 of file PersonalSettingsTableApplyAction.php.

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

Field Documentation

ACTION_ID

const string ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction::ACTION_ID = 'apply_template'

Definition at line 38 of file PersonalSettingsTableApplyAction.php.

Referenced by ILIAS\Test\Settings\Templates\PersonalSettingsTableApplyAction\getActionId().

---

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

• components/ILIAS/Test/src/Settings/Templates/PersonalSettingsTableApplyAction.php