Inheritance diagram for ilTestParticipantList:

Collaboration diagram for ilTestParticipantList:

Public Member Functions
	__construct (ilObjTest $testObj)

	getTestObj ()

	setTestObj ($testObj)

	addParticipant (ilTestParticipant $participant)

	getParticipantByUsrId ($usrId)

	getParticipantByActiveId ($activeId)

	hasUnfinishedPasses ()

	hasScorings ()

	getAllUserIds ()

	getAllActiveIds ()

	isActiveIdInList ($activeId)

	getAccessFilteredList (callable $userAccessFilter)

	current ()

	next ()

	key ()

	valid ()

	rewind ()

	initializeFromDbRows ($dbRows)

	getScoredParticipantList ()

	buildScoringsQuery ()

	getParticipantsTableRows ()

	getScoringsTableRows ()

	lookupNrOfTries ($activeId)

Protected Member Functions
	lookupLastAccess ($activeId)

	buildFullname (ilTestParticipant $participant)

	buildInviteeFullname (ilTestParticipant $participant)

	buildParticipantsFullname (ilTestParticipant $participant)

Protected Attributes
	$participants = array()

	$testObj

Detailed Description

Definition at line 27 of file class.ilTestParticipantList.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestParticipantList::__construct ( ilObjTest $testObj )

Parameters

ilObjTest $testObj

Definition at line 42 of file class.ilTestParticipantList.php.

References $testObj.

     {
         $this->testObj = $testObj;
     }

Member Function Documentation

◆ addParticipant()

ilTestParticipantList::addParticipant ( ilTestParticipant $participant )

Parameters

ilTestParticipant $participant

Definition at line 66 of file class.ilTestParticipantList.php.

Referenced by initializeFromDbRows().

     {
         $this->participants[] = $participant;
     }

Here is the caller graph for this function:

◆ buildFullname()

ilTestParticipantList::buildFullname ( ilTestParticipant $participant )

protected

Parameters

ilTestParticipant $participant

Returns: string

Definition at line 400 of file class.ilTestParticipantList.php.

References buildInviteeFullname(), buildParticipantsFullname(), ilTestParticipant\getActiveId(), and getTestObj().

