Collaboration diagram for ilTestParticipantsGUI:

Public Member Functions
	__construct (ilObjTest $testObj, ilTestQuestionSetConfig $questionSetConfig)
	ilTestParticipantsGUI constructor. More...

	getTestObj ()

	setTestObj ($testObj)

	getQuestionSetConfig ()

	setQuestionSetConfig ($questionSetConfig)

	getObjectiveParent ()

	setObjectiveParent (ilTestObjectiveOrientedContainer $objectiveParent)

	getTestAccess ()

	setTestAccess (ilTestAccess $testAccess)

	executeCommand ()
	Execute Command. More...

	addParticipants ($a_user_ids=array())

	showCmd ()
	show command More...

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 ()
	set table filter command More...

	resetFilterCmd ()
	reset table filter command More...

	applyFilterCriteria ($in_rows)

	initToolbarControls (ilTestParticipantList $participantList)

	addUserSearchControls (ilToolbarGUI $toolbar)

	addFinishAllPassesButton (ilToolbarGUI $toolbar)

	saveClientIpCmd ()
	save client ip command More...

	removeParticipantsCmd ()
	remove participants command More...

Protected Attributes
	$testObj

	$questionSetConfig

	$objectiveParent

	$testAccess

Private Attributes
ilGlobalTemplateInterface	$main_tpl

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestParticipantsGUI::__construct	(	ilObjTest	$testObj,
		ilTestQuestionSetConfig	$questionSetConfig
	)

ilTestParticipantsGUI constructor.

Parameters

ilObjTest $testObj

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

References $DIC, $questionSetConfig, and $testObj.

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
         $this->testObj = $testObj;
         $this->questionSetConfig = $questionSetConfig;
     }

Member Function Documentation

◆ addFinishAllPassesButton()

ilTestParticipantsGUI::addFinishAllPassesButton ( ilToolbarGUI $toolbar )

protected

Parameters

ilToolbarGUI $toolbar

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

References $DIC, ilToolbarGUI\addButtonInstance(), and ilLinkButton\getInstance().

Referenced by initToolbarControls().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $finish_all_user_passes_btn = ilLinkButton::getInstance();
         $finish_all_user_passes_btn->setCaption('finish_all_user_passes');
         $finish_all_user_passes_btn->setUrl($DIC->ctrl()->getLinkTargetByClass('iltestevaluationgui', 'finishAllUserPasses'));
         $toolbar->addButtonInstance($finish_all_user_passes_btn);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addParticipants()

ilTestParticipantsGUI::addParticipants ( $a_user_ids = array() )

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

References $DIC, $i, $message, ilTestParticipantAccessFilter\getManageParticipantsUserFilter(), and getTestObj().

                                                           : ?bool
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
         $filterCallback = ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId());
         $a_user_ids = call_user_func_array($filterCallback, [$a_user_ids]);
 
         $countusers = 0;
         // add users
         if (is_array($a_user_ids)) {
             $i = 0;
             foreach ($a_user_ids as $user_id) {
                 $client_ip = $_POST["client_ip"][$i] ?? '';
                 $this->getTestObj()->inviteUser($user_id, $client_ip);
                 $countusers++;
                 $i++;
             }
         }
         $message = "";
         if ($countusers) {
             $message = $DIC->language()->txt("tst_invited_selected_users");
         }
         if (strlen($message)) {
             $this->main_tpl->setOnScreenMessage('info', $message, true);
         } else {
             $this->main_tpl->setOnScreenMessage('info', $DIC->language()->txt("tst_invited_nobody"), true);
             return false;
         }
 
         $DIC->ctrl()->redirect($this, self::CMD_SHOW);
         return null;
     }

Here is the call graph for this function:

◆ addUserSearchControls()

ilTestParticipantsGUI::addUserSearchControls ( ilToolbarGUI $toolbar )

protected

Parameters

ilToolbarGUI	$toolbar
ilLanguage	$lng

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

References $DIC, ilToolbarGUI\addButtonInstance(), ilToolbarGUI\addSeparator(), ilRepositorySearchGUI\fillAutoCompleteToolbar(), and ilLinkButton\getInstance().

Referenced by initToolbarControls().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         // search button
         include_once './Services/Search/classes/class.ilRepositorySearchGUI.php';
         ilRepositorySearchGUI::fillAutoCompleteToolbar(
             $this,
             $toolbar,
             array(
                 'auto_complete_name' => $DIC->language()->txt('user'),
                 'submit_name' => $DIC->language()->txt('add')
             )
         );
 
         require_once  'Services/UIComponent/Button/classes/class.ilLinkButton.php';
         $search_btn = ilLinkButton::getInstance();
         $search_btn->setCaption('tst_search_users');
         $search_btn->setUrl($DIC->ctrl()->getLinkTargetByClass('ilRepositorySearchGUI', 'start'));
 
         $toolbar->addSeparator();
         $toolbar->addButtonInstance($search_btn);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyFilterCriteria()

