Inheritance diagram for ilObjTestSettingsScoringResultsGUI:

Collaboration diagram for ilObjTestSettingsScoringResultsGUI:

Public Member Functions
	__construct (ilCtrlInterface $ctrl, ilAccessHandler $access, ilLanguage $lng, ilTree $tree, ilDBInterface $db, ilComponentRepository $component_repository, ilObjTestGUI $testGUI, \ilGlobalTemplateInterface $main_template, ilTabsGUI $tabs, ScoreSettingsRepository $score_settings_repo, int $test_id, UIFactory $ui_factory, UIRenderer $ui_renderer, Refinery $refinery, Request $request, ilObjUser $active_user)

	executeCommand ()
	Command Execution. More...

Public Member Functions inherited from ilTestSettingsGUI
	__construct (ilObjTest $testOBJ)

Data Fields
const	CMD_SHOW_FORM = 'showForm'
	command constants More...

const	CMD_SAVE_FORM = 'saveForm'

const	CMD_CONFIRMED_RECALC = 'saveFormAndRecalc'

const	CMD_CANCEL_RECALC = 'cancelSaveForm'

Protected Member Functions
	loadScoreSettings ()

	storeScoreSettings (ilObjTestScoreSettings $score_settings)

	getTaxonomyOptions ()

	isScoreRecalculationRequired (ilObjTestSettingsScoring $new_settings, ilObjTestSettingsScoring $old_settings)

Protected Member Functions inherited from ilTestSettingsGUI
	getTemplateSettingValue ($settingName)

	isHiddenFormItem ($formFieldId)

	isSectionHeaderRequired ($fields)

	formPropertyExists (ilPropertyFormGUI $form, $propertyId)

	removeHiddenItems (ilPropertyFormGUI $form)

Protected Attributes
ilCtrlInterface	$ctrl

ilAccessHandler	$access

ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilTree	$tree

ilDBInterface	$db

ilComponentRepository	$component_repository

ilObjTestGUI	$testGUI

ScoreSettingsRepository	$score_settings_repo

int	$test_id

UIFactory	$ui_factory

UIRenderer	$ui_renderer

Refinery	$refinery

ilTabsGUI	$tabs

ilObjUser	$active_user

Protected Attributes inherited from ilTestSettingsGUI
ilObjTest	$testOBJ

ilSettingsTemplate	$settingsTemplate = null

Private Member Functions
	showForm (Form $form=null)

	saveForm ()

	getRelayedRequest ()

	buildForm ()

	areScoringSettingsWritable ()

	showConfirmation (Request $request)

Private Attributes
const	F_CONFIRM_SETTINGS = 'f_settings'

ilTestQuestionSetConfigFactory	$testQuestionSetConfigFactory

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjTestSettingsScoringResultsGUI::__construct	(	ilCtrlInterface	$ctrl,
		ilAccessHandler	$access,
		ilLanguage	$lng,
		ilTree	$tree,
		ilDBInterface	$db,
		ilComponentRepository	$component_repository,
		ilObjTestGUI	$testGUI,
		\ilGlobalTemplateInterface	$main_template,
		ilTabsGUI	$tabs,
		ScoreSettingsRepository	$score_settings_repo,
		int	$test_id,
		UIFactory	$ui_factory,
		UIRenderer	$ui_renderer,
		Refinery	$refinery,
		Request	$request,
		ilObjUser	$active_user
	)

