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
	addOfflineMessageBoxIfNecessary (array $elements)

	handleRenderMessageBox (array $elements)

	handleRenderIntroduction (array $elements)

	handleRenderLauncher (array $elements)

	getLauncher ()

	getResumeLauncherLink ()

	buildModalLauncher ()

	getModalLauncherLink ()

	getModalLauncherInputs ()

	getModalLauncherMessageBox ()

	getStartLauncherLink ()

	buildLauncherLinkUrl (string $cmd)

	evaluateLauncherModalForm (Result $result)

	checkPassword (Result $result)

	testCanBeStarted ()

	isUserOutOfProcessingTime ()

	blockUserAfterHavingPassed ()

	hasAvailablePasses ()

	lastPassSuspended ()

	isModalLauncherNeeded ()

	getSkillLevelThresholdsMissingInfo ()

	areSkillLevelThresholdsMissing ()

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 44 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 55 of file class.TestScreenGUI.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addOfflineMessageBoxIfNecessary()

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

private

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

                                                                     : array
    {
        if (!$this->object->getOfflineStatus()) {
            return $elements;
        }
 
        $offline_message_box = $this->ui_factory->messageBox()->info($this->lng->txt('test_is_offline'));
 
        if (!$this->access->checkAccess('write', '', $this->object->getRefId())) {
            $elements[] = $offline_message_box;
            return $elements;
        }
 
        $elements[] = $offline_message_box->withLinks([
            $this->ui_factory->link()->standard(
                $this->lng->txt('test_edit_settings'),
                $this->ctrl->getLinkTargetByClass(SettingsMainGUI::class)
            )
        ]);
        return $elements;
    }

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

Here is the call graph for this function:

◆ areSkillLevelThresholdsMissing()

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

private

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

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

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

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

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 553 of file class.TestScreenGUI.php.

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

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

Here is the caller graph for this function:

◆ buildLauncherLinkUrl()

ILIAS\Test\Presentation\TestScreenGUI::buildLauncherLinkUrl ( string $cmd )

private

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

     : \ILIAS\Data\URI {
        return $this->data_factory->uri(
            ILIAS_HTTP_PATH . '/' . $this->ctrl->getLinkTargetByClass(
                [
                    \ilRepositoryGUI::class,
                    \ilObjTestGUI::class,
                    $this->object->isFixedTest()
                        ? \ilTestPlayerFixedQuestionSetGUI::class
                        : \ilTestPlayerRandomQuestionSetGUI::class
                ],
                $cmd
            )
        );
    }

◆ buildModalLauncher()

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

private

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

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

References $request, ILIAS\Test\Presentation\TestScreenGUI\evaluateLauncherModalForm(), ILIAS\Test\Presentation\TestScreenGUI\getModalLauncherLink(), ILIAS\Test\Presentation\TestScreenGUI\getModalLauncherMessageBox(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), and ILIAS\UI\Component\Launcher\Launcher\withInputs().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkPassword()

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

private

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

     : void {
        $password = $result->value()['exam_password']?->toString();
        if ($password === $this->main_settings->getAccessSettings()->getPassword()) {
            \ilSession::set('tst_password_' . $this->object->getTestId(), $password);
            return;
        }
 
        \ilSession::set('tst_password_' . $this->object->getTestId(), '');
        $this->test_session->setPasswordChecked(false);
    }

References ILIAS\Repository\object(), and ilSession\set().

Here is the call graph for this function:

◆ evaluateLauncherModalForm()

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

private

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

                                                              : void
    {
        if ($result->isError()) {
            return;
        }
 
        $anonymous = $this->user->isAnonymous();
        if (array_key_exists('exam_access_code', $result->value())) {
            $value = $result->value()['exam_access_code'];
            if ($anonymous && !empty($value)) {
                $this->test_session->setAccessCodeToSession($value);
            } else {
                $this->test_session->unsetAccessCodeInSession();
            }
        }
 
        if (
            !$anonymous &&
            $this->main_settings->getParticipantFunctionalitySettings()->getUsePreviousAnswerAllowed()
        ) {
            $this->user->setPref(
                'tst_use_previous_answers',
                $result->value()['exam_use_previous_answers'] ?? '0'
            );
            $this->user->update();
        }
 
        if ($this->main_settings->getAccessSettings()->getPasswordEnabled()) {
            $this->checkPassword($result);
        }
 
        $this->ctrl->redirectByClass(
            (new \ilTestPlayerFactory($this->object))->getPlayerGUI()::class,
            \ilTestPlayerCommands::INIT_TEST
        );
    }

References ILIAS\Repository\ctrl(), ilTestPlayerCommands\INIT_TEST, ILIAS\Data\Result\isError(), ILIAS\Repository\user(), and ILIAS\Data\Result\value().

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

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 84 of file class.TestScreenGUI.php.

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

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

Here is the call graph for this function:

◆ getLauncher()

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

