Collaboration diagram for ILIAS\Test\Presentation\TestScreenGUI:

Public Member Functions
	__construct (private readonly \ilObjTest $object, private readonly \ilObjUser $user, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly \ilLanguage $lng, private readonly Refinery $refinery, private readonly \ilCtrlInterface $ctrl, private readonly \ilGlobalTemplateInterface $tpl, private readonly ContentStyle $content_style, private readonly HTTPServices $http, private readonly TabsManager $tabs_manager, private readonly \ilAccessHandler $access, private readonly \ilTestAccess $test_access, private readonly \ilDBInterface $database, private readonly \ilRbacSystem $rbac_system)

	executeCommand ()

	testScreen ()

Data Fields
const	DEFAULT_CMD = 'testScreen'

Private Member Functions
	handleRenderMessageBox (array $elements)

	handleRenderIntroduction (array $elements)

	handleRenderLauncher (array $elements)

	getLauncher ()

	getResumeLauncherLink ()

	buildModalLauncher ()

	getModalLauncherLink ()

	getModalLauncherInputs ()

	getModalLauncherMessageBox ()

	getStartLauncherLink ()

	evaluateLauncherModalForm (Result $result)

	testCanBeStarted ()

	isUserOutOfProcessingTime ()

	blockUserAfterHavingPassed ()

	hasAvailablePasses ()

	lastPassSuspended ()

	isModalLauncherNeeded ()

	getSkillLevelThresholdsMissingInfo ()

	areSkillLevelThresholdsMissing ()

	buildLinkTarget (?string $cmd=null)

Private Attributes
readonly ilTestPassesSelector	$test_passes_selector

readonly int	$ref_id

readonly MainSettings	$main_settings

readonly ilTestSession	$test_session

readonly DataFactory	$data_factory

ilTestPasswordChecker	$password_checker

Detailed Description

Class TestScreenGUI.

Author: Matheus Zych mzych.nosp@m.@dat.nosp@m.abay..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Presentation\TestScreenGUI::__construct	(	private readonly \ilObjTest	$object,
		private readonly \ilObjUser	$user,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly \ilLanguage	$lng,
		private readonly Refinery	$refinery,
		private readonly \ilCtrlInterface	$ctrl,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly ContentStyle	$content_style,
		private readonly HTTPServices	$http,
		private readonly TabsManager	$tabs_manager,
		private readonly \ilAccessHandler	$access,
		private readonly \ilTestAccess	$test_access,
		private readonly \ilDBInterface	$database,
		private readonly \ilRbacSystem	$rbac_system
	)

Definition at line 56 of file class.TestScreenGUI.php.

