Inheritance diagram for ilObjTestSettingsScoringResultsGUI:

Collaboration diagram for ilObjTestSettingsScoringResultsGUI:

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

	executeCommand ()
	Command Execution. More...

Public Member Functions inherited from ilTestSettingsGUI
	__construct (protected ilObjTest $test_object)

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
	formPropertyExists (ilPropertyFormGUI $form, $propertyId)

Private Member Functions
	showForm (Form $form=null)

	saveForm ()

	getRelayedRequest ()

	buildForm ()

	isScoreReportingAvailable ()

	areScoringSettingsWritable ()

	showConfirmation (Request $request)

Private Attributes
const	F_CONFIRM_SETTINGS = 'f_settings'

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References ILIAS\MetaData\Repository\Validation\Data\__construct(), and ilObjectGUI\getObject().

       {
         parent::__construct($test_gui->getObject());
 
         $template_id = $this->test_object->getTemplate();
 
         if ($template_id) {
             $this->settingsTemplate = new ilSettingsTemplate(
                 (int) $template_id,
                 ilObjAssessmentFolderGUI::getSettingsTemplateConfig()
             );
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ areScoringSettingsWritable()

ilObjTestSettingsScoringResultsGUI::areScoringSettingsWritable ( )

private

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

References isScoreReportingAvailable().

Referenced by buildForm(), and isScoreRecalculationRequired().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildForm()

ilObjTestSettingsScoringResultsGUI::buildForm ( )

private

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

References $lng, ILIAS\Repository\$refinery, ILIAS\LTI\ToolProvider\$settings, areScoringSettingsWritable(), ILIAS\Repository\ctrl(), getTaxonomyOptions(), loadScoreSettings(), and ILIAS\Repository\refinery().

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

                                 : Form
     {
         $ui_pack = [
             $this->lng,
             $this->ui_factory->input()->field(),
             $this->refinery
         ];
 
 
         $environment = [];
         $environment['user_date_format'] = (new \ILIAS\Data\Factory())->dateFormat()->withTime24(
             $this->active_user->getDateFormat()
         );
         $environment['user_time_zone'] = $this->active_user->getTimeZone();
 
         $anonymity_flag = (bool) $this->test_object->getAnonymity();
         $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;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilObjTestSettingsScoringResultsGUI::executeCommand ( )

Command Execution.

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

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

     {
         if (!$this->access->checkAccess('write', '', $this->test_gui->getRefId())) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt('cannot_edit_test'), true);
             $this->ctrl->redirect($this->test_gui, '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->test_object->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);
                 }
         }
     }

Here is the call graph for this function:

◆ getRelayedRequest()

ilObjTestSettingsScoringResultsGUI::getRelayedRequest ( )

private

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

Referenced by executeCommand().

                                         : Request
     {
         return unserialize(
             base64_decode(
                 $this->request->getParsedBody()[self::F_CONFIRM_SETTINGS]
             )
         );
     }

Here is the caller graph for this function:

◆ getTaxonomyOptions()

ilObjTestSettingsScoringResultsGUI::getTaxonomyOptions ( )

protected

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

References ilObjTaxonomy\getUsageOfObject(), and ILIAS\Repository\lng().

Referenced by buildForm().

                                            : array
     {
         $available_taxonomy_ids = ilObjTaxonomy::getUsageOfObject($this->test_object->getId());
         $taxononmy_translator = new ilTestQuestionFilterLabelTranslater($this->db, $this->lng);
         $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;
     }

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 264 of file class.ilObjTestSettingsScoringResultsGUI.php.

References areScoringSettingsWritable(), ilObjTestSettingsScoring\getCountSystem(), ilObjTestSettingsScoring\getPassScoring(), and ilObjTestSettingsScoring\getScoreCutting().

Referenced by saveForm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isScoreReportingAvailable()

ilObjTestSettingsScoringResultsGUI::isScoreReportingAvailable ( )

private

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

References ilObjTestSettingsResultSummary\SCORE_REPORTING_DATE.

Referenced by areScoringSettingsWritable().

                                                 : bool
     {
         if (!$this->test_object->getScoreReporting()) {
             return false;
         }
 
         if ($this->test_object->getScoreReporting() == ilObjTestSettingsResultSummary::SCORE_REPORTING_DATE) {
             $reporting_date = $this->test_object->getScoreSettings()->getResultSummarySettings()->getReportingDate();
             return $reporting_date <= new DateTimeImmutable('now', new DateTimeZone('UTC'));
         }
 
         return true;
     }

Here is the caller graph for this function:

◆ loadScoreSettings()

ilObjTestSettingsScoringResultsGUI::loadScoreSettings ( )

protected

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

Referenced by buildForm(), and saveForm().

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

Here is the caller graph for this function:

◆ saveForm()

ilObjTestSettingsScoringResultsGUI::saveForm ( )

private

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

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

Referenced by executeCommand().

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

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 281 of file class.ilObjTestSettingsScoringResultsGUI.php.

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

Referenced by saveForm().

     {
         $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));
     }

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 133 of file class.ilObjTestSettingsScoringResultsGUI.php.

References buildForm().

Referenced by executeCommand(), and saveForm().

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

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 83 of file class.ilObjTestSettingsScoringResultsGUI.php.

Referenced by executeCommand(), and saveForm().

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

Here is the caller graph for this function:

Field Documentation

◆ CMD_CANCEL_RECALC

const ilObjTestSettingsScoringResultsGUI::CMD_CANCEL_RECALC = 'cancelSaveForm'

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

◆ CMD_CONFIRMED_RECALC

const ilObjTestSettingsScoringResultsGUI::CMD_CONFIRMED_RECALC = 'saveFormAndRecalc'

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

◆ CMD_SAVE_FORM

const ilObjTestSettingsScoringResultsGUI::CMD_SAVE_FORM = 'saveForm'

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

◆ CMD_SHOW_FORM

const ilObjTestSettingsScoringResultsGUI::CMD_SHOW_FORM = 'showForm'

command constants

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

◆ F_CONFIRM_SETTINGS

const ilObjTestSettingsScoringResultsGUI::F_CONFIRM_SETTINGS = 'f_settings'

private

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

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

Modules/Test/classes/class.ilObjTestSettingsScoringResultsGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ areScoringSettingsWritable()

◆ buildForm()

◆ executeCommand()

◆ getRelayedRequest()

◆ getTaxonomyOptions()

◆ isScoreRecalculationRequired()

◆ isScoreReportingAvailable()

◆ loadScoreSettings()

◆ saveForm()

◆ showConfirmation()

◆ showForm()

◆ storeScoreSettings()

Field Documentation

◆ CMD_CANCEL_RECALC

◆ CMD_CONFIRMED_RECALC

◆ CMD_SAVE_FORM

◆ CMD_SHOW_FORM

◆ F_CONFIRM_SETTINGS