Collaboration diagram for ilTestParticipantsGUI:

Public Member Functions
	__construct (protected ilObjTest $test_obj, protected readonly ilObjUser $current_user, protected readonly ilTestObjectiveOrientedContainer $objective_parent, protected readonly ilTestQuestionSetConfig $question_set_config, protected ilAccess $access, protected ilTestAccess $test_access, protected ilGlobalTemplateInterface $main_tpl, protected UIFactory $ui_factory, protected UIRenderer $ui_renderer, protected ilUIService $ui_service, protected DataFactory $data_factory, protected ilLanguage $lng, protected ilCtrlInterface $ctrl, protected Refinery $refinery, protected ilDBInterface $db, protected TabsManager $tabs_manager, protected ilToolbarGUI $toolbar, protected ilComponentFactory $component_factory, protected ExportImportFactory $export_factory, protected RequestDataCollector $testrequest, protected ResponseHandler $response_handler, protected ParticipantRepository $participant_repository, protected readonly ResultsDataFactory $results_data_factory, protected readonly ResultsPresentationFactory $results_presentation_factory, protected readonly TestResultRepository $test_pass_result_repository)

	executeCommand ()

	addParticipants ($user_ids=[])

	showCmd (?Modal $modal=null)

	executeTableActionCmd ()

	exportResultsCmd ()

Data Fields
const	CMD_SHOW = 'show'

const	CALLBACK_ADD_PARTICIPANT = 'addParticipants'

Protected Member Functions
	addUserSearchControls (ilToolbarGUI $toolbar)

Protected Attributes
ilTestParticipantAccessFilterFactory	$participant_access_filter

Private Member Functions
	getParticipantTable ()

	getTableActionUrlBuilder ()

	addExportDropdown (ilToolbarGUI $toolbar)

	buildOptionsForTestWithNames ()

	addCertificateExportToOptions (array $options)

	addPluginExportsToOptions (array $options)

	buildParticipantTableActions ()

Private Attributes
const	EXPORT_TYPE_PARAMETER = 'export_type'

const	EXPORT_PLUGIN_TYPE_PARAMETER = 'export_plugin_type'

Detailed Description

Class ilTestParticipantsGUI.

Author: Björn Heyser info@.nosp@m.bjoe.nosp@m.rnhey.nosp@m.ser..nosp@m.de

ilTestParticipantsGUI: ilRepositorySearchGUI

Definition at line 52 of file class.ilTestParticipantsGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestParticipantsGUI::__construct	(	protected ilObjTest	$test_obj,
		protected readonly ilObjUser	$current_user,
		protected readonly ilTestObjectiveOrientedContainer	$objective_parent,
		protected readonly ilTestQuestionSetConfig	$question_set_config,
		protected ilAccess	$access,
		protected ilTestAccess	$test_access,
		protected ilGlobalTemplateInterface	$main_tpl,
		protected UIFactory	$ui_factory,
		protected UIRenderer	$ui_renderer,
		protected ilUIService	$ui_service,
		protected DataFactory	$data_factory,
		protected ilLanguage	$lng,
		protected ilCtrlInterface	$ctrl,
		protected Refinery	$refinery,
		protected ilDBInterface	$db,
		protected TabsManager	$tabs_manager,
		protected ilToolbarGUI	$toolbar,
		protected ilComponentFactory	$component_factory,
		protected ExportImportFactory	$export_factory,
		protected RequestDataCollector	$testrequest,
		protected ResponseHandler	$response_handler,
		protected ParticipantRepository	$participant_repository,
		protected readonly ResultsDataFactory	$results_data_factory,
		protected readonly ResultsPresentationFactory	$results_presentation_factory,
		protected readonly TestResultRepository	$test_pass_result_repository
	)

Definition at line 63 of file class.ilTestParticipantsGUI.php.

       {
         $this->participant_access_filter = new ilTestParticipantAccessFilterFactory($access);
     }

Member Function Documentation

◆ addCertificateExportToOptions()

ilTestParticipantsGUI::addCertificateExportToOptions ( array $options )

private

Parameters

array<

Definition at line 266 of file class.ilTestParticipantsGUI.php.

References Vendor\Package\$e, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by buildOptionsForTestWithNames().

                                                                   : array
     {
         try {
             if ((new ilCertificateActiveValidator())->validate()) {
                 $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::CERTIFICATE_ARCHIVE->value);
                 $options[] = $this->ui_factory->button()->shy(
                     $this->lng->txt('exp_grammar_as') . ' ' . $this->lng->txt('exp_type_certificate'),
                     $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
                 );
             }
         } catch (ilException $e) {
         }
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addExportDropdown()

