Collaboration diagram for ILIAS\Test\Participants\ParticipantRepository:

Public Member Functions
	__construct (private readonly \ilDBInterface $database)

	countParticipants (int $test_id, ?array $filter)

	getParticipants (int $test_id, ?array $filter=null, ?Range $range=null, ?Order $order=null)

	getParticipantByActiveId (int $test_id, int $active_id)

	getParticipantByUserId (int $test_id, int $user_id)

	updateExtraTime (Participant $participant)

	updateIpRange (array $participants)

	lookupTestIdByActiveId (int $active_id)

	removeParticipants (array $selected_participants)

	getFirstAndLastVisitForActiveId (int $active_id)

	removeExtraTimeByUserId (int $test_id, array $user_ids)

Private Member Functions
	fetchParticipant (string $query, array $types, array $values)

	applyFilter (?array $filter, array $where, array $types, array $values)

	applyOrder (?Order $order)

	isFilterSet (array $filter, string $key)

	getBaseQuery ()

	arrayToObject (array $row)

	getActiveParticipantsQuery ()

	getInvitedParticipantsQuery ()

Detailed Description

Definition at line 26 of file ParticipantRepository.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Participants\ParticipantRepository::__construct ( private readonly \ilDBInterface $database )

Definition at line 28 of file ParticipantRepository.php.

30 {

31 }

Member Function Documentation

◆ applyFilter()

ILIAS\Test\Participants\ParticipantRepository::applyFilter	(	?array	$filter,
		array	$where,
		array	$types,
		array	$values
	)

private

Parameters

array<string,mixed>	$filter
array<int,string>	$where
array<int,string>	$types
array<int,mixed>	$values

Returns: array

Definition at line 245 of file ParticipantRepository.php.

References ILIAS\Test\Participants\ParticipantRepository\isFilterSet().