ilTestParticipantsGUI::applyFilterCriteria ( $in_rows )

protected

Parameters

array $in_rows

Returns: array

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

References $DIC, $query, $rows, ilSession\get(), and getTestObj().

Referenced by showCmd().

                                                     : array
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $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 = $DIC->database()->query(
                 'SELECT count(solution_id) count
                                 FROM tst_solutions
                                 WHERE active_fi = ' . $DIC->database()->quote($row['active_id'])
                 . ' HAVING count ' . ($filter === 'withSolutions' ? '>' : '=') . ' 0'
             );
 
             if (is_array($DIC->database()->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

Returns: ilTestParticipantsTableGUI

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

References $DIC, and getTestObj().

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

                                       : ilTestParticipantsTableGUI
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         require_once 'Modules/Test/classes/tables/class.ilTestParticipantsTableGUI.php';
         $tableGUI = new ilTestParticipantsTableGUI($this, self::CMD_SHOW);
 
         $tableGUI->setParticipantHasSolutionsFilterEnabled(
             (bool) $this->getTestObj()->getFixedParticipants()
         );
 
         if ($this->getTestObj()->getFixedParticipants()) {
             $tableGUI->setTitle($DIC->language()->txt('tst_tbl_invited_users'));
         } else {
             $tableGUI->setTitle($DIC->language()->txt('tst_tbl_participants'));
         }
 
         return $tableGUI;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilTestParticipantsGUI::executeCommand ( )

Execute Command.

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

References $DIC, ilTestParticipantAccessFilter\getManageParticipantsUserFilter(), getObjectiveParent(), getTestAccess(), and getTestObj().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
 
         switch ($DIC->ctrl()->getNextClass($this)) {
             case 'ilrepositorysearchgui':
 
                 require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
                 require_once 'Services/Search/classes/class.ilRepositorySearchGUI.php';
 
                 $gui = new ilRepositorySearchGUI();
                 $gui->setCallback($this, self::CALLBACK_ADD_PARTICIPANT, array());
 
                 $gui->addUserAccessFilterCallable(ilTestParticipantAccessFilter::getManageParticipantsUserFilter(
                     $this->getTestObj()->getRefId()
                 ));
 
 
                 $DIC->ctrl()->setReturn($this, self::CMD_SHOW);
                 $DIC->ctrl()->forwardCommand($gui);
 
                 break;
 
             case "iltestevaluationgui":
 
                 require_once 'Modules/Test/classes/class.ilTestEvaluationGUI.php';
 
                 $gui = new ilTestEvaluationGUI($this->getTestObj());
                 $gui->setObjectiveOrientedContainer($this->getObjectiveParent());
                 $gui->setTestAccess($this->getTestAccess());
                 $DIC->tabs()->clearTargets();
                 $DIC->tabs()->clearSubTabs();
 
                 $DIC->ctrl()->forwardCommand($gui);
 
                 break;
 
             default:
 
                 $command = $DIC->ctrl()->getCmd(self::CMD_SHOW) . 'Cmd';
                 $this->{$command}();
         }
     }

Here is the call graph for this function:

◆ getObjectiveParent()

ilTestParticipantsGUI::getObjectiveParent ( )

Returns: ilTestObjectiveOrientedContainer

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

References $objectiveParent.

Referenced by executeCommand().

                                         : ilTestObjectiveOrientedContainer
     {
         return $this->objectiveParent;
     }

Here is the caller graph for this function:

◆ getQuestionSetConfig()

ilTestParticipantsGUI::getQuestionSetConfig ( )

Returns: ilTestQuestionSetConfig

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

References $questionSetConfig.

Referenced by showCmd().

                                           : ilTestQuestionSetConfig
     {
         return $this->questionSetConfig;
     }

Here is the caller graph for this function:

◆ getTestAccess()

ilTestParticipantsGUI::getTestAccess ( )

Returns: ilTestAccess

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

References $testAccess.

Referenced by executeCommand().

                                    : ilTestAccess
     {
         return $this->testAccess;
     }

Here is the caller graph for this function:

◆ getTestObj()

ilTestParticipantsGUI::getTestObj ( )

Returns: ilObjTest

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

References $testObj.

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

                                 : ilObjTest
     {
         return $this->testObj;
     }

Here is the caller graph for this function:

◆ initToolbarControls()

ilTestParticipantsGUI::initToolbarControls ( ilTestParticipantList $participantList )

protected

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

References $DIC, addFinishAllPassesButton(), addUserSearchControls(), getTestObj(), and ilTestParticipantList\hasUnfinishedPasses().

Referenced by showCmd().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         if ($this->getTestObj()->getFixedParticipants()) {
             $this->addUserSearchControls($DIC->toolbar());
         }
 
         if ($this->getTestObj()->getFixedParticipants() && $participantList->hasUnfinishedPasses()) {
             $DIC->toolbar()->addSeparator();
         }
 
         if ($participantList->hasUnfinishedPasses()) {
             $this->addFinishAllPassesButton($DIC->toolbar());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeParticipantsCmd()

ilTestParticipantsGUI::removeParticipantsCmd ( )

protected

remove participants command

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

References $DIC, ilTestParticipantAccessFilter\getManageParticipantsUserFilter(), and getTestObj().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
         $filterCallback = ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId());
         $a_user_ids = call_user_func_array($filterCallback, [(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', $DIC->language()->txt("select_one_user"), true);
         }
 
         $DIC->ctrl()->redirect($this, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ resetFilterCmd()

ilTestParticipantsGUI::resetFilterCmd ( )

protected

reset table filter command

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

References buildTableGUI(), and showCmd().

     {
         $tableGUI = $this->buildTableGUI();
         $tableGUI->resetFilter();
         $tableGUI->resetOffset();
         $this->showCmd();
     }

Here is the call graph for this function:

◆ saveClientIpCmd()

ilTestParticipantsGUI::saveClientIpCmd ( )

protected

save client ip command

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

References $DIC, ilTestParticipantAccessFilter\getManageParticipantsUserFilter(), and getTestObj().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         require_once 'Modules/Test/classes/class.ilTestParticipantAccessFilter.php';
         $filterCallback = ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId());
         $a_user_ids = call_user_func_array($filterCallback, [(array) $_POST["chbUser"]]);
 
         if (is_array($a_user_ids)) {
             foreach ($a_user_ids as $user_id) {
                 $this->getTestObj()->setClientIP($user_id, $_POST["clientip_" . $user_id]);
             }
         } else {
             $this->main_tpl->setOnScreenMessage('info', $DIC->language()->txt("select_one_user"), true);
         }
         $DIC->ctrl()->redirect($this, self::CMD_SHOW);
     }

Here is the call graph for this function:

◆ setFilterCmd()

ilTestParticipantsGUI::setFilterCmd ( )

protected

set table filter command

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

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

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

Here is the call graph for this function:

◆ setObjectiveParent()

ilTestParticipantsGUI::setObjectiveParent ( ilTestObjectiveOrientedContainer $objectiveParent )

Parameters

ilTestObjectiveOrientedContainer $objectiveParent

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

References $objectiveParent.

     {
         $this->objectiveParent = $objectiveParent;
     }

◆ setQuestionSetConfig()

ilTestParticipantsGUI::setQuestionSetConfig ( $questionSetConfig )

Parameters

ilTestQuestionSetConfig $questionSetConfig

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

References $questionSetConfig.

     {
         $this->questionSetConfig = $questionSetConfig;
     }

◆ setTestAccess()

ilTestParticipantsGUI::setTestAccess ( ilTestAccess $testAccess )

Parameters

ilTestAccess $testAccess

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

References $testAccess.

     {
         $this->testAccess = $testAccess;
     }

◆ setTestObj()

ilTestParticipantsGUI::setTestObj ( $testObj )

Parameters

ilObjTest $testObj

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

References $testObj.

     {
         $this->testObj = $testObj;
     }

◆ showCmd()

ilTestParticipantsGUI::showCmd ( )

show command

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

References $DIC, applyFilterCriteria(), buildTableGUI(), ilTestParticipantAccessFilter\getManageParticipantsUserFilter(), getQuestionSetConfig(), getTestObj(), and initToolbarControls().

Referenced by resetFilterCmd(), and setFilterCmd().

     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $tableGUI = $this->buildTableGUI();
 
         if (!$this->getQuestionSetConfig()->areDepenciesBroken()) {
             if ($this->getTestObj()->getFixedParticipants()) {
                 $participantList = $this->getTestObj()->getInvitedParticipantList()->getAccessFilteredList(
                     ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId())
                 );
 
                 $tableGUI->setData($this->applyFilterCriteria($participantList->getParticipantsTableRows()));
                 $tableGUI->setRowKeyDataField('usr_id');
                 $tableGUI->setManageInviteesCommandsEnabled(true);
                 $tableGUI->setDescription($DIC->language()->txt("fixed_participants_hint"));
             } else {
                 $participantList = $this->getTestObj()->getActiveParticipantList()->getAccessFilteredList(
                     ilTestParticipantAccessFilter::getManageParticipantsUserFilter($this->getTestObj()->getRefId())
                 );
 
                 $tableGUI->setData($participantList->getParticipantsTableRows());
                 $tableGUI->setRowKeyDataField('active_id');
             }
 
             $tableGUI->setManageResultsCommandsEnabled(true);
 
             $this->initToolbarControls($participantList);
         }
 
         $tableGUI->setAnonymity($this->getTestObj()->getAnonymity());
 
         $tableGUI->initColumns();
         $tableGUI->initCommands();
 
         $tableGUI->initFilter();
         $tableGUI->setFilterCommand(self::CMD_SET_FILTER);
         $tableGUI->setResetCommand(self::CMD_RESET_FILTER);
 
         $DIC->ui()->mainTemplate()->setContent($DIC->ctrl()->getHTML($tableGUI));
     }