ilTestParticipantsGUI::addExportDropdown ( ilToolbarGUI $toolbar )

private

Definition at line 227 of file class.ilTestParticipantsGUI.php.

References ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), buildOptionsForTestWithNames(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by showCmd().

                                                              : void
     {
         if ($this->test_access->checkManageParticipantsAccess()) {
             $toolbar->addSeparator();
         }
 
         $this->ctrl->clearParameterByClass(self::class, 'export_type');
         $toolbar->addComponent(
             $this->ui_factory->dropdown()->standard(
                 $this->buildOptionsForTestWithNames()
             )->withLabel($this->lng->txt('exp_eval_data'))
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addParticipants()

ilTestParticipantsGUI::addParticipants ( $user_ids = [] )

Definition at line 120 of file class.ilTestParticipantsGUI.php.

References $user_id, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                                    : ?bool
     {
         $filter_closure = $this->participant_access_filter->getManageParticipantsUserFilter($this->test_obj->getRefId());
         $filtered_user_ids = $filter_closure($user_ids);
 
         $users_count = 0;
         $client_ips = $this->testrequest->retrieveArrayOfStringsFromPost('client_ip');
         foreach ($filtered_user_ids as $user_id) {
             $this->test_obj->inviteUser($user_id, $client_ips[$users_count] ?? '');
             $users_count++;
         }
 
         $message = '';
         if ($users_count > 0) {
             $message = $this->lng->txt('tst_invited_selected_users');
         }
         if ($message !== '') {
             $this->main_tpl->setOnScreenMessage('info', $message, true);
         } else {
             $this->main_tpl->setOnScreenMessage('info', $this->lng->txt('tst_invited_nobody'), true);
             return false;
         }
 
         $this->ctrl->redirectByClass(self::class, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ addPluginExportsToOptions()

ilTestParticipantsGUI::addPluginExportsToOptions ( array $options )

private

Parameters

array<

Definition at line 285 of file class.ilTestParticipantsGUI.php.

References XapiProxy\$plugin, ILIAS\Repository\ctrl(), and ILIAS\Test\ExportImport\PLUGIN.

Referenced by buildOptionsForTestWithNames().

                                                               : array
     {
         foreach ($this->component_factory->getActivePluginsInSlot('texp') as $plugin) {
             $plugin->setTest($this->test_obj);
             $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::PLUGIN->value);
             $this->ctrl->setParameterByClass(self::class, self::EXPORT_PLUGIN_TYPE_PARAMETER, $plugin->getFormat());
             $options[] = $this->ui_factory->button()->shy(
                 $plugin->getFormatLabel(),
                 $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
             );
         }
         $this->ctrl->clearParameterByClass(self::class, self::EXPORT_PLUGIN_TYPE_PARAMETER);
         return $options;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addUserSearchControls()

ilTestParticipantsGUI::addUserSearchControls ( ilToolbarGUI $toolbar )

protected

Definition at line 205 of file class.ilTestParticipantsGUI.php.

References ilToolbarGUI\addComponent(), ilToolbarGUI\addSeparator(), ILIAS\Repository\ctrl(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), and ILIAS\Repository\lng().

Referenced by showCmd().

                                                                    : void
     {
         if (!$this->test_access->checkManageParticipantsAccess()) {
             return;
         }
         ilRepositorySearchGUI::fillAutoCompleteToolbar(
             $this,
             $toolbar,
             [
                 'auto_complete_name' => $this->lng->txt('user'),
                 'submit_name' => $this->lng->txt('add')
             ]
         );
         $toolbar->addSeparator();
 
         $search_btn = $this->ui_factory->button()->standard(
             $this->lng->txt('tst_search_users'),
             $this->ctrl->getLinkTargetByClass('ilRepositorySearchGUI', 'start')
         );
         $toolbar->addComponent($search_btn);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildOptionsForTestWithNames()

ilTestParticipantsGUI::buildOptionsForTestWithNames ( )

private

Returns: array<>

Definition at line 244 of file class.ilTestParticipantsGUI.php.

References addCertificateExportToOptions(), addPluginExportsToOptions(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by addExportDropdown().

                                                    : array
     {
         $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::SCORED_ATTEMPT->value);
         $options = [
             $this->ui_factory->button()->shy(
                 $this->lng->txt('exp_scored_test_attempt'),
                 $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
             )
         ];
         $this->ctrl->setParameterByClass(self::class, self::EXPORT_TYPE_PARAMETER, ExportImportTypes::ALL_ATTEMPTS->value);
         $options[] = $this->ui_factory->button()->shy(
             $this->lng->txt('exp_all_test_runs'),
             $this->ctrl->getLinkTargetByClass(self::class, 'exportResults')
         );
         $options = $this->addPluginExportsToOptions($options);
         return $this->addCertificateExportToOptions($options);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildParticipantTableActions()

ilTestParticipantsGUI::buildParticipantTableActions ( )

private

Definition at line 325 of file class.ilTestParticipantsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

Referenced by getParticipantTable().

                                                    : ParticipantTableActions
     {
         return new ParticipantTableActions(
             $this->ctrl,
             $this->lng,
             $this->main_tpl,
             $this->ui_factory,
             $this->ui_renderer,
             $this->refinery,
             $this->testrequest,
             $this->response_handler,
             $this->participant_repository,
             $this->test_obj,
             [
                 ParticipantTableShowResultsAction::ACTION_ID => new ParticipantTableShowResultsAction(
                     $this->lng,
                     $this->ui_factory,
                     $this->test_access,
                     $this->ctrl,
                     $this->test_obj
                 ),
                 ParticipantTableDeleteResultsAction::ACTION_ID => new ParticipantTableDeleteResultsAction(
                     $this->lng,
                     $this->main_tpl,
                     $this->ui_factory,
                     $this->db,
                     $this->participant_access_filter,
                     $this->test_access,
                     $this->test_obj
                 ),
                 ParticipantTableFinishTestAction::ACTION_ID => new ParticipantTableFinishTestAction(
                     $this->lng,
                     $this->main_tpl,
                     $this->ui_factory,
                     $this->db,
                     new \ilTestProcessLockerFactory(
                         new \ilSetting('assessment'),
                         $this->db
                     ),
                     $this->current_user,
                     $this->test_access,
                     $this->test_obj,
                     $this->test_pass_result_repository
                 ),
                 ParticipantTableIpRangeAction::ACTION_ID => new ParticipantTableIpRangeAction(
                     $this->lng,
                     $this->main_tpl,
                     $this->ui_factory,
                     $this->refinery,
                     $this->participant_repository,
                     $this->test_access
                 ),
                 ParticipantTableExtraTimeAction::ACTION_ID => new ParticipantTableExtraTimeAction(
                     $this->lng,
                     $this->refinery,
                     $this->main_tpl,
                     $this->ui_factory,
                     $this->participant_repository,
                     $this->current_user,
                     $this->test_access,
                     $this->test_obj
                 ),
                 ParticipantTableDeleteParticipantAction::ACTION_ID => new ParticipantTableDeleteParticipantAction(
                     $this->lng,
                     $this->main_tpl,
                     $this->ui_factory,
                     $this->participant_repository,
                     $this->test_access,
                     $this->test_obj
                 )
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilTestParticipantsGUI::executeCommand ( )

Definition at line 93 of file class.ilTestParticipantsGUI.php.

References ILIAS\Repository\ctrl().

                                     : void
     {
         if (!$this->test_access->checkManageParticipantsAccess()
             && !$this->test_access->checkParticipantsResultsAccess()) {
             ilObjTestGUI::accessViolationRedirect();
         }
         switch ($this->ctrl->getNextClass($this)) {
             case 'ilrepositorysearchgui':
                 $gui = new ilRepositorySearchGUI();
                 $gui->setCallback($this, self::CALLBACK_ADD_PARTICIPANT, []);
 
                 $gui->addUserAccessFilterCallable($this->participant_access_filter->getManageParticipantsUserFilter(
                     $this->test_obj->getRefId()
                 ));
 
 
                 $this->ctrl->setReturnByClass(self::class, self::CMD_SHOW);
                 $this->ctrl->forwardCommand($gui);
 
                 break;
 
             default:
                 $command = $this->ctrl->getCmd(self::CMD_SHOW) . 'Cmd';
                 $this->{$command}();
         }
     }

Here is the call graph for this function:

◆ executeTableActionCmd()

ilTestParticipantsGUI::executeTableActionCmd ( )

Definition at line 168 of file class.ilTestParticipantsGUI.php.

References ILIAS\Repository\ctrl(), getParticipantTable(), getTableActionUrlBuilder(), and showCmd().

                                            : void
     {
         $modal = $this->getParticipantTable()->execute($this->getTableActionUrlBuilder());
         if ($modal !== null) {
             $this->showCmd($modal);
             return;
         }
         $this->ctrl->redirectByClass(self::class, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ exportResultsCmd()

ilTestParticipantsGUI::exportResultsCmd ( )

Definition at line 300 of file class.ilTestParticipantsGUI.php.

References ILIAS\Repository\lng(), ILIAS\Test\ExportImport\PLUGIN, and showCmd().

                                       : void
     {
         $export_type = ExportImportTypes::tryFrom(
             $this->testrequest->strVal(self::EXPORT_TYPE_PARAMETER)
         );
 
         if ($export_type === null) {
             $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('error'));
             $this->showCmd();
             return;
         }
 
         $plugin_type = null;
         if ($export_type === ExportImportTypes::PLUGIN) {
             $plugin_type = $this->testrequest->strVal(self::EXPORT_PLUGIN_TYPE_PARAMETER);
         }
 
         $this->export_factory->getExporter(
             $this->test_obj,
             $export_type,
             $plugin_type
         )->deliver();
         $this->showCmd();
     }

Here is the call graph for this function:

◆ getParticipantTable()

ilTestParticipantsGUI::getParticipantTable ( )

private

Definition at line 178 of file class.ilTestParticipantsGUI.php.

References buildParticipantTableActions(), and ILIAS\Repository\lng().

Referenced by executeTableActionCmd(), and showCmd().

                                           : ParticipantTable
     {
         return new ParticipantTable(
             $this->ui_factory,
             $this->ui_service,
             $this->lng,
             $this->test_access,
             $this->testrequest,
             $this->participant_access_filter,
             $this->participant_repository,
             $this->results_data_factory,
             $this->results_presentation_factory->getAttemptResultsSettings(
                 $this->test_obj,
                 false
             ),
             $this->current_user,
             $this->test_obj,
             $this->buildParticipantTableActions()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTableActionUrlBuilder()

ilTestParticipantsGUI::getTableActionUrlBuilder ( )

private

Definition at line 199 of file class.ilTestParticipantsGUI.php.

References ILIAS\Repository\ctrl().

Referenced by executeTableActionCmd(), and showCmd().

                                                : URLBuilder
     {
         $uri = $this->ctrl->getLinkTargetByClass(self::class, 'executeTableAction', '', true);
         return new URLBuilder($this->data_factory->uri(ILIAS_HTTP_PATH . '/' . $uri));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showCmd()

ilTestParticipantsGUI::showCmd ( ?Modal $modal = null )

Definition at line 146 of file class.ilTestParticipantsGUI.php.

References $components, addExportDropdown(), addUserSearchControls(), ILIAS\Repository\ctrl(), getParticipantTable(), getTableActionUrlBuilder(), and ILIAS\Repository\toolbar().

Referenced by executeTableActionCmd(), and exportResultsCmd().

                                                  : void
     {
         $this->addUserSearchControls($this->toolbar);
 
         if ($this->test_obj->evalTotalPersons() > 0) {
             $this->addExportDropdown($this->toolbar);
         }
 
         $components = $this->getParticipantTable()->getComponents(
             $this->getTableActionUrlBuilder(),
             $this->ctrl->getLinkTargetByClass(self::class, 'show')
         );
 
         if ($modal !== null) {
             $components[] = $modal;
         }
 
         $this->main_tpl->setContent(
             $this->ui_renderer->render($components)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $participant_access_filter

ilTestParticipantAccessFilterFactory ilTestParticipantsGUI::$participant_access_filter

protected

Definition at line 61 of file class.ilTestParticipantsGUI.php.

◆ CALLBACK_ADD_PARTICIPANT

const ilTestParticipantsGUI::CALLBACK_ADD_PARTICIPANT = 'addParticipants'

Definition at line 56 of file class.ilTestParticipantsGUI.php.

◆ CMD_SHOW

const ilTestParticipantsGUI::CMD_SHOW = 'show'

Definition at line 54 of file class.ilTestParticipantsGUI.php.

◆ EXPORT_PLUGIN_TYPE_PARAMETER

const ilTestParticipantsGUI::EXPORT_PLUGIN_TYPE_PARAMETER = 'export_plugin_type'

private

Definition at line 59 of file class.ilTestParticipantsGUI.php.

◆ EXPORT_TYPE_PARAMETER

const ilTestParticipantsGUI::EXPORT_TYPE_PARAMETER = 'export_type'

private

Definition at line 58 of file class.ilTestParticipantsGUI.php.

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

components/ILIAS/Test/classes/class.ilTestParticipantsGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addCertificateExportToOptions()

◆ addExportDropdown()

◆ addParticipants()

◆ addPluginExportsToOptions()

◆ addUserSearchControls()

◆ buildOptionsForTestWithNames()

◆ buildParticipantTableActions()

◆ executeCommand()

◆ executeTableActionCmd()

◆ exportResultsCmd()

◆ getParticipantTable()

◆ getTableActionUrlBuilder()

◆ showCmd()

Field Documentation

◆ $participant_access_filter

◆ CALLBACK_ADD_PARTICIPANT

◆ CMD_SHOW

◆ EXPORT_PLUGIN_TYPE_PARAMETER

◆ EXPORT_TYPE_PARAMETER