Collaboration diagram for ilTestParticipantData:

Public Member Functions
	__construct (ilDBInterface $db, ilLanguage $lng)

	getParticipantAccessFilter ()

	setParticipantAccessFilter ($participantAccessFilter)

	isScoredParticipantsFilterEnabled ()

	setScoredParticipantsFilterEnabled ($scoredParticipantsFilterEnabled)

	load ($testId)

	getScoredParticipantsFilterExpression ()

	getConditionalExpression ()

	setActiveIdsFilter ($activeIdsFilter)

	getActiveIdsFilter ()

	setUserIdsFilter ($userIdsFilter)

	getUserIdsFilter ()

	setAnonymousIdsFilter ($anonymousIdsFilter)

	getAnonymousIdsFilter ()

	getActiveIds ()

	getUserIds ()

	getAnonymousIds ()

	getUserIdByActiveId ($activeId)

	getActiveIdByUserId ($userId)

	getConcatedFullnameByActiveId ($activeId)

	getFormatedFullnameByActiveId ($activeId)

	getFileSystemCompliantFullnameByActiveId ($activeId)

	getOptionArray ()

	getAnonymousActiveIds ()

	getUserDataByActiveId ($activeId)

Protected Attributes
	$db

	$lng

	$participantAccessFilter

	$scoredParticipantsFilterEnabled

Private Member Functions
	buildFormatedFullname ($usrData)

Private Attributes
	$activeIdsFilter

	$userIdsFilter

	$anonymousIdsFilter

	$byActiveId

	$byUserId

	$byAnonymousId

Detailed Description

Definition at line 11 of file class.ilTestParticipantData.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestParticipantData::__construct	(	ilDBInterface	$db,
		ilLanguage	$lng
	)

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

References $db, and $lng.

     {
         $this->db = $db;
         $this->lng = $lng;
 
         $this->activeIdsFilter = array();
         $this->userIdsFilter = array();
         $this->anonymousIdsFilter = array();
 
         $this->byActiveId = array();
         $this->byUserId = array();
         $this->byAnonymousId = array();
         
         $this->scoredParticipantsFilterEnabled = false;
     }

Member Function Documentation

◆ buildFormatedFullname()

ilTestParticipantData::buildFormatedFullname ( $usrData )

private

Definition at line 280 of file class.ilTestParticipantData.php.

Referenced by getFormatedFullnameByActiveId(), and getOptionArray().

     {
         return sprintf(
             $this->lng->txt('tst_participant_fullname_pattern'),
             $usrData['firstname'],
             $usrData['lastname']
         );
     }

Here is the caller graph for this function:

◆ getActiveIdByUserId()

ilTestParticipantData::getActiveIdByUserId ( $userId )

Definition at line 243 of file class.ilTestParticipantData.php.

     {
         return $this->byUserId[$userId]['active_id'];
     }

◆ getActiveIds()

ilTestParticipantData::getActiveIds ( )

Definition at line 223 of file class.ilTestParticipantData.php.

Referenced by ilAssFileUploadUploadsExporter\collectUploadedFiles(), and ilObjTest\removeTestResults().

     {
         return array_keys($this->byActiveId);
     }

Here is the caller graph for this function:

◆ getActiveIdsFilter()

ilTestParticipantData::getActiveIdsFilter ( )

Definition at line 198 of file class.ilTestParticipantData.php.

References $activeIdsFilter.

Referenced by getConditionalExpression().

     {
         return $this->activeIdsFilter;
     }

Here is the caller graph for this function:

◆ getAnonymousActiveIds()

ilTestParticipantData::getAnonymousActiveIds ( )

Definition at line 289 of file class.ilTestParticipantData.php.

Referenced by ilObjTest\removeTestResults().

     {
         $anonymousActiveIds = array();
         
         foreach ($this->byActiveId as $activeId => $active) {
             if ($active['user_id'] == ANONYMOUS_USER_ID) {
                 $anonymousActiveIds[] = $activeId;
             }
         }
         
         return $anonymousActiveIds;
     }

Here is the caller graph for this function:

◆ getAnonymousIds()

ilTestParticipantData::getAnonymousIds ( )

Definition at line 233 of file class.ilTestParticipantData.php.

     {
         return array_keys($this->byAnonymousId);
     }

