ilTestParticipantList Class Reference

Inheritance diagram for ilTestParticipantList:

Collaboration diagram for ilTestParticipantList:

Public Member Functions
	__construct (private ilObjTest $test_obj, private ilObjUser $user, private ilLanguage $lng, private ilDBInterface $db)
	setTestObj (ilObjTest $test_obj)
	addParticipant (ilTestParticipant $participant)
	getParticipantByUsrId (int $usr_id)
	getParticipantByActiveId ($active_id)
	hasUnfinishedPasses ()
	hasScorings ()
	getAllUserIds ()
	getAllActiveIds ()
	isActiveIdInList (int $active_id)
	getAccessFilteredList (Closure $user_access_filter)
	current ()
	next ()
	key ()
	valid ()
	rewind ()
	initializeFromDbRows (array $db_rows)
	getScoredParticipantList ()
	buildScoringsQuery ()
	getScoringTableRows ()
	getScoringsTableRows ()
	lookupNrOfTries (?int $active_id)

Protected Member Functions
	lookupLastAccess (?int $active_id)
	buildFullname (ilTestParticipant $participant)
	buildInviteeFullname (ilTestParticipant $participant)
	buildParticipantsFullname (ilTestParticipant $participant)

Protected Attributes
array	$participants = []

Private Member Functions
	getTestObj ()

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilTestParticipantList::__construct	(	private ilObjTest	$test_obj,
		private ilObjUser	$user,
		private ilLanguage	$lng,
		private ilDBInterface	$db
	)

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

      {
    }

Member Function Documentation

addParticipant()

ilTestParticipantList::addParticipant

(

ilTestParticipant

$participant

)

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

Referenced by initializeFromDbRows().

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

Here is the caller graph for this function:

buildFullname()

ilTestParticipantList::buildFullname ( ilTestParticipant  $participant )

protected

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

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