Definition at line 68 of file class.ilObjTestSettingsScoringResultsGUI.php.

      {
        $this->ctrl = $ctrl;
        $this->access = $access;
        $this->lng = $lng;
        $this->tree = $tree;
        $this->db = $db;
        $this->component_repository = $component_repository;
        $this->testGUI = $testGUI;
        $this->testOBJ = $testGUI->getObject();
        $this->tpl = $main_template;
        $this->tabs = $tabs;
        $this->active_user = $active_user;
 
        $this->testQuestionSetConfigFactory = new ilTestQuestionSetConfigFactory(
            $this->tree,
            $this->db,
            $this->component_repository,
            $this->testOBJ
        );
 
        $templateId = $this->testOBJ->getTemplate();
 
        if ($templateId) {
            $this->settingsTemplate = new ilSettingsTemplate(
                (int) $templateId,
                ilObjAssessmentFolderGUI::getSettingsTemplateConfig()
            );
        }
 
        $this->score_settings_repo = $score_settings_repo;
        $this->test_id = $test_id;
        $this->ui_factory = $ui_factory;
        $this->ui_renderer = $ui_renderer;
        $this->refinery = $refinery;
        $this->request = $request;
    }

References $access, $active_user, $component_repository, $ctrl, $db, $lng, $refinery, $score_settings_repo, $tabs, $test_id, $testGUI, $tree, $ui_factory, $ui_renderer, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ilObjectGUI\getObject(), ilObjAssessmentFolderGUI\getSettingsTemplateConfig(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\tabs().

Here is the call graph for this function:

Member Function Documentation

◆ areScoringSettingsWritable()

ilObjTestSettingsScoringResultsGUI::areScoringSettingsWritable ( )

private

Definition at line 299 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                                 : bool
    {
        if (!$this->testOBJ->participantDataExist()) {
            return true;
        }
 
        if (!$this->isScoreReportingAvailable()) {
            return true;
        }
 
        return false;
    }

Referenced by buildForm().

Here is the caller graph for this function:

◆ buildForm()

ilObjTestSettingsScoringResultsGUI::buildForm ( )

private

Definition at line 228 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                : Form
    {
        $ui_pack = [
            $this->lng,
            $this->ui_factory->input()->field(),
            $this->refinery
        ];
 
        $environment = [];
        $df = (new \ILIAS\Data\Factory())->dateFormat();
        switch ($this->active_user->getDateFormat()) {
            case ilCalendarSettings::DATE_FORMAT_DMY:
                $date_format = $df->germanShort();
                break;
            case ilCalendarSettings::DATE_FORMAT_MDY:
                //americanShort
                $date_format = $df->custom()->month()->slash()->day()->slash()->year()->get();
                break;
            case ilCalendarSettings::DATE_FORMAT_YMD:
            default:
                $date_format = $df->standard();
        }
        $environment['user_date_format'] = $date_format;
        $environment['user_time_zone'] = $this->active_user->getTimeZone();
 
        $disabled_flag = ($this->areScoringSettingsWritable() === false);
 
        $settings = $this->loadScoreSettings();
        $sections = [
            'scoring' => $settings->getScoringSettings()->toForm(...$ui_pack)
                ->withDisabled($disabled_flag),
            'summary' => $settings->getResultSummarySettings()->toForm(...array_merge($ui_pack, [$environment])),
            'details' => $settings->getResultDetailsSettings()->toForm(
                ...array_merge($ui_pack, [['taxonomy_options' => $this->getTaxonomyOptions()]])
            ),
            'gameification' => $settings->getGamificationSettings()->toForm(...$ui_pack)
        ];
 
        $action = $this->ctrl->getFormAction($this, self::CMD_SAVE_FORM);
        $form = $this->ui_factory->input()->container()->form()
            ->standard($action, $sections)
            ->withAdditionalTransformation(
                $this->refinery->custom()->transformation(
                    function ($v) use ($settings) {
                        return $settings
                            ->withScoringSettings($v['scoring'])
                            ->withResultSummarySettings($v['summary'])
                            ->withResultDetailsSettings($v['details'])
                            ->withGamificationSettings($v['gameification'])
                        ;
                    }
                )
            );
        return $form;
    }

References $lng, $refinery, ILIAS\LTI\ToolProvider\$settings, areScoringSettingsWritable(), ILIAS\Repository\ctrl(), ilCalendarSettings\DATE_FORMAT_DMY, ilCalendarSettings\DATE_FORMAT_MDY, ilCalendarSettings\DATE_FORMAT_YMD, function, getTaxonomyOptions(), loadScoreSettings(), and ILIAS\Repository\refinery().

Referenced by executeCommand(), saveForm(), and showForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjTestSettingsScoringResultsGUI::executeCommand ( )

Command Execution.

Definition at line 134 of file class.ilObjTestSettingsScoringResultsGUI.php.

    {
        if (!$this->access->checkAccess('write', '', $this->testGUI->getRefId())) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('cannot_edit_test'), true);
            $this->ctrl->redirect($this->testGUI, 'infoScreen');
        }
 
        $this->tabs->activateTab(ilTestTabsManager::TAB_ID_SETTINGS);
 
        $nextClass = $this->ctrl->getNextClass();
        switch ($nextClass) {
            default:
                $cmd = $this->ctrl->getCmd(self::CMD_SHOW_FORM);
 
                switch ($cmd) {
                    case self::CMD_SHOW_FORM:
                        $this->showForm();
                        break;
                    case self::CMD_SAVE_FORM:
                        $this->saveForm();
                        break;
                    case self::CMD_CONFIRMED_RECALC:
                        $this->saveForm();
                        $settings = $this->buildForm()
                            ->withRequest($this->getRelayedRequest())
                            ->getData();
                        $this->storeScoreSettings($settings);
                        $this->testOBJ->recalculateScores(true);
                        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_score_settings_modified_and_recalc"), true);
                        $this->ctrl->redirect($this, self::CMD_SHOW_FORM);
                        break;
                    case self::CMD_CANCEL_RECALC:
                        $this->tpl->setOnScreenMessage('info', $this->lng->txt("msg_score_settings_not_modified"), true);
                        $form = $this->buildForm()->withRequest($this->getRelayedRequest());
                        $this->showForm($form);
                        break;
                    default:
                        throw new Exception('unknown command: ' . $cmd);
                }
        }
    }