◆ getAnonymousIdsFilter()

ilTestParticipantData::getAnonymousIdsFilter ( )

Definition at line 218 of file class.ilTestParticipantData.php.

References $anonymousIdsFilter.

Referenced by getConditionalExpression().

     {
         return $this->anonymousIdsFilter;
     }

Here is the caller graph for this function:

◆ getConcatedFullnameByActiveId()

ilTestParticipantData::getConcatedFullnameByActiveId ( $activeId )

Definition at line 248 of file class.ilTestParticipantData.php.

     {
         return "{$this->byActiveId[$activeId]['firstname']} {$this->byActiveId[$activeId]['lastname']}";
     }

◆ getConditionalExpression()

ilTestParticipantData::getConditionalExpression ( )

Definition at line 170 of file class.ilTestParticipantData.php.

References getActiveIdsFilter(), getAnonymousIdsFilter(), and getUserIdsFilter().

     {
         $conditions = array();
         
         if (count($this->getActiveIdsFilter())) {
             $conditions[] = $this->db->in('active_id', $this->getActiveIdsFilter(), false, 'integer');
         }
 
         if (count($this->getUserIdsFilter())) {
             $conditions[] = $this->db->in('user_fi', $this->getUserIdsFilter(), false, 'integer');
         }
 
         if (count($this->getAnonymousIdsFilter())) {
             $conditions[] = $this->db->in('anonymous_id', $this->getAnonymousIdsFilter(), false, 'integer');
         }
 
         if (count($conditions)) {
             return '(' . implode(' OR ', $conditions) . ')';
         }
 
         return '1 = 1';
     }

Here is the call graph for this function:

◆ getFileSystemCompliantFullnameByActiveId()

ilTestParticipantData::getFileSystemCompliantFullnameByActiveId ( $activeId )

Definition at line 258 of file class.ilTestParticipantData.php.

References ilUtil\getASCIIFilename().

