ILIAS\Test\Participants\ParticipantTableExtraTimeAction Class Reference

Inheritance diagram for ILIAS\Test\Participants\ParticipantTableExtraTimeAction:

Collaboration diagram for ILIAS\Test\Participants\ParticipantTableExtraTimeAction:

Public Member Functions
	__construct (private readonly Language $lng, private readonly Refinery $refinery, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly ParticipantRepository $participant_repository, private readonly \ilObjUser $current_user, private readonly \ilTestAccess $test_access, private readonly \ilObjTest $test_obj)
	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)
	saveExtraTime (array $participants, int $minutes)
	getSelectionErrorMessage ()
	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 = 'extratime'

Private Member Functions
	resolveInfoMessage (array $selected_participants, bool $all_participants_selected, bool $has_different_extra_time)
	resolveHasDifferentExtraTime (array $participants)

Detailed Description

Definition at line 34 of file ParticipantTableExtraTimeAction.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::__construct	(	private readonly Language	$lng,
		private readonly Refinery	$refinery,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly ParticipantRepository	$participant_repository,
		private readonly \ilObjUser	$current_user,
		private readonly \ilTestAccess	$test_access,
		private readonly \ilObjTest	$test_obj
	)

Definition at line 38 of file ParticipantTableExtraTimeAction.php.

      {
    }

Member Function Documentation

allowActionForRecord()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::allowActionForRecord

(

Participant

$record

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 155 of file ParticipantTableExtraTimeAction.php.

                                                             : bool
    {
        return $record->getUserId() !== ANONYMOUS_USER_ID;
    }

References ANONYMOUS_USER_ID, and ILIAS\Test\Participants\Participant\getUserId().

Here is the call graph for this function:

getActionId()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::getActionId

(

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 50 of file ParticipantTableExtraTimeAction.php.

                                 : string
    {
        return self::ACTION_ID;
    }

References ILIAS\Test\Participants\ParticipantTableExtraTimeAction\ACTION_ID.

getModal()

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

Parameters

array<Participant>

$selected_participants

Implements ILIAS\Test\Participants\TableAction.

Definition at line 76 of file ParticipantTableExtraTimeAction.php.

     : ?Modal {
        $has_different_extra_time = $this->resolveHasDifferentExtraTime($selected_participants);
        $participant_rows = array_map(
            fn(Participant $participant) => sprintf(
                '%s, %s (%s)',
                $participant->getLastname(),
                $participant->getFirstname(),
                sprintf($this->lng->txt('already_added_extra_time'), $participant->getExtraTime())
            ),
            $selected_participants
        );
 
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('extratime'),
            [
                $this->ui_factory->messageBox()->info(
                    $this->lng->txt(
                        $this->resolveInfoMessage(
                            $selected_participants,
                            $all_participants_selected,
                            $has_different_extra_time
                        )
                    )
                ),
                $this->ui_factory->listing()->unordered($participant_rows)
            ],
            [
                'extra_time' => $this->ui_factory->input()->field()->numeric(
                    $this->lng->txt('extratime')
                )->withRequired(true)
                ->withAdditionalTransformation($this->refinery->int()->isGreaterThan(0))
                ->withValue(0)
                ->withByline(
                    $this->lng->txt('extra_time_byline')
                )
            ],
            $url_builder->buildURI()->__toString()
        )->withSubmitLabel($this->lng->txt('add'));
    }

getSelectionErrorMessage()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::getSelectionErrorMessage

(

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 217 of file ParticipantTableExtraTimeAction.php.

                                              : ?string
    {
        return null;
    }

getTableAction()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 61 of file ParticipantTableExtraTimeAction.php.

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

isAvailable()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::isAvailable

(

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 55 of file ParticipantTableExtraTimeAction.php.

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

onSubmit()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::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 120 of file ParticipantTableExtraTimeAction.php.

     : ?Modal {
        if (!$this->test_access->checkManageParticipantsAccess()) {
            $this->tpl->setOnScreenMessage(
                \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('no_permission'),
                true
            );
            return null;
        }
        $modal = $this->getModal(
            $url_builder,
            $selected_participants,
            $all_participants_selected
        )->withRequest($request);
 
        $data = $modal->getData();
        if ($data === null) {
            return $modal->withOnLoad($modal->getShowSignal());
        }
 
        $this->saveExtraTime($selected_participants, $data['extra_time']);
 
        $this->tpl->setOnScreenMessage(
            \ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('extratime_added'),
            true
        );
        return null;
    }

References ILIAS\Repository\lng(), and ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE.

Here is the call graph for this function:

resolveHasDifferentExtraTime()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::resolveHasDifferentExtraTime ( array  $participants )

private

Parameters

array<ilTestParticipant>

$participants

Definition at line 182 of file ParticipantTableExtraTimeAction.php.

                                                                      : bool
    {
        return count(array_unique(array_map(
            fn(Participant $participant) => $participant->getExtraTime(),
            $participants
        ))) > 1;
    }

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

Here is the call graph for this function:

resolveInfoMessage()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::resolveInfoMessage ( array  $selected_participants, bool  $all_participants_selected, bool  $has_different_extra_time  )

private

Definition at line 160 of file ParticipantTableExtraTimeAction.php.

     : string {
        if ($all_participants_selected) {
            return 'extra_time_for_all_participants';
        }
 
        if (count($selected_participants) === 1) {
            return 'extra_time_for_single_participant';
        }
        if ($has_different_extra_time) {
            return 'extra_time_for_selected_participants_different';
        }
 
        return 'extra_time_for_selected_participants';
    }

saveExtraTime()

ILIAS\Test\Participants\ParticipantTableExtraTimeAction::saveExtraTime	(	array	$participants,
		int	$minutes
	)

Parameters

array<Participant>

$participants

Definition at line 193 of file ParticipantTableExtraTimeAction.php.

                                                                    : void
    {
        foreach ($participants as $participant) {
            $this->participant_repository->updateExtraTime($participant->withAddedExtraTime($minutes));
        }
 
        if ($this->test_obj->getTestLogger()->isLoggingEnabled()) {
            $this->test_obj->getTestLogger()->logTestAdministrationInteraction(
                $this->test_obj->getTestLogger()->getInteractionFactory()->buildTestAdministrationInteraction(
                    $this->test_obj->getRefId(),
                    $this->current_user->getId(),
                    TestAdministrationInteractionTypes::EXTRA_TIME_ADDED,
                    [
                        AdditionalInformationGenerator::KEY_USERS => array_map(
                            fn(Participant $participant) => $participant->getUserId(),
                            $participants
                        ),
                        AdditionalInformationGenerator::KEY_TEST_ADDED_PROCESSING_TIME => $minutes
                    ]
                )
            );
        }
    }

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

Here is the call graph for this function:

Field Documentation

ACTION_ID

const ILIAS\Test\Participants\ParticipantTableExtraTimeAction::ACTION_ID = 'extratime'

Definition at line 36 of file ParticipantTableExtraTimeAction.php.

Referenced by ILIAS\Test\Participants\ParticipantTableExtraTimeAction\getActionId().

---

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

• components/ILIAS/Test/src/Participants/ParticipantTableExtraTimeAction.php