Referenced by ILIAS\Test\Participants\ParticipantRepository\countParticipants(), and ILIAS\Test\Participants\ParticipantRepository\getParticipants().

      : array {
         if ($filter === null) {
             return [$where, $types, $values];
         }
 
         if ($this->isFilterSet($filter, 'name')) {
             $where[] = '(firstname LIKE %s OR lastname LIKE %s)';
             $types = array_merge($types, ['string', 'string']);
             $values = array_merge($values, ["%{$filter['name']}%", "%{$filter['name']}%"]);
         }
 
         if ($this->isFilterSet($filter, 'login')) {
             $where[] = '(login LIKE %s)';
             $types = array_merge($types, ['string']);
             $values = array_merge($values, ["%{$filter['login']}%"]);
         }
 
         if ($this->isFilterSet($filter, 'extra_time')) {
             if ($filter['extra_time'] === 'true') {
                 $where[] = '(extra_time > 0 AND extra_time IS NOT NULL)';
             } else {
                 $where[] = '(extra_time = 0 OR extra_time IS NULL)';
             }
         }
 
         if ($this->isFilterSet($filter, 'ip_range')) {
             $where[] = '(ip_range_from LIKE %s OR ip_range_to LIKE %s)';
             $types = array_merge($types, ['string', 'string']);
             $values = array_merge($values, ["%{$filter['ip_range']}%", "%{$filter['ip_range']}%"]);
         }
 
         return [$where, $types, $values];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyOrder()

ILIAS\Test\Participants\ParticipantRepository::applyOrder ( ?Order $order )

private

Definition at line 284 of file ParticipantRepository.php.

References ILIAS\Data\Order\get().

Referenced by ILIAS\Test\Participants\ParticipantRepository\getParticipants().

                                               : string
     {
         if ($order === null) {
             return '';
         }
         $order_by = [];
         foreach ($order->get() as $subject => $direction) {
             $order_by[] = match ($subject) {
                 'name' => "lastname {$direction}, firstname {$direction}",
                 'login' => "login {$direction}",
                 'ip_range' => "ip_range_from {$direction}, ip_range_to {$direction}",
                 'total_attempts' => "tries {$direction}",
                 'extra_time' => "extra_time {$direction}",
                 default => null
             };
         }
         return trim(join(', ', array_filter($order_by)));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ arrayToObject()

ILIAS\Test\Participants\ParticipantRepository::arrayToObject ( array $row )

private

Definition at line 321 of file ParticipantRepository.php.

Referenced by ILIAS\Test\Participants\ParticipantRepository\fetchParticipant(), and ILIAS\Test\Participants\ParticipantRepository\getParticipants().

                                               : Participant
     {
         return new Participant(
             $row['user_fi'],
             $row['active_id'],
             $row['test_fi'],
             $row['anonymous_id'],
             $row['firstname'] ?? '',
             $row['lastname'] ?? '',
             $row['login'] ?? '',
             $row['matriculation'] ?? '',
             $row['extra_time'] ?? 0,
             $row['tries'] ?? 0,
             $row['ip_range_from'],
             $row['ip_range_to'],
             $row['invitation_date'],
             $row['submitted'] === 1,
             $row['last_started_pass'],
             $row['last_finished_pass'],
             $row['unfinished_attempts'] === 1,
             $row['first_access'] === null ? null : new \DateTimeImmutable($row['first_access']),
             $row['last_access'] === null ? null : new \DateTimeImmutable($row['last_access'])
         );
     }

Here is the caller graph for this function:

◆ countParticipants()

ILIAS\Test\Participants\ParticipantRepository::countParticipants	(	int	$test_id,
		?array	$filter
	)

Parameters

int	$test_id
	array<string,mixed>	$filter

Returns: int

Definition at line 39 of file ParticipantRepository.php.

References ILIAS\Test\Participants\ParticipantRepository\applyFilter().

                                                                    : int
     {
         $query = "
             SELECT COUNT(participants.user_fi) as number_of_participants
             FROM (
                 ({$this->getActiveParticipantsQuery()})
                 UNION
                 ({$this->getInvitedParticipantsQuery()})
             ) participants
                 ";
         [$where, $types, $values] = $this->applyFilter($filter, [], ['integer', 'integer'], [$test_id, $test_id]);
 
         if (!empty($where)) {
             $where = join(' AND ', $where);
             $query .= " WHERE $where";
         }
 
         $statement = $this->database->queryF($query, $types, $values);
         $result = $this->database->fetchAssoc($statement);
 
         return $result['number_of_participants'] ?? 0;
     }

Here is the call graph for this function:

◆ fetchParticipant()

ILIAS\Test\Participants\ParticipantRepository::fetchParticipant	(	string	$query,
		array	$types,
		array	$values
	)

private

Parameters

array<int,string>	$types
array<int,mixed>	$values

Definition at line 225 of file ParticipantRepository.php.

References ILIAS\Test\Participants\ParticipantRepository\arrayToObject().

Referenced by ILIAS\Test\Participants\ParticipantRepository\getParticipantByActiveId(), and ILIAS\Test\Participants\ParticipantRepository\getParticipantByUserId().

                                                                                  : ?Participant
     {
         $statement = $this->database->queryF($query, $types, $values);
         $row = $this->database->fetchAssoc($statement);
 
         if (!$row) {
             return null;
         }
 
         return $this->arrayToObject($row);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveParticipantsQuery()

ILIAS\Test\Participants\ParticipantRepository::getActiveParticipantsQuery ( )

private

Returns: string

Definition at line 349 of file ParticipantRepository.php.

                                                  : string
     {
         return "
             SELECT      ta.active_id,
                                                 ta.user_fi,
                                                 ta.test_fi,
                                                 ta.anonymous_id,
                                                 ta.tries,
                                                 ta.submitted,
                                                 ta.last_finished_pass,
                                                 ta.last_started_pass,
                                                 COALESCE(ta.last_started_pass, -1) <> COALESCE(ta.last_finished_pass, -1) as unfinished_attempts,
                                                 ud.firstname,
                                                 ud.lastname,
                                                 ud.login,
                                                 ud.matriculation,
                         (SELECT MIN(started) FROM tst_times WHERE active_fi = ta.active_id) as first_access,
                                                 (SELECT MAX(finished) FROM tst_times WHERE active_fi = ta.active_id) as last_access,
                                                 tatime.additionaltime extra_time,
                                     tinvited.ip_range_from,
                                     tinvited.ip_range_to,
                         tinvited.tstamp as invitation_date
                         FROM            tst_active ta
                         LEFT JOIN       usr_data ud
                         ON                      ud.usr_id = ta.user_fi
                         LEFT JOIN   tst_addtime tatime
                         ON                      tatime.user_fi = ta.user_fi
             AND         tatime.test_fi = ta.test_fi
             LEFT JOIN   tst_invited_user tinvited
                         ON          tinvited.test_fi = ta.test_fi
             AND         tinvited.user_fi = ta.user_fi
                         WHERE           ta.test_fi = %s
         ";
     }

◆ getBaseQuery()

ILIAS\Test\Participants\ParticipantRepository::getBaseQuery ( )

private

Definition at line 309 of file ParticipantRepository.php.

Referenced by ILIAS\Test\Participants\ParticipantRepository\getParticipants().

                                    : string
     {
         return "
             SELECT particpants.*
             FROM (
                 ({$this->getActiveParticipantsQuery()})
                 UNION
                 ({$this->getInvitedParticipantsQuery()})
             ) as particpants
         ";
     }

Here is the caller graph for this function:

◆ getFirstAndLastVisitForActiveId()

ILIAS\Test\Participants\ParticipantRepository::getFirstAndLastVisitForActiveId ( int $active_id )

Definition at line 197 of file ParticipantRepository.php.

                                                                    : array
     {
         $times = $this->database->fetchAssoc(
             $this->database->queryF(
                 'SELECT MIN(started) AS first_access, MAX(finished) AS last_access '
                     . 'FROM tst_times WHERE active_fi = %s',
                 ['integer'],
                 [$active_id]
             )
         );
 
         $start_time = null;
         if ($times['first_access'] !== null) {
             $start_time = new \DateTimeImmutable($times['first_access']);
         }
 
         $end_time = null;
         if ($times['last_access'] !== null) {
             $end_time = new \DateTimeImmutable($times['last_access']);
         }
 
         return ['first_access' => $start_time, 'last_access' => $end_time];
     }

◆ getInvitedParticipantsQuery()

ILIAS\Test\Participants\ParticipantRepository::getInvitedParticipantsQuery ( )

private

Returns: string

Definition at line 387 of file ParticipantRepository.php.

                                                   : string
     {
         return "
             SELECT      ta.active_id,
                                                 tinvited.user_fi,
                                                 tinvited.test_fi,
                                                 ta.anonymous_id,
                                                 ta.tries,
                                                 ta.submitted,
                                                 ta.last_finished_pass,
                                                 ta.last_started_pass,
                                                 COALESCE(ta.last_started_pass, -1) <> COALESCE(ta.last_finished_pass, -1) as unfinished_attempts,
                                                 ud.firstname,
                                                 ud.lastname,
                                                 ud.login,
                                                 ud.matriculation,
                         NULL as first_access,
                         NULL as last_access,
                                                 tatime.additionaltime extra_time,
                                     tinvited.ip_range_from,
                                     tinvited.ip_range_to,
                         tinvited.tstamp as invitation_date
                         FROM            tst_invited_user tinvited
                         LEFT JOIN       usr_data ud
                         ON                      ud.usr_id = tinvited.user_fi
                         LEFT JOIN   tst_addtime tatime
                         ON                      tatime.user_fi = tinvited.user_fi
             AND         tatime.test_fi = tinvited.test_fi
             LEFT JOIN   tst_active ta
                         ON          tinvited.test_fi = ta.test_fi
             AND         tinvited.user_fi = ta.user_fi
                         WHERE           tinvited.test_fi = %s AND ta.active_id IS NULL
         ";
     }

◆ getParticipantByActiveId()

ILIAS\Test\Participants\ParticipantRepository::getParticipantByActiveId	(	int	$test_id,
		int	$active_id
	)

Definition at line 100 of file ParticipantRepository.php.

References ILIAS\Test\Participants\ParticipantRepository\fetchParticipant().

                                                                           : ?Participant
     {
         return $this->fetchParticipant(
             "{$this->getBaseQuery()} WHERE active_id = %s",
             ['integer', 'integer', 'integer'],
             [$test_id, $test_id, $active_id]
         );
     }

Here is the call graph for this function:

◆ getParticipantByUserId()

ILIAS\Test\Participants\ParticipantRepository::getParticipantByUserId	(	int	$test_id,
		int	$user_id
	)

Definition at line 109 of file ParticipantRepository.php.

References ILIAS\Test\Participants\ParticipantRepository\fetchParticipant().

                                                                       : ?Participant
     {
         return $this->fetchParticipant(
             "{$this->getBaseQuery()} WHERE user_fi = %s",
             ['integer', 'integer', 'integer'],
             [$test_id, $test_id, $user_id]
         );
     }

Here is the call graph for this function:

◆ getParticipants()

ILIAS\Test\Participants\ParticipantRepository::getParticipants	(	int	$test_id,
		?array	$filter = `null`,
		?Range	$range = `null`,
		?Order	$order = `null`
	)

Parameters

array<string,mixed> $filter

Definition at line 65 of file ParticipantRepository.php.

References ILIAS\UI\Implementation\Component\Table\$range, ILIAS\Test\Participants\ParticipantRepository\applyFilter(), ILIAS\Test\Participants\ParticipantRepository\applyOrder(), ILIAS\Test\Participants\ParticipantRepository\arrayToObject(), and ILIAS\Test\Participants\ParticipantRepository\getBaseQuery().

      : \Generator {
         $query = $this->getBaseQuery();
         [$where, $types, $values] = $this->applyFilter(
             $filter,
             [],
             ['integer', 'integer'],
             [$test_id, $test_id]
         );
 
         if ($where !== []) {
             $where = join(' AND ', $where);
             $query .= " WHERE {$where}";
         }
 
         $order_by = $this->applyOrder($order);
 
         if ($order_by !== '') {
             $query .= " ORDER BY {$order_by}";
         }
         if ($range !== null) {
             $query .= " LIMIT {$range->getStart()}, {$range->getLength()}";
         }
 
         $statement = $this->database->queryF($query, $types, $values);
 
         while ($row = $this->database->fetchAssoc($statement)) {
             yield $this->arrayToObject($row);
         }
     }

Here is the call graph for this function:

◆ isFilterSet()

ILIAS\Test\Participants\ParticipantRepository::isFilterSet	(	array	$filter,
		string	$key
	)

private

Definition at line 303 of file ParticipantRepository.php.

Referenced by ILIAS\Test\Participants\ParticipantRepository\applyFilter().

                                                             : bool
     {
         return isset($filter[$key]) && trim($filter[$key]) !== "";
     }

Here is the caller graph for this function:

◆ lookupTestIdByActiveId()

ILIAS\Test\Participants\ParticipantRepository::lookupTestIdByActiveId ( int $active_id )

Definition at line 149 of file ParticipantRepository.php.

References ILIAS\Repository\int().

                                                           : int
     {
         $result = $this->database->queryF(
             'SELECT test_fi FROM tst_active WHERE active_id = %s',
             ['integer'],
             [$active_id]
         );
         $test_id = -1;
         if ($this->database->numRows($result) > 0) {
             $row = $this->database->fetchAssoc($result);
             $test_id = (int) $row['test_fi'];
         }
 
         return $test_id;
     }

Here is the call graph for this function:

◆ removeExtraTimeByUserId()

ILIAS\Test\Participants\ParticipantRepository::removeExtraTimeByUserId	(	int	$test_id,
		array	$user_ids
	)

Definition at line 422 of file ParticipantRepository.php.

References ilDBConstants\T_INTEGER.

                                                                           : void
     {
         $in_user_fis = $this->database->in(
             'user_fi',
             $user_ids,
             false,
             \ilDBConstants::T_INTEGER,
         );
         $this->database->manipulate("DELETE FROM tst_addtime WHERE test_fi = $test_id AND $in_user_fis");
     }

◆ removeParticipants()

ILIAS\Test\Participants\ParticipantRepository::removeParticipants ( array $selected_participants )

Parameters

array<Participant> $selected_participants

Definition at line 169 of file ParticipantRepository.php.

References ILIAS\Test\Participants\Participant\getUserId(), and ilDBConstants\T_INTEGER.

                                                                     : void
     {
         $this->database->manipulate(
             "DELETE FROM tst_invited_user WHERE test_fi = {$selected_participants[0]->getTestId()} AND "
                 . $this->database->in(
                     'user_fi',
                     array_map(
                         fn(Participant $participant): int => $participant->getUserId(),
                         $selected_participants
                     ),
                     false,
                     \ilDBConstants::T_INTEGER
                 )
         );
         $this->database->manipulate(
             "DELETE FROM tst_addtime WHERE test_fi = {$selected_participants[0]->getTestId()} AND "
                 . $this->database->in(
                     'user_fi',
                     array_map(
                         fn(Participant $participant): int => $participant->getUserId(),
                         $selected_participants
                     ),
                     false,
                     \ilDBConstants::T_INTEGER
                 )
         );
     }

Here is the call graph for this function:

◆ updateExtraTime()

ILIAS\Test\Participants\ParticipantRepository::updateExtraTime ( Participant $participant )

Definition at line 118 of file ParticipantRepository.php.

References ILIAS\Test\Participants\Participant\getExtraTime(), ILIAS\Test\Participants\Participant\getTestId(), and ILIAS\Test\Participants\Participant\getUserId().

                                                              : void
     {
         $this->database->manipulatef(
             "INSERT INTO tst_addtime (user_fi, test_fi, additionaltime, tstamp) VALUES (%s, %s, %s, %s)
                         ON DUPLICATE KEY UPDATE tstamp = %s, additionaltime = %s",
             ['integer', 'integer', 'integer','timestamp','timestamp', 'integer'],
             [$participant->getUserId(), $participant->getTestId(), $participant->getExtraTime(), time(), time(), $participant->getExtraTime()]
         );
     }

Here is the call graph for this function:

◆ updateIpRange()

ILIAS\Test\Participants\ParticipantRepository::updateIpRange ( array $participants )

Parameters

array<Participant> $participants

Definition at line 131 of file ParticipantRepository.php.

References ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

                                                       : void
     {
         foreach ($participants as $participant) {
             $this->database->replace(
                 'tst_invited_user',
                 [
                     'test_fi' => [\ilDBConstants::T_INTEGER, $participant->getTestId()],
                     'user_fi' => [\ilDBConstants::T_INTEGER, $participant->getUserId()]
                 ],
                 [
                     'ip_range_from' => [\ilDBConstants::T_TEXT, $participant->getClientIpFrom()],
                     'ip_range_to' => [\ilDBConstants::T_TEXT, $participant->getClientIpTo()],
                     'tstamp' => [\ilDBConstants::T_INTEGER, time()]
                 ]
             );
         }
     }

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

components/ILIAS/Test/src/Participants/ParticipantRepository.php

Public Member Functions

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applyFilter()

◆ applyOrder()

◆ arrayToObject()

◆ countParticipants()

◆ fetchParticipant()

◆ getActiveParticipantsQuery()

◆ getBaseQuery()

◆ getFirstAndLastVisitForActiveId()

◆ getInvitedParticipantsQuery()

◆ getParticipantByActiveId()

◆ getParticipantByUserId()

◆ getParticipants()

◆ isFilterSet()

◆ lookupTestIdByActiveId()

◆ removeExtraTimeByUserId()

◆ removeParticipants()

◆ updateExtraTime()

◆ updateIpRange()