Referenced by ilAssFileUploadUploadsExporter\collectUploadedFiles().

     {
         $fullname = str_replace(' ', '', $this->byActiveId[$activeId]['lastname']);
         $fullname .= '_' . str_replace(' ', '', $this->byActiveId[$activeId]['firstname']);
         $fullname .= '_' . $this->byActiveId[$activeId]['login'];
         
         return ilUtil::getASCIIFilename($fullname);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFormatedFullnameByActiveId()

ilTestParticipantData::getFormatedFullnameByActiveId ( $activeId )

Definition at line 253 of file class.ilTestParticipantData.php.

References buildFormatedFullname().

     {
         return $this->buildFormatedFullname($this->byActiveId[$activeId]);
     }

Here is the call graph for this function:

◆ getOptionArray()

ilTestParticipantData::getOptionArray ( )

Definition at line 267 of file class.ilTestParticipantData.php.

References PHPMailer\PHPMailer\$options, and buildFormatedFullname().

     {
         $options = array();
         
         foreach ($this->byActiveId as $activeId => $usrData) {
             $options[$activeId] = $this->buildFormatedFullname($usrData);
         }
         
         asort($options);
         
         return $options;
     }

Here is the call graph for this function:

◆ getParticipantAccessFilter()

ilTestParticipantData::getParticipantAccessFilter ( )

Returns: callable

Definition at line 82 of file class.ilTestParticipantData.php.

References $participantAccessFilter.

Referenced by load().

     {
         return $this->participantAccessFilter;
     }

Here is the caller graph for this function:

◆ getScoredParticipantsFilterExpression()

ilTestParticipantData::getScoredParticipantsFilterExpression ( )

Definition at line 161 of file class.ilTestParticipantData.php.

References isScoredParticipantsFilterEnabled().

     {
         if ($this->isScoredParticipantsFilterEnabled()) {
             return "ta.last_finished_pass = ta.last_started_pass";
         }
         
         return '1 = 1';
     }

Here is the call graph for this function:

◆ getUserDataByActiveId()

ilTestParticipantData::getUserDataByActiveId ( $activeId )

Definition at line 302 of file class.ilTestParticipantData.php.

     {
         if (isset($this->byActiveId[$activeId])) {
             return $this->byActiveId[$activeId];
         }
         
         return null;
     }

◆ getUserIdByActiveId()

ilTestParticipantData::getUserIdByActiveId ( $activeId )

Definition at line 238 of file class.ilTestParticipantData.php.

     {
         return $this->byActiveId[$activeId]['user_id'];
     }

◆ getUserIds()

ilTestParticipantData::getUserIds ( )

Definition at line 228 of file class.ilTestParticipantData.php.

Referenced by ilObjTest\removeTestResults().

     {
         return array_keys($this->byUserId);
     }

Here is the caller graph for this function:

◆ getUserIdsFilter()

ilTestParticipantData::getUserIdsFilter ( )

Definition at line 208 of file class.ilTestParticipantData.php.

References $userIdsFilter.

Referenced by getConditionalExpression().

     {
         return $this->userIdsFilter;
     }

Here is the caller graph for this function:

◆ isScoredParticipantsFilterEnabled()

ilTestParticipantData::isScoredParticipantsFilterEnabled ( )

Returns: bool

Definition at line 98 of file class.ilTestParticipantData.php.

References $scoredParticipantsFilterEnabled.

Referenced by getScoredParticipantsFilterExpression().

     {
         return $this->scoredParticipantsFilterEnabled;
     }

Here is the caller graph for this function:

◆ load()

ilTestParticipantData::load ( $testId )

Definition at line 111 of file class.ilTestParticipantData.php.

References $query, $res, $row, $rows, and getParticipantAccessFilter().

Referenced by ilTestCorrectionsGUI\performQuestionRemoval().

     {
         $this->byActiveId = array();
         $this->byUserId = array();
 
         $query = "
                         SELECT          ta.active_id,
                                                 ta.user_fi user_id,
                                                 ta.anonymous_id,
                                                 ud.firstname,
                                                 ud.lastname,
                                                 ud.login,
                                                 ud.matriculation
                         FROM            tst_active ta
                         LEFT JOIN       usr_data ud
                         ON                      ud.usr_id = ta.user_fi
                         WHERE           test_fi = %s
                         AND                     {$this->getConditionalExpression()}
                         AND             {$this->getScoredParticipantsFilterExpression()}
                 ";
         
         $res = $this->db->queryF($query, array('integer'), array($testId));
         
         $rows = array();
         $accessFilteredUsrIds = array();
         
         while ($row = $this->db->fetchAssoc($res)) {
             $accessFilteredUsrIds[] = $row['user_id'];
             $rows[] = $row;
         }
         
         if (is_callable($this->getParticipantAccessFilter(), true)) {
             $accessFilteredUsrIds = call_user_func_array($this->getParticipantAccessFilter(), [$accessFilteredUsrIds]);
         }
         
         foreach ($rows as $row) {
             if (!in_array($row['user_id'], $accessFilteredUsrIds)) {
                 continue;
             }
             
             $this->byActiveId[ $row['active_id'] ] = $row;
             
             if ($row['user_id'] == ANONYMOUS_USER_ID) {
                 $this->byAnonymousId[ $row['anonymous_id'] ] = $row;
             } else {
                 $this->byUserId[ $row['user_id'] ] = $row;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setActiveIdsFilter()

ilTestParticipantData::setActiveIdsFilter ( $activeIdsFilter )

Definition at line 193 of file class.ilTestParticipantData.php.

References $activeIdsFilter.

Referenced by ilTestAccess\checkAccessForActiveId().

     {
         $this->activeIdsFilter = $activeIdsFilter;
     }

Here is the caller graph for this function:

◆ setAnonymousIdsFilter()

ilTestParticipantData::setAnonymousIdsFilter ( $anonymousIdsFilter )

Definition at line 213 of file class.ilTestParticipantData.php.

References $anonymousIdsFilter.

     {
         $this->anonymousIdsFilter = $anonymousIdsFilter;
     }

◆ setParticipantAccessFilter()

ilTestParticipantData::setParticipantAccessFilter ( $participantAccessFilter )

Parameters

callable $participantAccessFilter

Definition at line 90 of file class.ilTestParticipantData.php.

References $participantAccessFilter.

Referenced by ilObjTest\addExtraTime(), ilParticipantsTestResultsGUI\confirmDeleteAllUserResultsCmd(), ilParticipantsTestResultsGUI\confirmDeleteSelectedUserDataCmd(), ilParticipantsTestResultsGUI\createUserResults(), and ilParticipantsTestResultsGUI\deleteSingleUserResultsCmd().

     {
         $this->participantAccessFilter = $participantAccessFilter;
     }

Here is the caller graph for this function:

◆ setScoredParticipantsFilterEnabled()

ilTestParticipantData::setScoredParticipantsFilterEnabled ( $scoredParticipantsFilterEnabled )

Parameters

bool $scoredParticipantsFilterEnabled

Definition at line 106 of file class.ilTestParticipantData.php.

References $scoredParticipantsFilterEnabled.

     {
         $this->scoredParticipantsFilterEnabled = $scoredParticipantsFilterEnabled;
     }

◆ setUserIdsFilter()

ilTestParticipantData::setUserIdsFilter ( $userIdsFilter )

Definition at line 203 of file class.ilTestParticipantData.php.

References $userIdsFilter.

     {
         $this->userIdsFilter = $userIdsFilter;
     }

Field Documentation

◆ $activeIdsFilter

ilTestParticipantData::$activeIdsFilter

private

Definition at line 26 of file class.ilTestParticipantData.php.

Referenced by getActiveIdsFilter(), and setActiveIdsFilter().

◆ $anonymousIdsFilter

ilTestParticipantData::$anonymousIdsFilter

private

Definition at line 36 of file class.ilTestParticipantData.php.

Referenced by getAnonymousIdsFilter(), and setAnonymousIdsFilter().

◆ $byActiveId

ilTestParticipantData::$byActiveId

private

Definition at line 41 of file class.ilTestParticipantData.php.

◆ $byAnonymousId

ilTestParticipantData::$byAnonymousId

private

Definition at line 51 of file class.ilTestParticipantData.php.

◆ $byUserId

ilTestParticipantData::$byUserId

private

Definition at line 46 of file class.ilTestParticipantData.php.

◆ $db

ilTestParticipantData::$db

protected

Definition at line 16 of file class.ilTestParticipantData.php.

Referenced by __construct().

◆ $lng

ilTestParticipantData::$lng

protected

Definition at line 21 of file class.ilTestParticipantData.php.

Referenced by __construct().

◆ $participantAccessFilter

ilTestParticipantData::$participantAccessFilter

protected

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

Referenced by getParticipantAccessFilter(), and setParticipantAccessFilter().

◆ $scoredParticipantsFilterEnabled

ilTestParticipantData::$scoredParticipantsFilterEnabled

protected

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

Referenced by isScoredParticipantsFilterEnabled(), and setScoredParticipantsFilterEnabled().

◆ $userIdsFilter

ilTestParticipantData::$userIdsFilter

private

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

Referenced by getUserIdsFilter(), and setUserIdsFilter().

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

Modules/Test/classes/class.ilTestParticipantData.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFormatedFullname()

◆ getActiveIdByUserId()

◆ getActiveIds()

◆ getActiveIdsFilter()

◆ getAnonymousActiveIds()

◆ getAnonymousIds()

◆ getAnonymousIdsFilter()

◆ getConcatedFullnameByActiveId()

◆ getConditionalExpression()

◆ getFileSystemCompliantFullnameByActiveId()

◆ getFormatedFullnameByActiveId()

◆ getOptionArray()

◆ getParticipantAccessFilter()

◆ getScoredParticipantsFilterExpression()

◆ getUserDataByActiveId()

◆ getUserIdByActiveId()

◆ getUserIds()

◆ getUserIdsFilter()

◆ isScoredParticipantsFilterEnabled()

◆ load()

◆ setActiveIdsFilter()

◆ setAnonymousIdsFilter()

◆ setParticipantAccessFilter()

◆ setScoredParticipantsFilterEnabled()

◆ setUserIdsFilter()

Field Documentation

◆ $activeIdsFilter

◆ $anonymousIdsFilter

◆ $byActiveId

◆ $byAnonymousId

◆ $byUserId

◆ $db

◆ $lng

◆ $participantAccessFilter

◆ $scoredParticipantsFilterEnabled

◆ $userIdsFilter