private

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

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

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

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 370 of file class.TestScreenGUI.php.

                                             : 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)
            ->withAdditionalTransformation(
                $this->refinery->custom()->constraint(
                    static fn(bool $value): bool => $value,
                    $this->lng->txt('tst_exam_conditions_not_checked_message'),
                )
            );
        }
 
        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()->constraint(
                    fn(Password $value): bool => $value->toString() === $this->main_settings->getAccessSettings()->getPassword(),
                    $this->lng->txt('tst_exam_password_invalid_message'),
                )
            );
        }
 
        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')
            )->withAdditionalTransformation(
                $this->refinery->custom()->constraint(
                    fn(string $value): bool => $value === '' || $this->test_session->isAccessCodeUsed($value),
                    $this->lng->txt('tst_exam_access_code_invalid_message'),
                )
            );
 
            $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->test_passes_selector->getLastFinishedPass() >= 0
            && $this->main_settings->getParticipantFunctionalitySettings()->getUsePreviousAnswerAllowed()
        ) {
            $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')
            )->withAdditionalTransformation(
                $this->refinery->custom()->transformation(
                    static fn(bool $value): string => $value ? '1' : '0'
                )
            );
        }
 
        return $modal_inputs ?? [];
    }

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

Here is the call graph for this function:

◆ getModalLauncherLink()

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

private

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

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

References ILIAS\Repository\lng().

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

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 435 of file class.TestScreenGUI.php.

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

References ILIAS\Repository\lng().

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

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 331 of file class.TestScreenGUI.php.

                                            : Link
    {
        return $this->data_factory->link(
            $this->lng->txt('tst_resume_test'),
            $this->buildLauncherLinkUrl(\ilTestPlayerCommands::RESUME_PLAYER)
        );
    }

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

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

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 586 of file class.TestScreenGUI.php.

                                                         : MessageBox
    {
        return $this->ui_factory->messageBox()->failure(
            $this->lng->txt('tst_skl_level_thresholds_missing')
        )->withLinks([
            $this->ui_factory->link()->standard(
                $this->lng->txt('tst_skl_level_thresholds_link'),
                $this->ctrl->getLinkTargetByClass(
                    [
                        \ilRepositoryGUI::class,
                        \ilObjTestGUI::class,
                        \ilTestSkillAdministrationGUI::class,
                        \ilTestSkillLevelThresholdsGUI::class
                    ],
                    \ilTestSkillLevelThresholdsGUI::CMD_SHOW_SKILL_THRESHOLDS
                )
            )
        ]);
    }

References ilTestSkillLevelThresholdsGUI\CMD_SHOW_SKILL_THRESHOLDS, ILIAS\Repository\lng(), and ILIAS\UI\Component\MessageBox\MessageBox\withLinks().

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

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 451 of file class.TestScreenGUI.php.

                                           : Link
    {
        return $this->data_factory->link(
            $this->lng->txt('tst_exam_start'),
            $this->buildLauncherLinkUrl(\ilTestPlayerCommands::INIT_TEST)
        );
    }

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

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

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 220 of file class.TestScreenGUI.php.

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

References ILIAS\Repository\lng().

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

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 238 of file class.TestScreenGUI.php.

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

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

Here is the call graph for this function:

◆ handleRenderMessageBox()

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

private

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

                                                            : 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()
            && $this->hasAvailablePasses()) {
            $active_id = $this->test_session->getActiveId();
            $starting_time = $this->object->getStartingTimeOfUser($active_id);
            $message_box_message_elements[] = (new WorkingTime(
                $this->lng,
                $starting_time === false ? null : $starting_time,
                $this->object->getProcessingTimeInSeconds($active_id)
            ))->getMessage(false);
        }
 
        $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;
    }

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

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

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 563 of file class.TestScreenGUI.php.

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

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

Here is the caller graph for this function:

◆ isModalLauncherNeeded()

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

private

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

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

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

Here is the caller graph for this function:

◆ isUserOutOfProcessingTime()

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

private

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

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

References ILIAS\Repository\object().

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

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 570 of file class.TestScreenGUI.php.

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

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

Here is the caller graph for this function:

◆ testCanBeStarted()

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

private

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

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

References ILIAS\Repository\object().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ testScreen()

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

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

                                : 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);
 
        if ($this->testCanBeStarted()) {
            $this->tpl->setContent(
                $this->ui_renderer->render(
                    $this->handleRenderLauncher(
                        $elements
                    )
                )
            );
            return;
        }
 
        $this->tpl->setContent(
            $this->ui_renderer->render(
                $this->addOfflineMessageBoxIfNecessary(
                    $elements
                )
            )
        );
    }

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

Here is the call graph for this function:

Field Documentation

◆ $data_factory

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

private

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

◆ $main_settings

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

private

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

◆ $password_checker

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

private

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

◆ $ref_id

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

private

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

◆ $test_passes_selector

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

private

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

◆ $test_session

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

private

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

◆ DEFAULT_CMD

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

Definition at line 46 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

◆ addOfflineMessageBoxIfNecessary()

◆ areSkillLevelThresholdsMissing()

◆ blockUserAfterHavingPassed()

◆ buildLauncherLinkUrl()

◆ buildModalLauncher()

◆ checkPassword()

◆ 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