Collaboration diagram for ilTestScreenGUI:

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 ilCtrl $ctrl, private readonly ilGlobalTemplateInterface $tpl, private readonly ContentStyle $content_style, private readonly HTTPServices $http, private readonly ilTabsGUI $tabs, private readonly ilAccessHandler $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 ilObjTestMainSettings	$main_settings

readonly ilTestSession	$test_session

readonly DataFactory	$data_factory

ilTestPasswordChecker	$password_checker

Detailed Description

Class ilTestScreenGUI.

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

Definition at line 39 of file class.ilTestScreenGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestScreenGUI::__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 ilCtrl	$ctrl,
		private readonly ilGlobalTemplateInterface	$tpl,
		private readonly ContentStyle	$content_style,
		private readonly HTTPServices	$http,
		private readonly ilTabsGUI	$tabs,
		private readonly ilAccessHandler	$access,
		private readonly ilDBInterface	$database,
		private readonly ilRbacSystem	$rbac_system
	)

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

References 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()

ilTestScreenGUI::areSkillLevelThresholdsMissing ( )

private

Definition at line 525 of file class.ilTestScreenGUI.php.

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

Referenced by 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()

ilTestScreenGUI::blockUserAfterHavingPassed ( )

private

Definition at line 476 of file class.ilTestScreenGUI.php.

Referenced by 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()

ilTestScreenGUI::buildLinkTarget ( string $cmd = null )

private

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

References ILIAS\Repository\ctrl().

Referenced by 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()

ilTestScreenGUI::buildModalLauncher ( )

private

Definition at line 284 of file class.ilTestScreenGUI.php.

