ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction Class Reference

Inheritance diagram for ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction:

Collaboration diagram for ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly ParticipantRepository $participant_repository, 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)
	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 = 'delete_pax'

Detailed Description

Definition at line 31 of file ParticipantTableDeleteParticipantAction.php.

Constructor & Destructor Documentation

__construct()

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

Definition at line 35 of file ParticipantTableDeleteParticipantAction.php.

      {
    }

Member Function Documentation

allowActionForRecord()

ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction::allowActionForRecord

(

Participant

$record

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 117 of file ParticipantTableDeleteParticipantAction.php.

                                                             : bool
    {
        return $record->getActiveId() === null;
    }

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

Here is the call graph for this function:

getActionId()

ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction::getActionId

(

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 45 of file ParticipantTableDeleteParticipantAction.php.

                                 : string
    {
        return self::ACTION_ID;
    }

References ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction\ACTION_ID.

getModal()

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

Parameters

array<Participant>

$selected_participants

Implements ILIAS\Test\Participants\TableAction.

Definition at line 70 of file ParticipantTableDeleteParticipantAction.php.

     : ?Modal {
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('confirm'),
            $this->lng->txt('remove_selected_participants_confirmation'),
            $url_builder->buildURI()->__toString()
        )->withAffectedItems(
            array_map(
                fn(Participant $v) => $this->ui_factory->modal()->interruptiveItem()->standard(
                    (string) $v->getUserId(),
                    $this->test_obj->getAnonymity()
                        ? $this->lng->txt('anonymous')
                        : \ilObjUser::_lookupFullname($v->getUserId())
                ),
                $selected_participants
            )
        )->withActionButtonLabel($this->lng->txt('remove'));
    }

getSelectionErrorMessage()

ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction::getSelectionErrorMessage

(

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 122 of file ParticipantTableDeleteParticipantAction.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

getTableAction()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 55 of file ParticipantTableDeleteParticipantAction.php.

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

isAvailable()

ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction::isAvailable

(

)

Implements ILIAS\Test\Participants\TableAction.

Definition at line 50 of file ParticipantTableDeleteParticipantAction.php.

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

onSubmit()

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

     : ?Modal {
        if (!$this->test_access->checkManageParticipantsAccess()) {
            $this->tpl->setOnScreenMessage(
                \ilGlobalTemplateInterface::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('no_permission'),
                true
            );
            return null;
        }
 
        $this->participant_repository->removeParticipants($selected_participants);
 
        $this->tpl->setOnScreenMessage(
            \ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
            $this->lng->txt('tst_selected_user_data_deleted'),
            true
        );
        return null;
    }

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

Here is the call graph for this function:

Field Documentation

ACTION_ID

const ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction::ACTION_ID = 'delete_pax'

Definition at line 33 of file ParticipantTableDeleteParticipantAction.php.

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

---

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

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