References ILIAS\Repository\database(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

       {
         $this->ref_id = $this->object->getRefId();
         $this->main_settings = $this->object->getMainSettings();
         $this->data_factory = new DataFactory();
 
         $this->test_session = (new \ilTestSessionFactory($this->object, $this->database, $this->user))->getSession();
 
         $this->test_passes_selector = new \ilTestPassesSelector($this->database, $this->object);
         $this->test_passes_selector->setActiveId($this->test_session->getActiveId());
         $this->test_passes_selector->setLastFinishedPass($this->test_session->getLastFinishedPass());
         $this->password_checker = new \ilTestPasswordChecker($this->rbac_system, $this->user, $this->object, $this->lng);
     }

Here is the call graph for this function:

Member Function Documentation

◆ areSkillLevelThresholdsMissing()

ILIAS\Test\Presentation\TestScreenGUI::areSkillLevelThresholdsMissing ( )

private

Definition at line 570 of file class.TestScreenGUI.php.

References $data, ILIAS\Repository\database(), and ILIAS\Repository\object().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\testScreen().

                                                      : bool
     {
         if (!$this->object->isSkillServiceEnabled()) {
             return false;
         }
 
         $questionContainerId = $this->object->getId();
 
         $assignmentList = new \ilAssQuestionSkillAssignmentList($this->database);
         $assignmentList->setParentObjId($questionContainerId);
         $assignmentList->loadFromDb();
 
         foreach ($assignmentList->getUniqueAssignedSkills() as $data) {
             foreach ($data['skill']->getLevelData() as $level) {
                 $threshold = new \ilTestSkillLevelThreshold($this->database);
                 $threshold->setTestId($this->object->getTestId());
                 $threshold->setSkillBaseId($data['skill_base_id']);
                 $threshold->setSkillTrefId($data['skill_tref_id']);
                 $threshold->setSkillLevelId($level['id']);
 
                 if (!$threshold->dbRecordExists()) {
                     return true;
                 }
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ blockUserAfterHavingPassed()

ILIAS\Test\Presentation\TestScreenGUI::blockUserAfterHavingPassed ( )

private

Definition at line 521 of file class.TestScreenGUI.php.

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                                  : bool
     {
         if ($this->main_settings->getTestBehaviourSettings()->getBlockAfterPassedEnabled()) {
             return $this->test_passes_selector->getLastFinishedPass() >= 0
                 && $this->test_passes_selector->hasTestPassedOnce($this->test_session->getActiveId());
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ buildLinkTarget()

ILIAS\Test\Presentation\TestScreenGUI::buildLinkTarget ( ?string $cmd = null )

private

Definition at line 599 of file class.TestScreenGUI.php.

References ILIAS\Repository\ctrl().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getSkillLevelThresholdsMissingInfo().

                                                          : string
     {
         $target = array_merge(['ilRepositoryGUI', 'ilObjTestGUI'], ['ilTestSkillAdministrationGUI', 'ilTestSkillLevelThresholdsGUI']);
         return $this->ctrl->getLinkTargetByClass($target, $cmd);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildModalLauncher()

ILIAS\Test\Presentation\TestScreenGUI::buildModalLauncher ( )

private

Definition at line 301 of file class.TestScreenGUI.php.

References ILIAS\Test\Presentation\TestScreenGUI\evaluateLauncherModalForm(), ILIAS\Test\Presentation\TestScreenGUI\getModalLauncherInputs(), ILIAS\Test\Presentation\TestScreenGUI\getModalLauncherLink(), ILIAS\Test\Presentation\TestScreenGUI\getModalLauncherMessageBox(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                          : Launcher
     {
         $launcher = $this->ui_factory->launcher()->inline($this->getModalLauncherLink())
             ->withInputs(
                 $this->ui_factory->input()->field()->group($this->getModalLauncherInputs()),
                 function (Result $result) {
                     $this->evaluateLauncherModalForm($result);
                 },
                 $this->getModalLauncherMessageBox()
             )->withModalSubmitLabel($this->lng->txt('continue'));
 
         $request = $this->http->request();
         $key = 'launcher_id';
         if (array_key_exists($key, $request->getQueryParams())
             && $request->getQueryParams()[$key] === 'exam_modal') {
             $launcher = $launcher->withRequest($request);
         }
         return $launcher;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ evaluateLauncherModalForm()

ILIAS\Test\Presentation\TestScreenGUI::evaluateLauncherModalForm ( Result $result )

private

Definition at line 401 of file class.TestScreenGUI.php.

References $_SERVER, $message, ILIAS\Repository\ctrl(), ilTestPlayerCommands\INIT_TEST, ILIAS\Data\Result\isOK(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, null, ILIAS\Repository\object(), ilSession\set(), ILIAS\Repository\user(), and ILIAS\Data\Result\value().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\buildModalLauncher().

                                                               : void
     {
         if ($result->isOK()) {
             $conditions_met = true;
             $message = '';
             $access_settings_password = $this->main_settings->getAccessSettings()->getPassword();
             $anonymous = $this->user->isAnonymous();
             foreach ($result->value() as $key => $value) {
 
                 switch ($key) {
                     case 'exam_conditions':
                         $exam_conditions_value = (bool) $value;
                         if (!$exam_conditions_value) {
                             $conditions_met = false;
                             $message .= $this->lng->txt('tst_exam_conditions_not_checked_message') . '<br>';
                         }
                         break;
                     case 'exam_password':
                         $password = $value;
                         $exam_password_valid = ($password === $access_settings_password);
                         if (!$exam_password_valid) {
                             $conditions_met = false;
                             $message .= $this->lng->txt('tst_exam_password_invalid_message') . '<br>';
                             if ($this->object->getTestLogger()->isLoggingEnabled()
                                 && !$this->object->getAnonymity()) {
                                 $logger = $this->object->getTestLogger();
                                 $logger->logParticipantInteraction(
                                     $logger->getInteractionFactory()->buildParticipantInteraction(
                                         $this->ref_id,
                                         null,
                                         $this->user->getId(),
                                         $_SERVER['REMOTE_ADDR'],
                                         TestParticipantInteractionTypes::WRONG_TEST_PASSWORD_PROVIDED,
                                         []
                                     )
                                 );
                             }
                         }
                         $this->password_checker->setUserEnteredPassword($password);
                         break;
                     case 'exam_access_code':
                         if ($anonymous && !empty($value)) {
                             $this->test_session->setAccessCodeToSession($value);
                         } else {
                             $this->test_session->unsetAccessCodeInSession();
                         }
                         break;
                     case 'exam_use_previous_answers':
                         $exam_use_previous_answers_value = (string) (int) $value;
                         break;
                 }
             }
 
             if ($message !== '') {
                 $this->tpl->setOnScreenMessage(\ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE, $message, true);
             }
 
             if (empty($result->value())) {
                 $this->tpl->setOnScreenMessage(
                     \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                     $this->lng->txt('tst_exam_required_fields_not_filled_message'),
                     true
                 );
             } elseif ($conditions_met) {
                 if (
                     !$anonymous &&
                     $this->main_settings->getParticipantFunctionalitySettings()->getUsePreviousAnswerAllowed()
                 ) {
                     $this->user->setPref('tst_use_previous_answers', $exam_use_previous_answers_value ?? '0');
                     $this->user->update();
                 }
 
                 if (isset($password) && $password === $access_settings_password) {
                     \ilSession::set('tst_password_' . $this->object->getTestId(), $password);
                 } else {
                     \ilSession::set('tst_password_' . $this->object->getTestId(), '');
                     $this->test_session->setPasswordChecked(false);
                 }
 
                 $this->ctrl->redirectByClass(
                     (new \ilTestPlayerFactory($this->object))->getPlayerGUI()::class,
                     \ilTestPlayerCommands::INIT_TEST
                 );
             }
         } else {
             $this->tpl->setOnScreenMessage(
                 \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                 $this->lng->txt('tst_exam_required_fields_not_filled_message'),
                 true
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ILIAS\Test\Presentation\TestScreenGUI::executeCommand ( )

Definition at line 85 of file class.TestScreenGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), ROOT_FOLDER_ID, and ILIAS\Test\Presentation\TabsManager\TAB_ID_TEST.

                                     : void
     {
         if ($this->access->checkAccess('read', '', $this->ref_id)) {
             $this->{$this->ctrl->getCmd(self::DEFAULT_CMD)}();
             return;
         }
 
         $this->tabs_manager->activateTab(TabsManager::TAB_ID_TEST);
 
         if (!$this->object->getMainSettings()->getAdditionalSettings()->getHideInfoTab()) {
             $this->ctrl->redirectByClass([\ilRepositoryGUI::class, \ilObjTestGUI::class, \ilInfoScreenGUI::class]);
         }
 
         $this->tpl->setOnScreenMessage('failure', sprintf(
             $this->lng->txt('msg_no_perm_read_item'),
             $this->object->getTitle()
         ), true);
         $this->ctrl->setParameterByClass(\ilRepositoryGUI::class, 'ref_id', ROOT_FOLDER_ID);
         $this->ctrl->redirectByClass(\ilRepositoryGUI::class);
     }

Here is the call graph for this function:

◆ getLauncher()

ILIAS\Test\Presentation\TestScreenGUI::getLauncher ( )

private

Definition at line 205 of file class.TestScreenGUI.php.

Referenced by ILIAS\Test\Presentation\TestScreenGUI\handleRenderLauncher().

                                   : Launcher
     {
         $launcher_factory = $this->ui_factory->launcher();
 
         if ($this->object->isStartingTimeEnabled() && !$this->object->startingTimeReached()) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel(sprintf(
                     $this->lng->txt('detail_starting_time_not_reached'),
                     \ilDatePresentation::formatDate(new \ilDateTime($this->object->getStartingTime(), IL_CAL_UNIX))
                 ), false)
             ;
         }
 
         if ($this->object->isEndingTimeEnabled() && $this->object->endingTimeReached()) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel(sprintf(
                     $this->lng->txt('detail_ending_time_reached'),
                     \ilDatePresentation::formatDate(new \ilDateTime($this->object->getEndingTime(), IL_CAL_UNIX))
                 ), false)
             ;
         }
 
         if ($this->isUserOutOfProcessingTime()) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel($this->lng->txt('tst_out_of_time_message'), false)
             ;
         }
 
         $participant_access = $this->test_access->isParticipantAllowed(
             $this->object->getId(),
             $this->user->getId()
         );
 
         if ($participant_access === ParticipantAccess::NOT_INVITED) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel($this->lng->txt('tst_exam_not_assigned_participant_disclaimer'), false)
             ;
         }
 
         if ($participant_access !== ParticipantAccess::ALLOWED) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel($participant_access->getAccessForbiddenMessage($this->lng), false)
             ;
         }
 
         if (!$this->hasAvailablePasses()) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel($this->lng->txt('tst_launcher_button_label_passes_limit_reached'), false);
         }
 
         if ($this->blockUserAfterHavingPassed()) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel($this->lng->txt('tst_already_passed_cannot_retake'), false)
             ;
         }
 
         $next_pass_allowed_timestamp = 0;
         if (!$this->object->isNextPassAllowed($this->test_passes_selector, $next_pass_allowed_timestamp)) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel(
                     sprintf(
                         $this->lng->txt('wait_for_next_pass_hint_msg'),
                         \ilDatePresentation::formatDate(new \ilDateTime($next_pass_allowed_timestamp, IL_CAL_UNIX)),
                     ),
                     false
                 )
             ;
         }
 
         if ($this->lastPassSuspended()) {
             return $launcher_factory->inline($this->getResumeLauncherLink());
         }
 
         if ($this->isModalLauncherNeeded()) {
             return $this->buildModalLauncher();
         }
         return $launcher_factory->inline($this->getStartLauncherLink());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModalLauncherInputs()

ILIAS\Test\Presentation\TestScreenGUI::getModalLauncherInputs ( )

private

Definition at line 327 of file class.TestScreenGUI.php.

References ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Data\Password\toString(), and ILIAS\Repository\user().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\buildModalLauncher().

                                              : array
     {
         if ($this->main_settings->getIntroductionSettings()->getExamConditionsCheckboxEnabled()) {
             $modal_inputs['exam_conditions'] = $this->ui_factory->input()->field()->checkbox(
                 $this->lng->txt('tst_exam_conditions'),
                 $this->lng->txt('tst_exam_conditions_label')
             )->withRequired(true);
         }
 
         if ($this->main_settings->getAccessSettings()->getPasswordEnabled()) {
             $modal_inputs['exam_password'] = $this->ui_factory->input()->field()->password(
                 $this->lng->txt('tst_exam_password'),
                 $this->lng->txt('tst_exam_password_label')
             )->withRevelation(true)
             ->withRequired(true)
             ->withAdditionalTransformation(
                 $this->refinery->custom()->transformation(
                     static function (Password $value): string {
                         return $value->toString();
                     }
                 )
             );
         }
 
         if ($this->user->isAnonymous()) {
             $access_code_input = $this->ui_factory->input()->field()->text(
                 $this->lng->txt('tst_exam_access_code'),
                 $this->lng->txt('tst_exam_access_code_label')
             );
 
             $access_code_from_session = $this->test_session->getAccessCodeFromSession();
             if ($access_code_from_session) {
                 $access_code_input = $access_code_input->withValue($access_code_from_session);
             }
 
             $modal_inputs['exam_access_code'] = $access_code_input;
         }
 
         if ($this->main_settings->getParticipantFunctionalitySettings()->getUsePreviousAnswerAllowed()
             && $this->test_passes_selector->getLastFinishedPass() >= 0) {
             $modal_inputs['exam_use_previous_answers'] = $this->ui_factory->input()->field()->checkbox(
                 $this->lng->txt('tst_exam_use_previous_answers'),
                 $this->lng->txt('tst_exam_use_previous_answers_label')
             );
         }
 
         return $modal_inputs ?? [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModalLauncherLink()

ILIAS\Test\Presentation\TestScreenGUI::getModalLauncherLink ( )

private

Definition at line 321 of file class.TestScreenGUI.php.

References ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\buildModalLauncher().

                                            : Link
     {
         $uri = $this->data_factory->uri($this->http->request()->getUri()->__toString())->withParameter('launcher_id', 'exam_modal');
         return $this->data_factory->link($this->lng->txt('tst_exam_start'), $uri);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getModalLauncherMessageBox()

ILIAS\Test\Presentation\TestScreenGUI::getModalLauncherMessageBox ( )

private

Definition at line 376 of file class.TestScreenGUI.php.

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

Referenced by ILIAS\Test\Presentation\TestScreenGUI\buildModalLauncher().

                                                  : ?MessageBox
     {
         $exam_conditions_enabled = $this->main_settings->getIntroductionSettings()->getExamConditionsCheckboxEnabled();
         $password_enabled = $this->main_settings->getAccessSettings()->getPasswordEnabled();
 
         if ($exam_conditions_enabled && $password_enabled) {
             $modal_message_box_message = $this->lng->txt('tst_exam_modal_message_conditions_and_password');
         } elseif ($exam_conditions_enabled) {
             $modal_message_box_message = $this->lng->txt('tst_exam_modal_message_conditions');
         } elseif ($password_enabled) {
             $modal_message_box_message = $this->lng->txt('tst_exam_modal_message_password');
         }
 
         return isset($modal_message_box_message) ? $this->ui_factory->messageBox()->info($modal_message_box_message) : null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getResumeLauncherLink()

ILIAS\Test\Presentation\TestScreenGUI::getResumeLauncherLink ( )

private

Definition at line 292 of file class.TestScreenGUI.php.

References $url, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilTestPlayerCommands\RESUME_PLAYER.

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                             : Link
     {
         $url = $this->ctrl->getLinkTarget(
             (new \ilTestPlayerFactory($this->object))->getPlayerGUI(),
             \ilTestPlayerCommands::RESUME_PLAYER
         );
         return $this->data_factory->link($this->lng->txt('tst_resume_test'), $this->data_factory->uri(ILIAS_HTTP_PATH . '/' . $url));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSkillLevelThresholdsMissingInfo()

ILIAS\Test\Presentation\TestScreenGUI::getSkillLevelThresholdsMissingInfo ( )

private

Definition at line 554 of file class.TestScreenGUI.php.

References $message, ILIAS\Test\Presentation\TestScreenGUI\buildLinkTarget(), ilTestSkillLevelThresholdsGUI\CMD_SHOW_SKILL_THRESHOLDS, and ILIAS\Repository\lng().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\testScreen().

                                                          : MessageBox
     {
         $message = $this->lng->txt('tst_skl_level_thresholds_missing');
 
         $link_target = $this->buildLinkTarget(
             \ilTestSkillLevelThresholdsGUI::CMD_SHOW_SKILL_THRESHOLDS
         );
 
         $link = $this->ui_factory->link()->standard(
             $this->lng->txt('tst_skl_level_thresholds_link'),
             $link_target
         );
 
         return $this->ui_factory->messageBox()->failure($message)->withLinks([$link]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getStartLauncherLink()

ILIAS\Test\Presentation\TestScreenGUI::getStartLauncherLink ( )

private

Definition at line 392 of file class.TestScreenGUI.php.

References $url, ILIAS\Repository\ctrl(), ilTestPlayerCommands\INIT_TEST, and ILIAS\Repository\lng().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                            : Link
     {
         $url = $this->ctrl->getLinkTarget(
             (new \ilTestPlayerFactory($this->object))->getPlayerGUI(),
             \ilTestPlayerCommands::INIT_TEST
         );
         return $this->data_factory->link($this->lng->txt('tst_exam_start'), $this->data_factory->uri(ILIAS_HTTP_PATH . '/' . $url));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRenderIntroduction()

ILIAS\Test\Presentation\TestScreenGUI::handleRenderIntroduction ( array $elements )

private

Definition at line 181 of file class.TestScreenGUI.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\testScreen().

                                                               : array
     {
         $introduction = $this->object->getIntroduction();
 
         if (
             $this->main_settings->getIntroductionSettings()->getIntroductionEnabled() &&
             !empty($introduction)
         ) {
             $this->content_style->gui()->addCss($this->tpl, $this->ref_id);
             $elements[] = $this->ui_factory->panel()->standard(
                 $this->lng->txt('tst_introduction'),
                 $this->ui_factory->legacy()->content($introduction),
             );
         }
 
         return $elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRenderLauncher()

ILIAS\Test\Presentation\TestScreenGUI::handleRenderLauncher ( array $elements )

private

Definition at line 199 of file class.TestScreenGUI.php.

References ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\testScreen().

                                                           : array
     {
         $elements[] = $this->getLauncher();
         return $elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRenderMessageBox()

ILIAS\Test\Presentation\TestScreenGUI::handleRenderMessageBox ( array $elements )

private

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

References ilDatePresentation\formatDate(), IL_CAL_UNIX, ILIAS\Test\Presentation\TestScreenGUI\isUserOutOfProcessingTime(), ILIAS\Repository\lng(), and ILIAS\Repository\object().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\testScreen().

                                                             : array
     {
         $message_box_message = '';
         $message_box_message_elements = [];
 
         $exam_conditions_enabled = $this->main_settings->getIntroductionSettings()->getExamConditionsCheckboxEnabled();
         $password_enabled = $this->main_settings->getAccessSettings()->getPasswordEnabled();
         $test_behaviour_settings = $this->main_settings->getTestBehaviourSettings();
 
         if ($exam_conditions_enabled && $password_enabled) {
             $message_box_message_elements[] = $this->lng->txt('tst_launcher_status_message_conditions_and_password');
         } elseif ($exam_conditions_enabled) {
             $message_box_message_elements[] = $this->lng->txt('tst_launcher_status_message_conditions');
         } elseif ($password_enabled) {
             $message_box_message_elements[] = $this->lng->txt('tst_launcher_status_message_password');
         }
 
         if ($test_behaviour_settings->getProcessingTimeEnabled() && !$this->isUserOutOfProcessingTime()) {
             $message_box_message_elements[] = sprintf(
                 $this->lng->txt('tst_time_limit_message'),
                 $test_behaviour_settings->getProcessingTimeAsMinutes()
             );
         }
 
         $nr_of_tries = $this->object->getNrOfTries();
 
         if ($nr_of_tries !== 0) {
             $message_box_message_elements[] = sprintf($this->lng->txt('tst_attempt_limit_message'), $nr_of_tries);
         }
 
         if ($this->object->isStartingTimeEnabled() && !$this->object->startingTimeReached()) {
             $message_box_message_elements[] = sprintf(
                 $this->lng->txt('detail_starting_time_not_reached'),
                 \ilDatePresentation::formatDate(new \ilDateTime($this->object->getStartingTime(), IL_CAL_UNIX))
             );
         }
 
         if ($this->object->isEndingTimeEnabled() && !$this->object->endingTimeReached()) {
             $message_box_message_elements[] = sprintf(
                 $this->lng->txt('tst_exam_ending_time_message'),
                 \ilDatePresentation::formatDate(new \ilDateTime($this->object->getEndingTime(), IL_CAL_UNIX))
             );
         }
 
         foreach ($message_box_message_elements as $message_box_message_element) {
             $message_box_message .= ' ' . $message_box_message_element;
         }
 
         if (!empty($message_box_message)) {
             $elements[] = $this->ui_factory->messageBox()->info($message_box_message);
         }
 
         return $elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAvailablePasses()

ILIAS\Test\Presentation\TestScreenGUI::hasAvailablePasses ( )

private

Definition at line 531 of file class.TestScreenGUI.php.

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                          : bool
     {
         $nr_of_tries = $this->object->getNrOfTries();
 
         return $nr_of_tries === 0 || (count($this->test_passes_selector->getExistingPasses()) <= $nr_of_tries && count($this->test_passes_selector->getClosedPasses()) < $nr_of_tries);
     }

Here is the caller graph for this function:

◆ isModalLauncherNeeded()

ILIAS\Test\Presentation\TestScreenGUI::isModalLauncherNeeded ( )

private

Definition at line 543 of file class.TestScreenGUI.php.

References ILIAS\Repository\user().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                             : bool
     {
         return (
             $this->main_settings->getIntroductionSettings()->getExamConditionsCheckboxEnabled()
             || $this->main_settings->getAccessSettings()->getPasswordEnabled()
             || $this->main_settings->getParticipantFunctionalitySettings()->getUsePreviousAnswerAllowed()
                 && $this->test_passes_selector->getLastFinishedPass() >= 0
             || $this->user->isAnonymous()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUserOutOfProcessingTime()

ILIAS\Test\Presentation\TestScreenGUI::isUserOutOfProcessingTime ( )

private

Definition at line 504 of file class.TestScreenGUI.php.

References null, and ILIAS\Repository\object().

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher(), and ILIAS\Test\Presentation\TestScreenGUI\handleRenderMessageBox().

                                                 : bool
     {
         $test_behaviour_settings = $this->object->getMainSettings()->getTestBehaviourSettings();
         if (!$test_behaviour_settings->getProcessingTimeEnabled()
             || $test_behaviour_settings->getResetProcessingTime()) {
             return false;
         }
 
         $active_id = $this->test_passes_selector->getActiveId();
         $last_started_pass = $this->test_session->getLastStartedPass();
         return $last_started_pass !== null
             && $this->object->isMaxProcessingTimeReached(
                 $this->object->getStartingTimeOfUser($active_id, $last_started_pass),
                 $active_id
             );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lastPassSuspended()

ILIAS\Test\Presentation\TestScreenGUI::lastPassSuspended ( )

private

Definition at line 538 of file class.TestScreenGUI.php.

Referenced by ILIAS\Test\Presentation\TestScreenGUI\getLauncher().

                                         : bool
     {
         return (count($this->test_passes_selector->getExistingPasses()) - count($this->test_passes_selector->getClosedPasses())) === 1;
     }

Here is the caller graph for this function:

◆ testCanBeStarted()

ILIAS\Test\Presentation\TestScreenGUI::testCanBeStarted ( )

private

Definition at line 494 of file class.TestScreenGUI.php.

References ILIAS\Repository\object().

                                        : bool
     {
         if ($this->object->getOfflineStatus()
             || !$this->object->isComplete($this->object->getQuestionSetConfig())) {
             return false;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ testScreen()

ILIAS\Test\Presentation\TestScreenGUI::testScreen ( )

Definition at line 106 of file class.TestScreenGUI.php.

References ILIAS\Test\Presentation\TestScreenGUI\$ref_id, ILIAS\Test\Presentation\TestScreenGUI\areSkillLevelThresholdsMissing(), ILIAS\Test\Presentation\TestScreenGUI\getSkillLevelThresholdsMissingInfo(), ILIAS\Test\Presentation\TestScreenGUI\handleRenderIntroduction(), ILIAS\Test\Presentation\TestScreenGUI\handleRenderLauncher(), ILIAS\Test\Presentation\TestScreenGUI\handleRenderMessageBox(), ILIAS\Repository\object(), and ILIAS\Test\Presentation\TabsManager\TAB_ID_TEST.

                                 : void
     {
         $this->tabs_manager->activateTab(TabsManager::TAB_ID_TEST);
         $this->tpl->setPermanentLink($this->object->getType(), $this->ref_id);
 
         $elements = [];
 
         if ($this->areSkillLevelThresholdsMissing()) {
             $elements = [$this->getSkillLevelThresholdsMissingInfo()];
         }
         $elements = $this->handleRenderMessageBox($elements);
         $elements = $this->handleRenderIntroduction($elements);
 
         $this->tpl->setContent(
             $this->ui_renderer->render(
                 $this->testCanBeStarted() ? $this->handleRenderLauncher($elements) : $elements
             )
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $data_factory

readonly DataFactory ILIAS\Test\Presentation\TestScreenGUI::$data_factory

private

Definition at line 53 of file class.TestScreenGUI.php.

◆ $main_settings

readonly MainSettings ILIAS\Test\Presentation\TestScreenGUI::$main_settings

private

Definition at line 51 of file class.TestScreenGUI.php.

◆ $password_checker

ilTestPasswordChecker ILIAS\Test\Presentation\TestScreenGUI::$password_checker

private

Definition at line 54 of file class.TestScreenGUI.php.

◆ $ref_id

readonly int ILIAS\Test\Presentation\TestScreenGUI::$ref_id

private

Definition at line 50 of file class.TestScreenGUI.php.

Referenced by ILIAS\Test\Presentation\TestScreenGUI\testScreen().

◆ $test_passes_selector

readonly ilTestPassesSelector ILIAS\Test\Presentation\TestScreenGUI::$test_passes_selector

private

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

◆ $test_session

readonly ilTestSession ILIAS\Test\Presentation\TestScreenGUI::$test_session

private

Definition at line 52 of file class.TestScreenGUI.php.

◆ DEFAULT_CMD

const ILIAS\Test\Presentation\TestScreenGUI::DEFAULT_CMD = 'testScreen'

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

Referenced by ILIAS\Test\Presentation\TabsManager\setupTabsGuiConfig().

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

components/ILIAS/Test/src/Presentation/class.TestScreenGUI.php

Public Member Functions

Data Fields

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ areSkillLevelThresholdsMissing()

◆ blockUserAfterHavingPassed()

◆ buildLinkTarget()

◆ buildModalLauncher()

◆ evaluateLauncherModalForm()

◆ executeCommand()

◆ getLauncher()

◆ getModalLauncherInputs()

◆ getModalLauncherLink()

◆ getModalLauncherMessageBox()

◆ getResumeLauncherLink()

◆ getSkillLevelThresholdsMissingInfo()

◆ getStartLauncherLink()

◆ handleRenderIntroduction()

◆ handleRenderLauncher()

◆ handleRenderMessageBox()

◆ hasAvailablePasses()

◆ isModalLauncherNeeded()

◆ isUserOutOfProcessingTime()

◆ lastPassSuspended()

◆ testCanBeStarted()

◆ testScreen()

Field Documentation

◆ $data_factory

◆ $main_settings

◆ $password_checker

◆ $ref_id

◆ $test_passes_selector

◆ $test_session

◆ DEFAULT_CMD