Collaboration diagram for ilTestParticipantsGUI:

Public Member Functions
	__construct (protected ilObjTest $test_obj, protected ilTestQuestionSetConfig $question_set_config, protected ilAccess $access, protected ilGlobalTemplateInterface $main_tpl, protected UIFactory $ui_factory, protected UIRenderer $ui_renderer, protected ilLanguage $lng, protected ilCtrl $ctrl, protected ilDBInterface $db, protected ilTabsGUI $tabs, protected ilToolbarGUI $toolbar, protected InternalRequestService $testrequest)

	getTestObj ()

	setTestObj (ilObjTest $test_obj)

	getQuestionSetConfig ()

	setQuestionSetConfig (ilTestQuestionSetConfig $question_set_config)

	getObjectiveParent ()

	setObjectiveParent (ilTestObjectiveOrientedContainer $objective_parent)

	getTestAccess ()

	setTestAccess (ilTestAccess $test_access)

	executeCommand ()

	addParticipants ($user_ids=[])

	showCmd ()

Data Fields
const	CMD_SHOW = 'show'

const	CMD_SET_FILTER = 'setFilter'

const	CMD_RESET_FILTER = 'resetFilter'

const	CMD_SAVE_CLIENT_IP = 'saveClientIp'

const	CALLBACK_ADD_PARTICIPANT = 'addParticipants'

Protected Member Functions
	buildTableGUI ()

	setFilterCmd ()

	resetFilterCmd ()

	applyFilterCriteria (array $in_rows)

	initToolbarControls (ilTestParticipantList $participant_list)

	addUserSearchControls (ilToolbarGUI $toolbar)

	addFinishAllPassesButton (ilToolbarGUI $toolbar)

	saveClientIpCmd ()

	removeParticipantsCmd ()

Protected Attributes
ilTestObjectiveOrientedContainer	$objective_parent

ilTestAccess	$test_access

ilTestParticipantAccessFilterFactory	$participant_access_filter

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestParticipantsGUI::__construct	(	protected ilObjTest	$test_obj,
		protected ilTestQuestionSetConfig	$question_set_config,
		protected ilAccess	$access,
		protected ilGlobalTemplateInterface	$main_tpl,
		protected UIFactory	$ui_factory,
		protected UIRenderer	$ui_renderer,
		protected ilLanguage	$lng,
		protected ilCtrl	$ctrl,
		protected ilDBInterface	$db,
		protected ilTabsGUI	$tabs,
		protected ilToolbarGUI	$toolbar,
		protected InternalRequestService	$testrequest
	)

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

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

Member Function Documentation

◆ addFinishAllPassesButton()

ilTestParticipantsGUI::addFinishAllPassesButton ( ilToolbarGUI $toolbar )

protected

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

References $DIC, and ilToolbarGUI\addComponent().

Referenced by initToolbarControls().

                                                                       : void
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $finish_all_user_passes_btn = $DIC->ui()->factory()->button()->standard(
             $DIC->language()->txt('finish_all_user_passes'),
             $DIC->ctrl()->getLinkTargetByClass('iltestevaluationgui', 'finishAllUserPasses')
         );
         $toolbar->addComponent($finish_all_user_passes_btn);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addParticipants()