References ILIAS\LTI\ToolProvider\$key, evaluateLauncherModalForm(), getModalLauncherInputs(), getModalLauncherLink(), getModalLauncherMessageBox(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Referenced by 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()

ilTestScreenGUI::evaluateLauncherModalForm ( Result $result )

private

Definition at line 381 of file class.ilTestScreenGUI.php.

References ILIAS\LTI\ToolProvider\$key, $message, ILIAS\Repository\ctrl(), ilTestPlayerCommands\INIT_TEST, ILIAS\Data\Result\isOK(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\MESSAGE_TYPE_FAILURE, ILIAS\Repository\object(), ilSession\set(), ILIAS\Repository\user(), and ILIAS\Data\Result\value().

Referenced by 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>';
                         }
                         $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()

ilTestScreenGUI::executeCommand ( )

Definition at line 78 of file class.ilTestScreenGUI.php.

References ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ROOT_FOLDER_ID.

                                     : void
     {
         if ($this->access->checkAccess('read', '', $this->ref_id)) {
             $this->{$this->ctrl->getCmd(self::DEFAULT_CMD)}();
             return;
         }
 
         if (!$this->object->getMainSettings()->getAdditionalSettings()->getHideInfoTab()) {
             $this->ctrl->redirectByClass(ilObjTestGUI::class, 'infoScreen');
         }
 
         $this->tpl->setOnScreenMessage('failure', sprintf(
             $this->lng->txt('msg_no_perm_read_item'),
             $this->object->getTitle()
         ), true);
         $this->ctrl->setParameterByClass('ilrepositorygui', 'ref_id', ROOT_FOLDER_ID);
         $this->ctrl->redirectByClass('ilrepositorygui');
     }

Here is the call graph for this function:

◆ getLauncher()

ilTestScreenGUI::getLauncher ( )

private

Definition at line 196 of file class.ilTestScreenGUI.php.

References ilObjTestAccess\_lookupOnlineTestAccess(), blockUserAfterHavingPassed(), buildModalLauncher(), ilDatePresentation\formatDate(), getResumeLauncherLink(), getStartLauncherLink(), hasAvailablePasses(), IL_CAL_UNIX, isModalLauncherNeeded(), isUserOutOfProcessingTime(), lastPassSuspended(), ILIAS\Repository\lng(), ILIAS\Repository\object(), and ILIAS\Repository\user().

Referenced by 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)
             ;
         }
 
         if ($this->object->getFixedParticipants() && $this->object->getInvitedUsers($this->user->getId()) === []) {
             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 (ilObjTestAccess::_lookupOnlineTestAccess($this->object->getId(), $this->user->getId()) !== true) {
             return $launcher_factory
                 ->inline($this->data_factory->link('', $this->data_factory->uri($this->http->request()->getUri()->__toString())))
                 ->withButtonLabel($this->lng->txt('user_wrong_clientip'), 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()

ilTestScreenGUI::getModalLauncherInputs ( )

private

Definition at line 310 of file class.ilTestScreenGUI.php.

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

Referenced by 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 (ILIAS\Data\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()

ilTestScreenGUI::getModalLauncherLink ( )

private

Definition at line 304 of file class.ilTestScreenGUI.php.

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

Referenced by 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()

ilTestScreenGUI::getModalLauncherMessageBox ( )

private

Definition at line 359 of file class.ilTestScreenGUI.php.

References ILIAS\Repository\lng().

Referenced by 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()

ilTestScreenGUI::getResumeLauncherLink ( )

private

Definition at line 278 of file class.ilTestScreenGUI.php.

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

Referenced by 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()

ilTestScreenGUI::getSkillLevelThresholdsMissingInfo ( )

private

Definition at line 509 of file class.ilTestScreenGUI.php.

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

Referenced by testScreen().

                                                          : Component
     {
         $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()

ilTestScreenGUI::getStartLauncherLink ( )

private

Definition at line 375 of file class.ilTestScreenGUI.php.

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

Referenced by 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()

ilTestScreenGUI::handleRenderIntroduction ( array $elements )

private

Definition at line 172 of file class.ilTestScreenGUI.php.

References ILIAS\Repository\lng().

Referenced by 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($introduction),
             );
         }
 
         return $elements;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRenderLauncher()

ilTestScreenGUI::handleRenderLauncher ( array $elements )

private

Definition at line 190 of file class.ilTestScreenGUI.php.

References getLauncher().

Referenced by testScreen().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleRenderMessageBox()

ilTestScreenGUI::handleRenderMessageBox ( array $elements )

private

Definition at line 117 of file class.ilTestScreenGUI.php.

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

Referenced by 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()

ilTestScreenGUI::hasAvailablePasses ( )

private

Definition at line 486 of file class.ilTestScreenGUI.php.

Referenced by 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()

ilTestScreenGUI::isModalLauncherNeeded ( )

private

Definition at line 498 of file class.ilTestScreenGUI.php.

References ILIAS\Repository\user().

Referenced by 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()

ilTestScreenGUI::isUserOutOfProcessingTime ( )

private

Definition at line 459 of file class.ilTestScreenGUI.php.

References ILIAS\Repository\object().

Referenced by getLauncher(), and 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()

ilTestScreenGUI::lastPassSuspended ( )

private

Definition at line 493 of file class.ilTestScreenGUI.php.

Referenced by 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()

ilTestScreenGUI::testCanBeStarted ( )

private

Definition at line 449 of file class.ilTestScreenGUI.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()

ilTestScreenGUI::testScreen ( )

Definition at line 97 of file class.ilTestScreenGUI.php.

References $ref_id, areSkillLevelThresholdsMissing(), getSkillLevelThresholdsMissingInfo(), handleRenderIntroduction(), handleRenderLauncher(), handleRenderMessageBox(), ILIAS\Repository\object(), ilTestTabsManager\TAB_ID_TEST, and ILIAS\Repository\tabs().

                                 : void
     {
         $this->tabs->activateTab(ilTestTabsManager::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 ilTestScreenGUI::$data_factory

private

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

◆ $main_settings

readonly ilObjTestMainSettings ilTestScreenGUI::$main_settings

private

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

◆ $password_checker

ilTestPasswordChecker ilTestScreenGUI::$password_checker

private

Definition at line 48 of file class.ilTestScreenGUI.php.

◆ $ref_id

readonly int ilTestScreenGUI::$ref_id

private

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

Referenced by testScreen().

◆ $test_passes_selector

readonly ilTestPassesSelector ilTestScreenGUI::$test_passes_selector

private

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

◆ $test_session

readonly ilTestSession ilTestScreenGUI::$test_session

private

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

◆ DEFAULT_CMD

const ilTestScreenGUI::DEFAULT_CMD = 'testScreen'

Definition at line 41 of file class.ilTestScreenGUI.php.

Referenced by ilObjTestGUI\_goto(), ilObjTestGUI\addLocatorItems(), ilTestPlayerAbstractGUI\checkTestExecutable(), ilTestOutputGUI\handleCheckTestPassValid(), ilObjTestGUI\infoScreen(), ilTestPlayerAbstractGUI\redirectBackCmd(), ilObjTestGUI\setTitleAndDescription(), ilTestTabsManager\setupTabsGuiConfig(), and ilTestPlayerAbstractGUI\suspendTestCmd().

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

Modules/Test/classes/TestScreen/class.ilTestScreenGUI.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