Inheritance diagram for ILIAS\Test\Participants\ParticipantTableIpRangeAction:

Collaboration diagram for ILIAS\Test\Participants\ParticipantTableIpRangeAction:

Public Member Functions
	__construct (private readonly Language $lng, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly Refinery $refinery, private readonly ParticipantRepository $participant_repository, private readonly \ilTestAccess $test_access,)

	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 = 'client_ip_range'

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

	isUniqueClientIp (array $selected_participants)

	checkIpRangeValidity (string $start, string $end)

Detailed Description

Definition at line 32 of file ParticipantTableIpRangeAction.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 36 of file ParticipantTableIpRangeAction.php.

43 {

44 }

Member Function Documentation

◆ allowActionForRecord()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 198 of file ParticipantTableIpRangeAction.php.

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

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

Here is the call graph for this function:

◆ checkIpRangeValidity()

ILIAS\Test\Participants\ParticipantTableIpRangeAction::checkIpRangeValidity	(	string	$start,
		string	$end
	)

private

Definition at line 230 of file ParticipantTableIpRangeAction.php.

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

                                                                      : bool
     {
         if (filter_var($start, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false
             && filter_var($end, FILTER_VALIDATE_IP, FILTER_FLAG_IPV4) !== false) {
             return ip2long($start) <= ip2long($end);
         }
 
         if (filter_var($start, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false
             && filter_var($end, FILTER_VALIDATE_IP, FILTER_FLAG_IPV6) !== false) {
             return bin2hex(inet_pton($start)) <= bin2hex(inet_pton($end));
         }
         return false;
     }

Here is the caller graph for this function:

◆ getActionId()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 46 of file ParticipantTableIpRangeAction.php.

                                  : string
     {
         return self::ACTION_ID;
     }

◆ getModal()

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

Parameters

array<Participant> $selected_participants

Implements ILIAS\Test\Participants\TableAction.

Definition at line 71 of file ParticipantTableIpRangeAction.php.

References ILIAS\UI\URLBuilder\buildURI(), ILIAS\Test\Participants\ParticipantTableIpRangeAction\checkIpRangeValidity(), ILIAS\Test\Participants\Participant\getFirstname(), ILIAS\Test\Participants\Participant\getLastname(), ILIAS\Test\Participants\ParticipantTableIpRangeAction\isUniqueClientIp(), ILIAS\Repository\lng(), null, ILIAS\Repository\refinery(), ILIAS\UI\Implementation\Component\Input\ViewControl\withAdditionalTransformation(), and ILIAS\UI\Implementation\Component\Input\withValue().

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

      : ?Modal {
         $valid_ip_constraint = $this->refinery->custom()->constraint(
             fn(?string $ip): bool => $ip === null
                 || $ip === ''
                 || filter_var($ip, FILTER_VALIDATE_IP) !== false,
             $this->lng->txt('invalid_ip')
         );
         $validate_order = $this->refinery->custom()->constraint(
             function (?array $vs): bool {
                 if ($vs['from'] === '' && $vs['to'] === '') {
                     return true;
                 }
                 return $this->checkIpRangeValidity(
                     $vs['from'],
                     $vs['to']
                 );
             },
             sprintf($this->lng->txt('not_greater_than'), $this->lng->txt('max_ip_label'), $this->lng->txt('min_ip_label'))
         );
         $ip_range_group_trafo = $this->refinery->custom()->transformation(
             static function (?array $vs): array {
                 if ($vs === null) {
                     $vs = [
                         'from' => null,
                         'to' => null
                     ];
                 }
                 return $vs;
             }
         );
 
 
         $participant_rows = array_map(
             fn(Participant $participant) => sprintf(
                 '%s, %s',
                 $participant->getLastname(),
                 $participant->getFirstname()
             ),
             $selected_participants
         );
 
         return $this->ui_factory->modal()->roundtrip(
             $this->lng->txt('client_ip_range'),
             [
                 $this->ui_factory->messageBox()->info(
                     $this->lng->txt(
                         $this->resolveInfoMessage(
                             $selected_participants,
                             $all_participants_selected
                         )
                     )
                 ),
                 $this->ui_factory->listing()->unordered($participant_rows)
             ],
             [
                 'ip_range' => $this->ui_factory->input()->field()->group([
                     'from' => $this->ui_factory->input()->field()->text(
                         $this->lng->txt('min_ip_label')
                     )->withAdditionalTransformation($valid_ip_constraint),
                     'to' => $this->ui_factory->input()->field()->text(
                         $this->lng->txt('max_ip_label'),
                         $this->lng->txt('ip_range_byline')
                     )->withAdditionalTransformation($valid_ip_constraint),
                 ])->withValue(
                     $this->isUniqueClientIp($selected_participants)
                         ? [
                             'from' => $selected_participants[0]->getClientIpFrom() ?? '',
                             'to' => $selected_participants[0]->getClientIpTo() ?? ''
                         ]
                         : [
                             'from' => '',
                             'to' => ''
                         ]
                 )
                     ->withAdditionalTransformation($ip_range_group_trafo)
                     ->withAdditionalTransformation($validate_order)
             ],
             $url_builder->buildURI()->__toString()
         )->withSubmitLabel($this->lng->txt('change'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectionErrorMessage()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 244 of file ParticipantTableIpRangeAction.php.

References null.

                                               : ?string
     {
         return null;
     }

◆ getTableAction()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 56 of file ParticipantTableIpRangeAction.php.

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

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

Here is the call graph for this function:

◆ isAvailable()

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

Implements ILIAS\Test\Participants\TableAction.

Definition at line 51 of file ParticipantTableIpRangeAction.php.

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

◆ isUniqueClientIp()

ILIAS\Test\Participants\ParticipantTableIpRangeAction::isUniqueClientIp ( array $selected_participants )

private

Definition at line 221 of file ParticipantTableIpRangeAction.php.

References ILIAS\Test\Participants\Participant\getClientIpFrom(), and ILIAS\Test\Participants\Participant\getClientIpTo().

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

                                                                    : bool
     {
         return count($selected_participants) === 1
             || count(array_unique(array_map(
                 fn(Participant $participant) => $participant->getClientIpFrom() . '-' . $participant->getClientIpTo(),
                 $selected_participants
             ))) === 1;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onSubmit()

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

References $data, ILIAS\Test\Participants\ParticipantTableIpRangeAction\getModal(), ILIAS\Repository\lng(), ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_FAILURE, ILIAS\UICore\GlobalTemplate\MESSAGE_TYPE_SUCCESS, null, and ILIAS\Test\Participants\Participant\withClientIpFrom().

      : ?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->participant_repository->updateIpRange(
             array_map(
                 static fn(Participant $v) => $v->withClientIpFrom($data['ip_range']['from'])
                     ->withClientIpTo($data['ip_range']['to']),
                 $selected_participants
             )
         );
 
         $this->tpl->setOnScreenMessage(
             \ilGlobalTemplateInterface::MESSAGE_TYPE_SUCCESS,
             $this->lng->txt('ip_range_updated'),
             true
         );
         return null;
     }

Here is the call graph for this function:

◆ resolveInfoMessage()

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

private

Parameters

array $selected_participants

Definition at line 206 of file ParticipantTableIpRangeAction.php.

      : string {
         if ($all_participants_selected) {
             return 'ip_range_for_all_participants';
         }
 
         if (count($selected_participants) === 1) {
             return 'ip_range_for_single_participant';
         }
 
         return 'ip_range_for_selected_participants';
     }

Field Documentation

◆ ACTION_ID

const ILIAS\Test\Participants\ParticipantTableIpRangeAction::ACTION_ID = 'client_ip_range'

Definition at line 34 of file ParticipantTableIpRangeAction.php.

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

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

Public Member Functions

Data Fields

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ allowActionForRecord()

◆ checkIpRangeValidity()

◆ getActionId()

◆ getModal()

◆ getSelectionErrorMessage()

◆ getTableAction()

◆ isAvailable()

◆ isUniqueClientIp()

◆ onSubmit()

◆ resolveInfoMessage()

Field Documentation

◆ ACTION_ID