References ILIAS\LTI\ToolProvider\$settings, ILIAS\Repository\access(), buildForm(), CMD_CANCEL_RECALC, CMD_CONFIRMED_RECALC, CMD_SAVE_FORM, CMD_SHOW_FORM, ILIAS\Repository\ctrl(), getRelayedRequest(), ILIAS\Repository\lng(), saveForm(), showForm(), storeScoreSettings(), ilTestTabsManager\TAB_ID_SETTINGS, and ILIAS\Repository\tabs().

Here is the call graph for this function:

◆ getRelayedRequest()

ilObjTestSettingsScoringResultsGUI::getRelayedRequest ( )

private

Definition at line 211 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                        : Request
    {
        return unserialize(
            base64_decode(
                $this->request->getParsedBody()[self::F_CONFIRM_SETTINGS]
            ),
            [
                'allowed_classes' => [
                    GuzzleHttp\Psr7\ServerRequest::class,
                    GuzzleHttp\Psr7\Uri::class,
                    GuzzleHttp\Psr7\UploadedFile::class,
                    GuzzleHttp\Psr7\Stream::class,
                ]
            ]
        );
    }

Referenced by executeCommand().

Here is the caller graph for this function:

◆ getTaxonomyOptions()

ilObjTestSettingsScoringResultsGUI::getTaxonomyOptions ( )

protected

Definition at line 312 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                           : array
    {
        $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($this->testOBJ->getId());
        $taxononmy_translator = new ilTestTaxonomyFilterLabelTranslater($this->db);
        $taxononmy_translator->loadLabelsFromTaxonomyIds($available_taxonomy_ids);
 
        $taxonomy_options = [];
        foreach ($available_taxonomy_ids as $tax_id) {
            $taxonomy_options[$tax_id] = $taxononmy_translator->getTaxonomyTreeLabel($tax_id);
        }
        return $taxonomy_options;
    }