Referenced by getScoringsTableRows().

                                                                    : string
    {
        if ($this->getTestObj()->getMainSettings()->getAccessSettings()->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

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

References ilTestParticipant\getFirstname(), ilTestParticipant\getLastname(), getTestObj(), and ILIAS\Repository\lng().

Referenced by buildFullname().

                                                                           : string
    {
        if (strlen($participant->getFirstname() . $participant->getLastname()) == 0) {
            return $this->lng->txt("deleted_user");
        }

        if ($this->getTestObj()->getAnonymity()) {
            return $this->lng->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

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

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

Referenced by buildFullname().

                                                                                : string
    {
        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 231 of file class.ilTestParticipantList.php.

References getAllActiveIds().

Referenced by getScoredParticipantList().

                                        : string
    {
        $IN_activeIds = $this->db->in(
            'tres.active_fi',
            $this->getAllActiveIds(),
            false,
            'integer'
        );

        $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
                        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 155 of file class.ilTestParticipantList.php.

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

getAccessFilteredList()

ilTestParticipantList::getAccessFilteredList

(

Closure

$user_access_filter

)

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

References $lng, getAllUserIds(), and getTestObj().

                                                                      : ilTestParticipantList
    {
        $usr_ids = $user_access_filter($this->getAllUserIds());

        $access_filtered_list = new self($this->getTestObj(), $this->user, $this->lng, $this->db);

        foreach ($this as $participant) {
            if (in_array($participant->getUsrId(), $usr_ids)) {
                $participant = clone $participant;
                $access_filtered_list->addParticipant($participant);
            }
        }

        return $access_filtered_list;
    }

Here is the call graph for this function:

getAllActiveIds()

ilTestParticipantList::getAllActiveIds

(

)

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

Referenced by buildScoringsQuery().

                                     : array
    {
        $activeIds = [];

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

        return $activeIds;
    }

Here is the caller graph for this function:

getAllUserIds()

ilTestParticipantList::getAllUserIds

(

)

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

Referenced by getAccessFilteredList().

                                   : array
    {
        $usrIds = [];

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

        return $usrIds;
    }

Here is the caller graph for this function:

getParticipantByActiveId()

ilTestParticipantList::getParticipantByActiveId

(

$active_id

)

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

References null.

Referenced by getScoredParticipantList().

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

            return $participant;
        }
        return null;
    }

Here is the caller graph for this function:

getParticipantByUsrId()

ilTestParticipantList::getParticipantByUsrId

(

int

$usr_id

)

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

References null.

                                                      : ?ilTestParticipant
    {
        foreach ($this as $participant) {
            if ($participant->getUsrId() != $usr_id) {
                continue;
            }

            return $participant;
        }
        return null;
    }

getScoredParticipantList()

ilTestParticipantList::getScoredParticipantList

(

)

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

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

                                              : ilTestParticipantList
    {
        $scored_participant_list = new self($this->getTestObj(), $this->user, $this->lng, $this->db);

        $res = $this->db->query($this->buildScoringsQuery());

        while ($row = $this->db->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);

            $scored_participant_list->addParticipant(
                $this->getParticipantByActiveId($row['active_fi'])
            );
        }

        return $scored_participant_list;
    }

Here is the call graph for this function:

getScoringsTableRows()

ilTestParticipantList::getScoringsTableRows

(

)

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

References buildFullname().

                                          : array
    {
        $rows = [];

        foreach ($this as $participant) {
            if (!$participant->hasScoring()) {
                continue;
            }

            $row = [
                '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:

getScoringTableRows()

ilTestParticipantList::getScoringTableRows

(

)

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

                                         : array
    {
        $rows = [];

        foreach ($this as $participant) {
            $row = [
                'usr_id' => $participant->getUsrId(),
                'active_id' => $participant->getActiveId(),
                'login' => $participant->getLogin(),
                'firstname' => $participant->getFirstname(),
                'lastname' => $participant->getLastname()
            ];

            $rows[] = $row;
        }

        return $rows;
    }

getTestObj()

ilTestParticipantList::getTestObj ( )

private

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

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

                                 : ilObjTest
    {
        return $this->test_obj;
    }

Here is the caller graph for this function:

hasScorings()

ilTestParticipantList::hasScorings

(

)

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

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

        return false;
    }

hasUnfinishedPasses()

ilTestParticipantList::hasUnfinishedPasses

(

)

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

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

        return false;
    }

initializeFromDbRows()

ilTestParticipantList::initializeFromDbRows

(

array

$db_rows

)

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

References addParticipant().

                                                        : void
    {
        foreach ($db_rows as $row_data) {
            $participant = new ilTestParticipant();

            if ((int) $row_data['active_id']) {
                $participant->setActiveId((int) $row_data['active_id']);
            }

            $participant->setUsrId((int) $row_data['usr_id']);

            $participant->setLogin($row_data['login'] ?? '');
            $participant->setLastname($row_data['lastname']);
            $participant->setFirstname($row_data['firstname'] ?? '');
            $participant->setMatriculation($row_data['matriculation'] ?? '');
            $participant->setActiveStatus((bool) ($row_data['active'] ?? false));
            $participant->setFinishedTries((int) $row_data['tries']);
            $participant->setTestFinished((bool) $row_data['test_finished']);
            $participant->setUnfinishedPasses((bool) $row_data['unfinished_passes']);

            $this->addParticipant($participant);
        }
    }

Here is the call graph for this function:

isActiveIdInList()

ilTestParticipantList::isActiveIdInList

(

int

$active_id

)

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

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

        return false;
    }

key()

ilTestParticipantList::key

(

)

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

Referenced by valid().

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

Here is the caller graph for this function:

lookupLastAccess()

ilTestParticipantList::lookupLastAccess ( ?int  $active_id )

protected

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

References getTestObj(), and null.

                                                        : string
    {
        if ($active_id === null) {
            return '';
        }

        return $this->getTestObj()->_getLastAccess($active_id);
    }

Here is the call graph for this function:

lookupNrOfTries()

ilTestParticipantList::lookupNrOfTries

(

?int

$active_id

)

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

References ilObjTest\_getMaxPass(), and null.

                                                    : ?int
    {
        if ($active_id === null) {
            return null;
        }

        $max_pass_index = ilObjTest::_getMaxPass($active_id);

        if ($max_pass_index === null) {
            return null;
        }

        return $max_pass_index + 1;
    }

Here is the call graph for this function:

next()

ilTestParticipantList::next

(

)

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

                          : void
    {
        next($this->participants);
    }

rewind()

ilTestParticipantList::rewind

(

)

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

                            : void
    {
        reset($this->participants);
    }

setTestObj()

ilTestParticipantList::setTestObj

(

ilObjTest

$test_obj

)

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

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

valid()

ilTestParticipantList::valid

(

)

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

References key(), and null.

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

Here is the call graph for this function:

Field Documentation

$participants

array ilTestParticipantList::$participants = []

protected

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

---

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

• components/ILIAS/Test/classes/class.ilTestParticipantList.php