ilTestParticipantsGUI::addParticipants ( $user_ids = [] )

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

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

                                                    : ?bool
     {
         $filter_closure = $this->participant_access_filter->getManageParticipantsUserFilter($this->getTestObj()->getRefId());
         $filtered_user_ids = $filter_closure($user_ids);
 
         $countusers = 0;
         foreach ($filtered_user_ids as $user_id) {
             $client_ip = $_POST["client_ip"][$countusers] ?? '';
             $this->getTestObj()->inviteUser($user_id, $client_ip);
             $countusers++;
         }
 
         $message = "";
         if ($countusers) {
             $message = $this->lng->txt("tst_invited_selected_users");
         }
         if (strlen($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->redirect($this, self::CMD_SHOW);
         return null;
     }

Here is the call graph for this function:

◆ addUserSearchControls()

ilTestParticipantsGUI::addUserSearchControls ( ilToolbarGUI $toolbar )

protected

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

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

Referenced by initToolbarControls().

                                                                    : void
     {
         ilRepositorySearchGUI::fillAutoCompleteToolbar(
             $this,
             $toolbar,
             array(
                 '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:

◆ applyFilterCriteria()

ilTestParticipantsGUI::applyFilterCriteria ( array $in_rows )

protected

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

References ilSession\get(), and getTestObj().

Referenced by showCmd().

                                                           : array
     {
         $selected_pax = ilSession::get('form_tst_participants_' . $this->getTestObj()->getRefId() . '_selection');
 
         if (!is_string($selected_pax)) {
             return $in_rows;
         }
 
         $filter = unserialize($selected_pax, ['allowed_classes' => false]);
 
         if (!is_string($filter) || $filter === 'all') {
             return $in_rows;
         }
 
         $rows = [];
 
         foreach ($in_rows as $row) {
             $query = $this->db->query(
                 'SELECT count(solution_id) count
                                 FROM tst_solutions
                                 WHERE active_fi = ' . $this->db->quote($row['active_id'])
                 . ' HAVING count ' . ($filter === 'withSolutions' ? '>' : '=') . ' 0'
             );
 
             if (is_array($this->db->fetchAssoc($query))) {
                 $rows[] = $row;
             }
         }
 
         return $rows;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTableGUI()

ilTestParticipantsGUI::buildTableGUI ( )

protected

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

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

Referenced by resetFilterCmd(), setFilterCmd(), and showCmd().

                                       : ilTestParticipantsTableGUI
     {
         $table_gui = new ilTestParticipantsTableGUI($this, self::CMD_SHOW, $this->ui_factory, $this->ui_renderer);
 
         $table_gui->setParticipantHasSolutionsFilterEnabled(
             $this->getTestObj()->getFixedParticipants()
         );
 
         if ($this->getTestObj()->getFixedParticipants()) {
             $table_gui->setTitle($this->lng->txt('tst_tbl_invited_users'));
         } else {
             $table_gui->setTitle($this->lng->txt('tst_tbl_participants'));
         }
 
         return $table_gui;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilTestParticipantsGUI::executeCommand ( )

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

References ILIAS\Repository\ctrl(), getObjectiveParent(), getTestAccess(), getTestObj(), and ILIAS\Repository\tabs().

                                     : void
     {
         switch ($this->ctrl->getNextClass($this)) {
             case 'ilrepositorysearchgui':
                 $gui = new ilRepositorySearchGUI();
                 $gui->setCallback($this, self::CALLBACK_ADD_PARTICIPANT, array());
 
                 $gui->addUserAccessFilterCallable($this->participant_access_filter->getManageParticipantsUserFilter(
                     $this->getTestObj()->getRefId()
                 ));
 
 
                 $this->ctrl->setReturn($this, self::CMD_SHOW);
                 $this->ctrl->forwardCommand($gui);
 
                 break;
 
             case "iltestevaluationgui":
                 $gui = new ilTestEvaluationGUI($this->getTestObj());
                 $gui->setObjectiveOrientedContainer($this->getObjectiveParent());
                 $gui->setTestAccess($this->getTestAccess());
                 $this->tabs->clearTargets();
                 $this->tabs->clearSubTabs();
 
                 $this->ctrl->forwardCommand($gui);
 
                 break;
 
             default:
 
                 $command = $this->ctrl->getCmd(self::CMD_SHOW) . 'Cmd';
                 $this->{$command}();
         }
     }

Here is the call graph for this function:

◆ getObjectiveParent()

ilTestParticipantsGUI::getObjectiveParent ( )

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

References $objective_parent.

Referenced by executeCommand().

                                         : ilTestObjectiveOrientedContainer
     {
         return $this->objective_parent;
     }

Here is the caller graph for this function:

◆ getQuestionSetConfig()

ilTestParticipantsGUI::getQuestionSetConfig ( )

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

Referenced by showCmd().

                                           : ilTestQuestionSetConfig
     {
         return $this->question_set_config;
     }

Here is the caller graph for this function:

◆ getTestAccess()

ilTestParticipantsGUI::getTestAccess ( )

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

References $test_access.

Referenced by executeCommand().

                                    : ilTestAccess
     {
         return $this->test_access;
     }

Here is the caller graph for this function:

◆ getTestObj()

ilTestParticipantsGUI::getTestObj ( )

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

Referenced by ilTestParticipantsTableGUI\__construct(), addParticipants(), applyFilterCriteria(), buildTableGUI(), executeCommand(), initToolbarControls(), removeParticipantsCmd(), saveClientIpCmd(), setFilterCmd(), and showCmd().

                                 : ilObjTest
     {
         return $this->test_obj;
     }

Here is the caller graph for this function:

◆ initToolbarControls()

ilTestParticipantsGUI::initToolbarControls ( ilTestParticipantList $participant_list )

protected

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

References addFinishAllPassesButton(), addUserSearchControls(), getTestObj(), ilTestParticipantList\hasUnfinishedPasses(), and ILIAS\Repository\toolbar().

Referenced by showCmd().

                                                                                    : void
     {
         if ($this->getTestObj()->getFixedParticipants()) {
             $this->addUserSearchControls($this->toolbar);
         }
 
         if ($this->getTestObj()->getFixedParticipants() && $participant_list->hasUnfinishedPasses()) {
             $this->toolbar->addSeparator();
         }
 
         if ($participant_list->hasUnfinishedPasses()) {
             $this->addFinishAllPassesButton($this->toolbar);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeParticipantsCmd()

ilTestParticipantsGUI::removeParticipantsCmd ( )

protected

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

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

                                               : void
     {
         $filter_closure = $this->participant_access_filter->getManageParticipantsUserFilter($this->getTestObj()->getRefId());
         $a_user_ids = $filter_closure((array) $_POST["chbUser"]);
 
         if (is_array($a_user_ids)) {
             foreach ($a_user_ids as $user_id) {
                 $this->getTestObj()->disinviteUser($user_id);
             }
         } else {
             $this->main_tpl->setOnScreenMessage('info', $this->lng->txt("select_one_user"), true);
         }
 
         $this->ctrl->redirect($this, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ resetFilterCmd()

ilTestParticipantsGUI::resetFilterCmd ( )

protected

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

References buildTableGUI(), and showCmd().

                                        : void
     {
         $table_gui = $this->buildTableGUI();
         $table_gui->resetFilter();
         $table_gui->resetOffset();
         $this->showCmd();
     }

Here is the call graph for this function:

◆ saveClientIpCmd()

ilTestParticipantsGUI::saveClientIpCmd ( )

protected

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

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

                                         : void
     {
         $filter_closure = $this->participant_access_filter->getManageParticipantsUserFilter($this->getTestObj()->getRefId());
         $selected_users = $filter_closure($this->testrequest->raw('chbUser') ?? []);
 
         if ($selected_users === []) {
             $this->main_tpl->setOnScreenMessage('info', $this->lng->txt("select_one_user"), true);
         }
 
         foreach ($selected_users as $user_id) {
             $this->getTestObj()->setClientIP($user_id, $_POST["clientip_" . $user_id]);
         }
 
         $this->ctrl->redirect($this, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ setFilterCmd()

ilTestParticipantsGUI::setFilterCmd ( )

protected

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

References buildTableGUI(), getTestObj(), and showCmd().

                                      : void
     {
         $table_gui = $this->buildTableGUI();
         $table_gui->initFilter($this->getTestObj()->getFixedParticipants());
         $table_gui->writeFilterToSession();
         $table_gui->resetOffset();
         $this->showCmd();
     }

Here is the call graph for this function:

◆ setObjectiveParent()

ilTestParticipantsGUI::setObjectiveParent ( ilTestObjectiveOrientedContainer $objective_parent )

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

References $objective_parent.

                                                                                           : void
     {
         $this->objective_parent = $objective_parent;
     }

◆ setQuestionSetConfig()

ilTestParticipantsGUI::setQuestionSetConfig ( ilTestQuestionSetConfig $question_set_config )

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

                                                                                       : void
     {
         $this->question_set_config = $question_set_config;
     }

◆ setTestAccess()

ilTestParticipantsGUI::setTestAccess ( ilTestAccess $test_access )

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

References $test_access.

                                                             : void
     {
         $this->test_access = $test_access;
     }

◆ setTestObj()

ilTestParticipantsGUI::setTestObj ( ilObjTest $test_obj )

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

                                                    : void
     {
         $this->test_obj = $test_obj;
     }

◆ showCmd()

ilTestParticipantsGUI::showCmd ( )

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

References applyFilterCriteria(), buildTableGUI(), ILIAS\Repository\ctrl(), getQuestionSetConfig(), getTestObj(), initToolbarControls(), and ILIAS\Repository\lng().

Referenced by resetFilterCmd(), and setFilterCmd().

                              : void
     {
         $table_gui = $this->buildTableGUI();
 
         if (!$this->getQuestionSetConfig()->areDepenciesBroken()) {
             if ($this->getTestObj()->getFixedParticipants()) {
                 $participant_list = $this->getTestObj()->getInvitedParticipantList()->getAccessFilteredList(
                     $this->participant_access_filter->getManageParticipantsUserFilter($this->getTestObj()->getRefId())
                 );
 
                 $table_gui->setData($this->applyFilterCriteria($participant_list->getParticipantsTableRows()));
                 $table_gui->setRowKeyDataField('usr_id');
                 $table_gui->setManageInviteesCommandsEnabled(true);
                 $table_gui->setDescription($this->lng->txt("fixed_participants_hint"));
             } else {
                 $participant_list = $this->getTestObj()->getActiveParticipantList()->getAccessFilteredList(
                     $this->participant_access_filter->getManageParticipantsUserFilter($this->getTestObj()->getRefId())
                 );
 
                 $table_gui->setData($participant_list->getParticipantsTableRows());
                 $table_gui->setRowKeyDataField('active_id');
             }
 
             $table_gui->setManageResultsCommandsEnabled(true);
 
             $this->initToolbarControls($participant_list);
         }
 
         $table_gui->setAnonymity($this->getTestObj()->getAnonymity());
 
         $table_gui->initColumns();
         $table_gui->initCommands();
 
         $table_gui->initFilter();
         $table_gui->setFilterCommand(self::CMD_SET_FILTER);
         $table_gui->setResetCommand(self::CMD_RESET_FILTER);
 
         $this->main_tpl->setContent($this->ctrl->getHTML($table_gui));
     }