References ilObjTaxonomy\getUsageOfObject().

Referenced by buildForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isScoreRecalculationRequired()

ilObjTestSettingsScoringResultsGUI::isScoreRecalculationRequired	(	ilObjTestSettingsScoring	$new_settings,
		ilObjTestSettingsScoring	$old_settings
	)

protected

Definition at line 325 of file class.ilObjTestSettingsScoringResultsGUI.php.

     : bool {
        $settings_changed = (
            $new_settings->getCountSystem() !== $old_settings->getCountSystem() ||
            $new_settings->getScoreCutting() !== $old_settings->getScoreCutting() ||
            $new_settings->getPassScoring() !== $old_settings->getPassScoring()
        );
 
        return
            $this->testOBJ->participantDataExist() &&
            $this->areScoringSettingsWritable() &&
            $settings_changed;
    }

Referenced by saveForm().

Here is the caller graph for this function:

◆ loadScoreSettings()

ilObjTestSettingsScoringResultsGUI::loadScoreSettings ( )

protected

Definition at line 122 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                          : ilObjTestScoreSettings
    {
        return $this->score_settings_repo->getFor($this->test_id);
    }

Referenced by buildForm().

Here is the caller graph for this function:

◆ saveForm()

ilObjTestSettingsScoringResultsGUI::saveForm ( )

private

Definition at line 185 of file class.ilObjTestSettingsScoringResultsGUI.php.

                               : void
    {
        $form = $this->buildForm()
            ->withRequest($this->request);
 
        $settings = $form->getData();
 
        if (is_null($settings)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
            $this->showForm($form);
            return;
        }
 
        if ($this->isScoreRecalculationRequired(
            $settings->getScoringSettings(),
            $this->loadScoreSettings()->getScoringSettings()
        )) {
            $this->showConfirmation($this->request);
            return;
        }
 
        $this->storeScoreSettings($settings);
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, self::CMD_SHOW_FORM);
    }

References ILIAS\LTI\ToolProvider\$settings, buildForm(), ILIAS\Repository\ctrl(), isScoreRecalculationRequired(), ILIAS\Repository\lng(), showConfirmation(), showForm(), and storeScoreSettings().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showConfirmation()

ilObjTestSettingsScoringResultsGUI::showConfirmation ( Request $request )

private

Definition at line 342 of file class.ilObjTestSettingsScoringResultsGUI.php.

    {
        $confirmation = new ilConfirmationGUI();
        $confirmation->setHeaderText($this->lng->txt('tst_trigger_result_refreshing'));
        $confirmation->setFormAction($this->ctrl->getFormAction($this));
        $confirmation->setCancel($this->lng->txt('cancel'), self::CMD_CANCEL_RECALC);
        $confirmation->setConfirm($this->lng->txt('confirm'), self::CMD_CONFIRMED_RECALC);
        $confirmation->addHiddenItem(self::F_CONFIRM_SETTINGS, base64_encode(serialize($request)));
        $this->tpl->setContent($this->ctrl->getHTML($confirmation));
    }

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

Referenced by saveForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showForm()

ilObjTestSettingsScoringResultsGUI::showForm ( Form $form = null )

private

Definition at line 176 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                                : void
    {
        if ($form === null) {
            $form = $this->buildForm();
        }
 
        $this->tpl->setContent($this->ui_renderer->render($form));
    }

References buildForm().

Referenced by executeCommand(), and saveForm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeScoreSettings()

ilObjTestSettingsScoringResultsGUI::storeScoreSettings ( ilObjTestScoreSettings $score_settings )

protected

Definition at line 126 of file class.ilObjTestSettingsScoringResultsGUI.php.

                                                                                 : void
    {
        $this->score_settings_repo->store($score_settings);
    }

Referenced by executeCommand(), and saveForm().

Here is the caller graph for this function: