Inheritance diagram for ILIAS\Test\Participants\ParticipantTableFinishTestAction:

Collaboration diagram for ILIAS\Test\Participants\ParticipantTableFinishTestAction:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly \ilDBInterface $db, private readonly \ilTestProcessLockerFactory $process_locker_factory, private readonly \ilObjUser $user, private readonly \ilTestAccess $test_access, private readonly \ilObjTest $test_obj, private readonly TestResultRepository $test_pass_result_repository)

	getActionId ()

	isAvailable ()

	getTableAction (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token)

	getModal (URLBuilder $url_builder, array $selected_participants, bool $all_participants_selected)

	onSubmit (URLBuilder $url_builder, ServerRequestInterface $request, array $selected_participants, bool $all_participants_selected)

	allowActionForRecord (Participant $record)

	getSelectionErrorMessage ()

Data Fields
const	ACTION_ID = 'finish_test'

Private Member Functions
	resolveMessage (array $selected_participants, bool $all_participants_selected)

	haveAllSelectedParticipantsReachedMaxProcessingTime (array $selected_participants)

Detailed Description

Definition at line 35 of file ParticipantTableFinishTestAction.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::__construct	(	private readonly Language	$lng,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly \ilDBInterface	$db,
		private readonly \ilTestProcessLockerFactory	$process_locker_factory,
		private readonly \ilObjUser	$user,
		private readonly \ilTestAccess	$test_access,
		private readonly \ilObjTest	$test_obj,
		private readonly TestResultRepository	$test_pass_result_repository
	)

Definition at line 39 of file ParticipantTableFinishTestAction.php.

49 {

50 }

Member Function Documentation

◆ allowActionForRecord()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::allowActionForRecord ( Participant $record )

Implements ILIAS\Test\Participants\TableAction.

Definition at line 172 of file ParticipantTableFinishTestAction.php.

References ILIAS\Test\Participants\Participant\hasUnfinishedAttempts().

                                                              : bool
     {
         return $record->hasUnfinishedAttempts();
     }

Here is the call graph for this function:

◆ getActionId()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::getActionId ( )

Implements ILIAS\Test\Participants\TableAction.

Definition at line 52 of file ParticipantTableFinishTestAction.php.

                                  : string
     {
         return self::ACTION_ID;
     }

◆ getModal()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::getModal	(	URLBuilder	$url_builder,
		array	$selected_participants,
		bool	$all_participants_selected
	)

Parameters

array<Participant> $selected_participants

Implements ILIAS\Test\Participants\TableAction.

Definition at line 77 of file ParticipantTableFinishTestAction.php.

References ILIAS\UI\URLBuilder\buildURI(), ILIAS\Test\Participants\Participant\getUserId(), ILIAS\Repository\lng(), and ILIAS\Test\Participants\ParticipantTableFinishTestAction\resolveMessage().

      : ?Modal {
         $modal = $this->ui_factory->modal()->interruptive(
             $this->lng->txt('finish_test'),
             $this->resolveMessage($selected_participants, $all_participants_selected),
             $url_builder->buildURI()->__toString()
         )->withActionButtonLabel($this->lng->txt('finish_test'));
 
         if (count($selected_participants) > 1) {
             $modal = $modal->withAffectedItems(
                 array_map(
                     fn(Participant $participant) => $this->ui_factory->modal()->interruptiveItem()->standard(
                         (string) $participant->getUserId(),
                         (new \ilObjUser($participant->getUserId()))->getPublicName()
                     ),
                     $selected_participants
                 )
             );
         }
 
         return $modal;
     }

Here is the call graph for this function:

◆ getSelectionErrorMessage()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::getSelectionErrorMessage ( )

Implements ILIAS\Test\Participants\TableAction.

Definition at line 195 of file ParticipantTableFinishTestAction.php.

References ILIAS\Repository\lng().

                                               : ?string
     {
         return $this->lng->txt('finish_test_no_valid_participants_selected');
     }

Here is the call graph for this function:

◆ getTableAction()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::getTableAction	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 62 of file ParticipantTableFinishTestAction.php.

References ILIAS\Repository\lng(), ILIAS\Test\Participants\ParticipantTableActions\SHOW_ACTION, and ILIAS\UI\URLBuilder\withParameter().

      : StandardAction {
         return $this->ui_factory->table()->action()->standard(
             $this->lng->txt(self::ACTION_ID),
             $url_builder
                 ->withParameter($action_token, self::ACTION_ID)
                 ->withParameter($action_type_token, ParticipantTableActions::SHOW_ACTION),
             $row_id_token
         )->withAsync();
     }

Here is the call graph for this function:

◆ haveAllSelectedParticipantsReachedMaxProcessingTime()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::haveAllSelectedParticipantsReachedMaxProcessingTime ( array $selected_participants )

private

Definition at line 200 of file ParticipantTableFinishTestAction.php.

Referenced by ILIAS\Test\Participants\ParticipantTableFinishTestAction\onSubmit().

                                                                                                       : bool
     {
         foreach ($selected_participants as $participant) {
             if (!$participant->hasUnfinishedAttempts()
                 || !$this->test_obj->isMaxProcessingTimeReached(
                     $this->test_obj->getStartingTimeOfUser($participant->getActiveId()),
                     $participant->getActiveId()
                 )) {
                 return false;
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ isAvailable()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::isAvailable ( )

Implements ILIAS\Test\Participants\TableAction.

Definition at line 57 of file ParticipantTableFinishTestAction.php.

                                  : bool
     {
         return $this->test_access->checkManageParticipantsAccess();
     }

◆ onSubmit()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::onSubmit	(	URLBuilder	$url_builder,
		ServerRequestInterface	$request,
		array	$selected_participants,
		bool	$all_participants_selected
	)

Parameters

array<Participant> $selected_participants

Implements ILIAS\Test\Participants\TableAction.

Definition at line 103 of file ParticipantTableFinishTestAction.php.

References ILIAS\Test\Participants\Participant\getUserId(), ILIAS\Test\Participants\ParticipantTableFinishTestAction\haveAllSelectedParticipantsReachedMaxProcessingTime(), ILIAS\Test\Logging\AdditionalInformationGenerator\KEY_USERS, ILIAS\Repository\lng(), ilGlobalTemplateInterface\MESSAGE_TYPE_FAILURE, ilGlobalTemplateInterface\MESSAGE_TYPE_SUCCESS, and ILIAS\Repository\user().

      : ?Modal {
         if (!$this->test_access->checkManageParticipantsAccess()) {
             $this->tpl->setOnScreenMessage(
                 \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                 $this->lng->txt('no_permission'),
                 true
             );
             return null;
         }
 
         if (count($selected_participants) > 1
             && $this->test_obj->getNrOfTries() === 1
             && $this->test_obj->getEnableProcessingTime()
             && !$this->test_obj->getResetProcessingTime()
             && !$this->haveAllSelectedParticipantsReachedMaxProcessingTime($selected_participants)) {
             $this->tpl->setOnScreenMessage(
                 \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                 $this->lng->txt('finish_pass_for_multiple_users_in_processing_time'),
                 true
             );
             return null;
         }
 
         // This is required here because of late test object binding
         $test_session_factory = new \ilTestSessionFactory(
             $this->test_obj,
             $this->db,
             $this->user
         );
 
         foreach ($selected_participants as $participant) {
             $process_locker = $this->process_locker_factory->withContextId($participant->getActiveId())->getLocker();
             (new \ilTestPassFinishTasks(
                 $test_session_factory->getSession($participant->getActiveId()),
                 $this->test_obj,
                 $this->test_pass_result_repository
             ))->performFinishTasks($process_locker, StatusOfAttempt::FINISHED_BY_ADMINISTRATOR);
         }
 
         $logger = $this->test_obj->getTestLogger();
         if ($logger->isLoggingEnabled()) {
             $logger->logTestAdministrationInteraction(
                 $logger->getInteractionFactory()->buildTestAdministrationInteraction(
                     $this->test_obj->getRefId(),
                     $this->user->getId(),
                     TestAdministrationInteractionTypes::TEST_RUN_OF_PARTICIPANT_CLOSED,
                     [
                         AdditionalInformationGenerator::KEY_USERS => array_map(
                             fn(Participant $participant) => $participant->getUserId(),
                             $selected_participants
                         )
                     ]
                 )
             );
         }
 
         $this->tpl->setOnScreenMessage(
             \ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
             $this->lng->txt('test_attempts_finished'),
             true
         );
         return null;
     }

Here is the call graph for this function:

◆ resolveMessage()

ILIAS\Test\Participants\ParticipantTableFinishTestAction::resolveMessage	(	array	$selected_participants,
		bool	$all_participants_selected
	)

private

Definition at line 177 of file ParticipantTableFinishTestAction.php.

References ILIAS\Repository\lng().

Referenced by ILIAS\Test\Participants\ParticipantTableFinishTestAction\getModal().

      : string {
         if ($all_participants_selected) {
             return $this->lng->txt('finish_test_all');
         }
 
         if (count($selected_participants) === 1) {
             return sprintf(
                 $this->lng->txt('finish_test_single'),
                 (new \ilObjUser($selected_participants[0]->getUserId()))->getPublicName()
             );
         }
 
         return $this->lng->txt('finish_test_multiple');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ ACTION_ID

const ILIAS\Test\Participants\ParticipantTableFinishTestAction::ACTION_ID = 'finish_test'

Definition at line 37 of file ParticipantTableFinishTestAction.php.

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

components/ILIAS/Test/src/Participants/ParticipantTableFinishTestAction.php

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowActionForRecord()

◆ getActionId()

◆ getModal()

◆ getSelectionErrorMessage()

◆ getTableAction()

◆ haveAllSelectedParticipantsReachedMaxProcessingTime()

◆ isAvailable()

◆ onSubmit()

◆ resolveMessage()

Field Documentation

◆ ACTION_ID