Referenced by getParticipantsTableRows(), and getScoringsTableRows().

                                                                     : string
     {
         if ($this->getTestObj()->getFixedParticipants() && !$participant->getActiveId()) {
             return $this->buildInviteeFullname($participant);
         }
 
         return $this->buildParticipantsFullname($participant);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildInviteeFullname()

ilTestParticipantList::buildInviteeFullname ( ilTestParticipant $participant )

protected

Parameters

ilTestParticipant $participant

Returns: string

Definition at line 413 of file class.ilTestParticipantList.php.

References $DIC, ilTestParticipant\getFirstname(), ilTestParticipant\getLastname(), and getTestObj().

Referenced by buildFullname().

                                                                            : string
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         if (strlen($participant->getFirstname() . $participant->getLastname()) == 0) {
             return $DIC->language()->txt("deleted_user");
         }
 
         if ($this->getTestObj()->getAnonymity()) {
             return $DIC->language()->txt('anonymous');
         }
 
         return trim($participant->getLastname() . ", " . $participant->getFirstname());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildParticipantsFullname()

ilTestParticipantList::buildParticipantsFullname ( ilTestParticipant $participant )

protected

Parameters

ilTestParticipant $participant

Returns: string

Definition at line 432 of file class.ilTestParticipantList.php.

References ilObjTestAccess\_getParticipantData(), and ilTestParticipant\getActiveId().

Referenced by buildFullname().

                                                                                 : string
     {
         require_once 'Modules/Test/classes/class.ilObjTestAccess.php';
         return ilObjTestAccess::_getParticipantData($participant->getActiveId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildScoringsQuery()

ilTestParticipantList::buildScoringsQuery ( )

Definition at line 264 of file class.ilTestParticipantList.php.

References $DIC, $query, getAllActiveIds(), and getTestObj().

Referenced by getScoredParticipantList().

                                         : string
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $IN_activeIds = $DIC->database()->in(
             'tres.active_fi',
             $this->getAllActiveIds(),
             false,
             'integer'
         );
 
         if (false && !$this->getTestObj()->isDynamicTest()) { // BH: keep for the moment
             $closedScoringsOnly = "
                                 INNER JOIN tst_active tact
                                 ON tact.active_id = tres.active_fi
                                 AND tact.last_finished_pass = tact.last_started_pass
                         ";
         } else {
             $closedScoringsOnly = '';
         }
 
         $query = "
                         SELECT * FROM tst_result_cache tres
 
                         INNER JOIN tst_pass_result pres
                         ON pres.active_fi = tres.active_fi
                         AND pres.pass = tres.pass
 
                         $closedScoringsOnly
 
                         WHERE $IN_activeIds
                 ";
 
         return $query;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ current()

ilTestParticipantList::current ( )

Definition at line 172 of file class.ilTestParticipantList.php.

     {
         return current($this->participants);
     }

◆ getAccessFilteredList()

ilTestParticipantList::getAccessFilteredList ( callable $userAccessFilter )

Definition at line 156 of file class.ilTestParticipantList.php.

References getAllUserIds(), and getTestObj().

                                                                      : ilTestParticipantList
     {
         $usrIds = call_user_func_array($userAccessFilter, [$this->getAllUserIds()]);
 
         $accessFilteredList = new self($this->getTestObj());
 
         foreach ($this as $participant) {
             if (in_array($participant->getUsrId(), $usrIds)) {
                 $participant = clone $participant;
                 $accessFilteredList->addParticipant($participant);
             }
         }
 
         return $accessFilteredList;
     }

Here is the call graph for this function:

◆ getAllActiveIds()

ilTestParticipantList::getAllActiveIds ( )

Definition at line 134 of file class.ilTestParticipantList.php.

Referenced by buildScoringsQuery().

                                      : array
     {
         $activeIds = array();
 
         foreach ($this as $participant) {
             $activeIds[] = $participant->getActiveId();
         }
 
         return $activeIds;
     }

Here is the caller graph for this function:

◆ getAllUserIds()

ilTestParticipantList::getAllUserIds ( )

Definition at line 123 of file class.ilTestParticipantList.php.

Referenced by getAccessFilteredList().

                                    : array
     {
         $usrIds = array();
 
         foreach ($this as $participant) {
             $usrIds[] = $participant->getUsrId();
         }
 
         return $usrIds;
     }

Here is the caller graph for this function:

◆ getParticipantByActiveId()

ilTestParticipantList::getParticipantByActiveId ( $activeId )

Definition at line 83 of file class.ilTestParticipantList.php.

Referenced by getScoredParticipantList().

                                                        : ?ilTestParticipant
     {
         foreach ($this as $participant) {
             if ($participant->getActiveId() != $activeId) {
                 continue;
             }
 
             return $participant;
         }
         return null;
     }

Here is the caller graph for this function:

◆ getParticipantByUsrId()

ilTestParticipantList::getParticipantByUsrId ( $usrId )

Definition at line 71 of file class.ilTestParticipantList.php.

     {
         foreach ($this as $participant) {
             if ($participant->getUsrId() != $usrId) {
                 continue;
             }
 
             return $participant;
         }
         return null;
     }

◆ getParticipantsTableRows()

ilTestParticipantList::getParticipantsTableRows ( )

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

References $rows, buildFullname(), lookupLastAccess(), and lookupNrOfTries().

                                               : array
     {
         $rows = array();
 
         foreach ($this as $participant) {
             $row = array(
                 'usr_id' => $participant->getUsrId(),
                 'active_id' => $participant->getActiveId(),
                 'login' => $participant->getLogin(),
                 'clientip' => $participant->getClientIp(),
                 'firstname' => $participant->getFirstname(),
                 'lastname' => $participant->getLastname(),
                 'name' => $this->buildFullname($participant),
                 'started' => ($participant->getActiveId() > 0) ? 1 : 0,
                 'unfinished' => $participant->hasUnfinishedPasses() ? 1 : 0,
                 'finished' => $participant->isTestFinished() ? 1 : 0,
                 'access' => $this->lookupLastAccess($participant->getActiveId()),
                 'tries' => $this->lookupNrOfTries($participant->getActiveId())
             );
 
             $rows[] = $row;
         }
 
         return $rows;
     }

Here is the call graph for this function:

◆ getScoredParticipantList()

ilTestParticipantList::getScoredParticipantList ( )

Returns: ilTestParticipantList

Definition at line 229 of file class.ilTestParticipantList.php.

References $DIC, $res, buildScoringsQuery(), getParticipantByActiveId(), and getTestObj().

                                               : ilTestParticipantList
     {
         require_once 'Modules/Test/classes/class.ilTestParticipantScoring.php';
 
         $scoredParticipantList = new self($this->getTestObj());
 
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         $res = $DIC->database()->query($this->buildScoringsQuery());
 
         while ($row = $DIC->database()->fetchAssoc($res)) {
             $scoring = new ilTestParticipantScoring();
 
             $scoring->setActiveId((int) $row['active_fi']);
             $scoring->setScoredPass((int) $row['pass']);
 
             $scoring->setAnsweredQuestions((int) $row['answeredquestions']);
             $scoring->setTotalQuestions((int) $row['questioncount']);
 
             $scoring->setReachedPoints((float) $row['reached_points']);
             $scoring->setMaxPoints((float) $row['max_points']);
 
             $scoring->setPassed((bool) $row['passed']);
             $scoring->setFinalMark((string) $row['mark_short']);
 
             $this->getParticipantByActiveId($row['active_fi'])->setScoring($scoring);
 
             $scoredParticipantList->addParticipant(
                 $this->getParticipantByActiveId($row['active_fi'])
             );
         }
 
         return $scoredParticipantList;
     }

Here is the call graph for this function:

◆ getScoringsTableRows()

ilTestParticipantList::getScoringsTableRows ( )

Definition at line 326 of file class.ilTestParticipantList.php.

References $rows, buildFullname(), and ilObjTest\lookupLastTestPassAccess().

                                           : array
     {
         $rows = array();
 
         foreach ($this as $participant) {
             if (!$participant->hasScoring()) {
                 continue;
             }
 
             $row = array(
                 'usr_id' => $participant->getUsrId(),
                 'active_id' => $participant->getActiveId(),
                 'login' => $participant->getLogin(),
                 'firstname' => $participant->getFirstname(),
                 'lastname' => $participant->getLastname(),
                 'name' => $this->buildFullname($participant)
             );
 
             if ($participant->getScoring()) {
                 $row['scored_pass'] = $participant->getScoring()->getScoredPass();
                 $row['answered_questions'] = $participant->getScoring()->getAnsweredQuestions();
                 $row['total_questions'] = $participant->getScoring()->getTotalQuestions();
                 $row['reached_points'] = $participant->getScoring()->getReachedPoints();
                 $row['max_points'] = $participant->getScoring()->getMaxPoints();
                 $row['percent_result'] = $participant->getScoring()->getPercentResult();
                 $row['passed_status'] = $participant->getScoring()->isPassed();
                 $row['final_mark'] = $participant->getScoring()->getFinalMark();
                 $row['scored_pass_finished_timestamp'] = ilObjTest::lookupLastTestPassAccess(
                     $participant->getActiveId(),
                     $participant->getScoring()->getScoredPass()
                 );
                 $row['finished_passes'] = $participant->getFinishedTries();
                 $row['has_unfinished_passes'] = $participant->hasUnfinishedPasses();
             }
 
             $rows[] = $row;
         }
 
         return $rows;
     }

Here is the call graph for this function:

◆ getTestObj()

ilTestParticipantList::getTestObj ( )

Returns: ilObjTest

Definition at line 50 of file class.ilTestParticipantList.php.

References $testObj.

Referenced by buildFullname(), buildInviteeFullname(), buildScoringsQuery(), getAccessFilteredList(), getScoredParticipantList(), and lookupLastAccess().

                                 : ilObjTest
     {
         return $this->testObj;
     }

Here is the caller graph for this function:

◆ hasScorings()

ilTestParticipantList::hasScorings ( )

Returns: bool

Definition at line 112 of file class.ilTestParticipantList.php.

                                  : bool
     {
         foreach ($this as $participant) {
             if ($participant->getScoring() instanceof ilTestParticipantScoring) {
                 return true;
             }
         }
 
         return false;
     }

◆ hasUnfinishedPasses()

ilTestParticipantList::hasUnfinishedPasses ( )

Returns: bool

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

Referenced by ilTestParticipantsGUI\initToolbarControls().

                                          : bool
     {
         foreach ($this as $participant) {
             if ($participant->hasUnfinishedPasses()) {
                 return true;
             }
         }
 
         return false;
     }

Here is the caller graph for this function:

◆ initializeFromDbRows()

ilTestParticipantList::initializeFromDbRows ( $dbRows )

Parameters

array[] $dbRows

Definition at line 196 of file class.ilTestParticipantList.php.

References addParticipant().

     {
         foreach ($dbRows as $rowKey => $rowData) {
             $participant = new ilTestParticipant();
 
             if ((int) $rowData['active_id']) {
                 $participant->setActiveId((int) $rowData['active_id']);
             }
 
             $participant->setUsrId((int) $rowData['usr_id']);
 
             $participant->setLogin($rowData['login']);
             $participant->setLastname($rowData['lastname']);
             $participant->setFirstname($rowData['firstname']);
             $participant->setMatriculation($rowData['matriculation']);
 
             $participant->setActiveStatus((bool) ($rowData['active'] ?? false));
 
             if (isset($rowData['clientip'])) {
                 $participant->setClientIp($rowData['clientip']);
             }
 
             $participant->setFinishedTries((int) $rowData['tries']);
             $participant->setTestFinished((bool) $rowData['test_finished']);
             $participant->setUnfinishedPasses((bool) $rowData['unfinished_passes']);
 
             $this->addParticipant($participant);
         }
     }

Here is the call graph for this function:

◆ isActiveIdInList()

ilTestParticipantList::isActiveIdInList ( $activeId )

Definition at line 145 of file class.ilTestParticipantList.php.

                                                : bool
     {
         foreach ($this as $participant) {
             if ($participant->getActiveId() == $activeId) {
                 return true;
             }
         }
 
         return false;
     }

◆ key()

ilTestParticipantList::key ( )

Definition at line 180 of file class.ilTestParticipantList.php.

Referenced by valid().

     {
         return key($this->participants);
     }

Here is the caller graph for this function:

◆ lookupLastAccess()

ilTestParticipantList::lookupLastAccess ( $activeId )

protected

Parameters

integer $activeId

Returns: string

Definition at line 387 of file class.ilTestParticipantList.php.

References getTestObj().

Referenced by getParticipantsTableRows().

                                                   : string
     {
         if (!$activeId) {
             return '';
         }
 
         return $this->getTestObj()->_getLastAccess($activeId);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupNrOfTries()

ilTestParticipantList::lookupNrOfTries ( $activeId )

Parameters

integer $activeId

Returns: int|null

Definition at line 371 of file class.ilTestParticipantList.php.

References ilObjTest\_getMaxPass().

Referenced by getParticipantsTableRows().

                                               : ?int
     {
         $maxPassIndex = ilObjTest::_getMaxPass($activeId);
 
         if ($maxPassIndex !== null) {
             $nrOfTries = $maxPassIndex + 1;
             return $nrOfTries;
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ next()

ilTestParticipantList::next ( )

Definition at line 176 of file class.ilTestParticipantList.php.

     {
         return next($this->participants);
     }

◆ rewind()

ilTestParticipantList::rewind ( )

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

     {
         return reset($this->participants);
     }

◆ setTestObj()

ilTestParticipantList::setTestObj ( $testObj )

Parameters

ilObjTest $testObj

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

References $testObj.

     {
         $this->testObj = $testObj;
     }

◆ valid()

ilTestParticipantList::valid ( )

Definition at line 184 of file class.ilTestParticipantList.php.

References key().

                            : bool
     {
         return key($this->participants) !== null;
     }

Here is the call graph for this function:

Field Documentation

◆ $participants

ilTestParticipantList::$participants = array()

protected

Definition at line 32 of file class.ilTestParticipantList.php.

◆ $testObj

ilTestParticipantList::$testObj

protected

Definition at line 37 of file class.ilTestParticipantList.php.

Referenced by __construct(), getTestObj(), and setTestObj().

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

Modules/Test/classes/class.ilTestParticipantList.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addParticipant()

◆ buildFullname()

◆ buildInviteeFullname()

◆ buildParticipantsFullname()

◆ buildScoringsQuery()

◆ current()

◆ getAccessFilteredList()

◆ getAllActiveIds()

◆ getAllUserIds()

◆ getParticipantByActiveId()

◆ getParticipantByUsrId()

◆ getParticipantsTableRows()

◆ getScoredParticipantList()

◆ getScoringsTableRows()

◆ getTestObj()

◆ hasScorings()

◆ hasUnfinishedPasses()

◆ initializeFromDbRows()

◆ isActiveIdInList()

◆ key()

◆ lookupLastAccess()

◆ lookupNrOfTries()

◆ next()

◆ rewind()

◆ setTestObj()

◆ valid()

Field Documentation

◆ $participants

◆ $testObj