Collaboration diagram for ILIAS\Test\Participants\ParticipantTableActions:

Public Member Functions
	__construct (protected readonly \ilCtrlInterface $ctrl, protected readonly Language $lng, protected readonly \ilGlobalTemplateInterface $tpl, protected readonly UIFactory $ui_factory, protected readonly UIRenderer $ui_renderer, protected readonly Refinery $refinery, protected readonly RequestDataCollector $test_request, protected readonly ResponseHandler $test_response, protected readonly ParticipantRepository $repository, protected readonly \ilObjTest $test_obj, protected readonly array $actions)

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

	getAction (string $action_id)

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

	onDataRow (DataRow $row, mixed $record)

Data Fields
const	ROW_ID_PARAMETER = 'p_id'

const	ACTION_PARAMETER = 'action'

const	ACTION_TYPE_PARAMETER = 'action_type'

const	SHOW_ACTION = 'showTableAction'

const	SUBMIT_ACTION = 'submitTableAction'

Protected Member Functions
	showModal (URLBuilder $url_builder, URLBuilderToken $row_id_token, URLBuilderToken $action_token, URLBuilderToken $action_type_token)

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

	resolveSelectedParticipants (TableAction $action, array\|string $selected_participants)

Detailed Description

Definition at line 35 of file ParticipantTableActions.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Participants\ParticipantTableActions::__construct	(	protected readonly \ilCtrlInterface	$ctrl,
		protected readonly Language	$lng,
		protected readonly \ilGlobalTemplateInterface	$tpl,
		protected readonly UIFactory	$ui_factory,
		protected readonly UIRenderer	$ui_renderer,
		protected readonly Refinery	$refinery,
		protected readonly RequestDataCollector	$test_request,
		protected readonly ResponseHandler	$test_response,
		protected readonly ParticipantRepository	$repository,
		protected readonly \ilObjTest	$test_obj,
		protected readonly array	$actions
	)

Parameters

array<string,TableAction> $actions

Definition at line 45 of file ParticipantTableActions.php.

57 {

58 }

Member Function Documentation

◆ execute()

ILIAS\Test\Participants\ParticipantTableActions::execute	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

Definition at line 95 of file ParticipantTableActions.php.

     : ?Modal {
        return match($this->test_request->strVal($action_type_token->getName())) {
            self::SUBMIT_ACTION => $this->submit(
                $url_builder,
                $row_id_token,
                $action_token,
                $action_type_token
            ),
            default => $this->showModal(
                $url_builder,
                $row_id_token,
                $action_token,
                $action_type_token
            ),
        };
    }

◆ getAction()

ILIAS\Test\Participants\ParticipantTableActions::getAction ( string $action_id )

Definition at line 90 of file ParticipantTableActions.php.

                                                : ?TableAction
    {
        return $this->actions[$action_id] ?? null;
    }

◆ getEnabledActions()

ILIAS\Test\Participants\ParticipantTableActions::getEnabledActions	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

Definition at line 60 of file ParticipantTableActions.php.

     : array {
        return array_filter(
            array_map(
                function (TableAction $action) use (
                    $url_builder,
                    $row_id_token,
                    $action_token,
                    $action_type_token
                ): ?Action {
                    if (!$action->isAvailable()) {
                        return null;
                    }
 
                    return $action->getTableAction(
                        $url_builder,
                        $row_id_token,
                        $action_token,
                        $action_type_token
                    );
                },
                $this->actions
            )
        );
    }

◆ onDataRow()

ILIAS\Test\Participants\ParticipantTableActions::onDataRow	(	DataRow	$row,
		mixed	$record
	)

Definition at line 117 of file ParticipantTableActions.php.

                                                          : DataRow
    {
        return array_reduce(
            array_keys($this->actions),
            fn(DataRow $c, string $v): DataRow => $this->actions[$v]->allowActionForRecord($record)
                ? $c
                : $c->withDisabledAction($v),
            $row
        );
    }

References $c.

◆ resolveSelectedParticipants()

ILIAS\Test\Participants\ParticipantTableActions::resolveSelectedParticipants	(	TableAction	$action,
		array\|string	$selected_participants
	)

protected

Definition at line 200 of file ParticipantTableActions.php.

                                                                                                            : array
    {
        if ($selected_participants === 'ALL_OBJECTS') {
            return array_filter(
                iterator_to_array($this->repository->getParticipants($this->test_obj->getTestId())),
                fn(Participant $participant) => $action->allowActionForRecord($participant)
            );
        }
 
        return array_filter(
            array_map(
                fn(int $user_id) => $this->repository->getParticipantByUserId($this->test_obj->getTestId(), $user_id),
                $selected_participants
            ),
            fn(Participant $participant) => $action->allowActionForRecord($participant)
        );
    }

References $user_id, ILIAS\Test\Participants\TableAction\allowActionForRecord(), and ILIAS\UI\examples\Deck\repository().

Here is the call graph for this function:

◆ showModal()

ILIAS\Test\Participants\ParticipantTableActions::showModal	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

protected

Definition at line 128 of file ParticipantTableActions.php.

     : void {
        $action = $this->actions[$this->test_request->strVal($action_token->getName())];
        $selected_participants_from_request = $this->test_request
            ->getMultiSelectionIds($row_id_token->getName());
        $selected_participants = $this->resolveSelectedParticipants(
            $action,
            $selected_participants_from_request
        );
 
        if ($selected_participants === []) {
            $error_message = $action->getSelectionErrorMessage() ?? $this->lng->txt('no_valid_participant_selection');
            $this->test_response->sendAsync(
                $this->ui_renderer->renderAsync(
                    $this->ui_factory->messageBox()->failure(
                        $error_message
                    )
                )
            );
        }
 
        $this->test_response->sendAsync(
            $this->ui_renderer->renderAsync(
                $action->getModal(
                    $url_builder
                        ->withParameter($row_id_token, $selected_participants_from_request)
                        ->withParameter($action_token, $action->getActionId())
                        ->withParameter($action_type_token, self::SUBMIT_ACTION),
                    $selected_participants,
                    $selected_participants_from_request === 'ALL_OBJECTS'
                )
            )
        );
    }

◆ submit()

ILIAS\Test\Participants\ParticipantTableActions::submit	(	URLBuilder	$url_builder,
		URLBuilderToken	$row_id_token,
		URLBuilderToken	$action_token,
		URLBuilderToken	$action_type_token
	)

protected

Definition at line 167 of file ParticipantTableActions.php.

     : ?Modal {
        $action = $this->actions[$this->test_request->strVal($action_token->getName())];
        $selected_participants_from_request = $this->test_request
            ->getMultiSelectionIds($row_id_token->getName());
        $selected_participants = $this->resolveSelectedParticipants(
            $action,
            $selected_participants_from_request
        );
 
        if ($selected_participants === []) {
            $this->tpl->setOnScreenMessage(
                \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('no_valid_participant_selection'),
                true
            );
        }
 
        return $action->onSubmit(
            $url_builder
                ->withParameter($row_id_token, $selected_participants_from_request)
                ->withParameter($action_token, $action->getActionId())
                ->withParameter($action_type_token, self::SUBMIT_ACTION),
            $this->test_request->getRequest(),
            $selected_participants,
            $selected_participants_from_request === 'ALL_OBJECTS'
        );
    }