Collaboration diagram for ILIAS\Test\Participants\Participant:

Public Member Functions
	__construct (private readonly int $user_id, private readonly ?int $active_id=null, private readonly ?int $test_id=null, private readonly ?string $anonymous_id=null, private readonly string $firstname='', private readonly string $lastname='', private readonly string $login='', private readonly string $matriculation='', private int $extra_time=0, private readonly int $attempts=0, private ?string $client_ip_from=null, private ?string $client_ip_to=null, private readonly ?int $invitation_date=null, private readonly ?bool $submitted=null, private readonly ?int $last_started_attempt=null, private readonly ?int $last_finished_attempt=null, private readonly bool $unfinished_attempts=false, private readonly ?\DateTimeImmutable $first_access=null, private readonly ?\DateTimeImmutable $last_access=null)

	getUserId ()

	getActiveId ()

	getTestId ()

	getAnonymousId ()

	getFirstname ()

	getLastname ()

	getLogin ()

	getMatriculation ()

	getExtraTime ()

	withAddedExtraTime (int $extra_time)

	getAttempts ()

	getClientIpFrom ()

	withClientIpFrom (?string $ip)

	getClientIpTo ()

	withClientIpTo (?string $ip)

	isInvitedParticipant ()

	getSubmitted ()

	getTotalDuration (?int $processing_time)

	getLastStartedAttempt ()

	getLastFinishedAttempt ()

	hasUnfinishedAttempts ()

	getFirstAccess ()

	getLastAccess ()

	hasAnsweredQuestionsForScoredAttempt ()

	getRemainingDuration (int $processing_time, bool $reset_time_on_new_attempt)

	getAttemptOverviewInformation ()

	withAttemptOverviewInformation (?AttemptOverview $attempt_overview)

	withRunningAttemptStart (\DateTimeImmutable $start_date)

Private Attributes
AttemptOverview	$attempt_overview = null

DateTimeImmutable	$running_attempt_start = null

Detailed Description

Definition at line 25 of file Participant.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Test\Participants\Participant::__construct	(	private readonly int	$user_id,
		private readonly ?int	$active_id = `null`,
		private readonly ?int	$test_id = `null`,
		private readonly ?string	$anonymous_id = `null`,
		private readonly string	$firstname = `''`,
		private readonly string	$lastname = `''`,
		private readonly string	$login = `''`,
		private readonly string	$matriculation = `''`,
		private int	$extra_time = `0`,
		private readonly int	$attempts = `0`,
		private ?string	$client_ip_from = `null`,
		private ?string	$client_ip_to = `null`,
		private readonly ?int	$invitation_date = `null`,
		private readonly ?bool	$submitted = `null`,
		private readonly ?int	$last_started_attempt = `null`,
		private readonly ?int	$last_finished_attempt = `null`,
		private readonly bool	$unfinished_attempts = `false`,
		private readonly ?\DateTimeImmutable	$first_access = `null`,
		private readonly ?\DateTimeImmutable	$last_access = `null`
	)

Definition at line 30 of file Participant.php.

50 {

51 }

Member Function Documentation

◆ getActiveId()

ILIAS\Test\Participants\Participant::getActiveId ( )

Definition at line 58 of file Participant.php.

Referenced by ILIAS\Test\Results\Data\Factory\addAttemptOverviewInformationToParticipants(), ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction\allowActionForRecord(), ILIAS\Test\Participants\ParticipantTableShowResultsAction\allowActionForRecord(), ILIAS\Test\Participants\ParticipantTableDeleteResultsAction\allowActionForRecord(), ILIAS\Test\Participants\ParticipantTableShowResultsAction\onSubmit(), and ILIAS\Test\Participants\ParticipantTableDeleteResultsAction\onSubmit().

                                  : ?int
     {
         return $this->active_id;
     }

Here is the caller graph for this function:

◆ getAnonymousId()

ILIAS\Test\Participants\Participant::getAnonymousId ( )

Definition at line 68 of file Participant.php.

                                     : ?string
     {
         return $this->anonymous_id;
     }

◆ getAttemptOverviewInformation()

ILIAS\Test\Participants\Participant::getAttemptOverviewInformation ( )

Definition at line 214 of file Participant.php.

References ILIAS\Test\Participants\Participant\$attempt_overview.

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadFilters(), and ILIAS\Test\Participants\ParticipantTable\getPostLoadOrderFields().

                                                    : ?AttemptOverview
     {
         return $this->attempt_overview;
     }

Here is the caller graph for this function:

◆ getAttempts()

ILIAS\Test\Participants\Participant::getAttempts ( )

Definition at line 105 of file Participant.php.

                                  : int
     {
         return $this->attempts;
     }

◆ getClientIpFrom()

ILIAS\Test\Participants\Participant::getClientIpFrom ( )

Definition at line 110 of file Participant.php.

Referenced by ilTestAccess\isParticipantExplicitelyAllowedByIndividualIPRange(), and ILIAS\Test\Participants\ParticipantTableIpRangeAction\isUniqueClientIp().

                                      : ?string
     {
         return $this->client_ip_from;
     }

Here is the caller graph for this function:

◆ getClientIpTo()

ILIAS\Test\Participants\Participant::getClientIpTo ( )

Definition at line 125 of file Participant.php.

Referenced by ilTestAccess\isParticipantExplicitelyAllowedByIndividualIPRange(), and ILIAS\Test\Participants\ParticipantTableIpRangeAction\isUniqueClientIp().

                                    : ?string
     {
         return $this->client_ip_to;
     }

Here is the caller graph for this function:

◆ getExtraTime()

ILIAS\Test\Participants\Participant::getExtraTime ( )

Definition at line 93 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTableExtraTimeAction\getModal(), ILIAS\Test\Participants\ParticipantTableExtraTimeAction\resolveHasDifferentExtraTime(), and ILIAS\Test\Participants\ParticipantRepository\updateExtraTime().

                                   : int
     {
         return $this->extra_time;
     }

Here is the caller graph for this function:

◆ getFirstAccess()

ILIAS\Test\Participants\Participant::getFirstAccess ( )

Definition at line 174 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadOrderFields(), and ILIAS\Test\Participants\Participant\getRemainingDuration().

                                     : ?\DateTimeImmutable
     {
         return $this->first_access;
     }

Here is the caller graph for this function:

◆ getFirstname()

ILIAS\Test\Participants\Participant::getFirstname ( )

Definition at line 73 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTableIpRangeAction\getModal(), and ILIAS\Test\Participants\ParticipantTableExtraTimeAction\getModal().

                                   : string
     {
         return $this->firstname;
     }

Here is the caller graph for this function:

◆ getLastAccess()

ILIAS\Test\Participants\Participant::getLastAccess ( )

Definition at line 179 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadOrderFields(), and ILIAS\Test\Participants\Participant\getRemainingDuration().

                                    : ?\DateTimeImmutable
     {
         return $this->last_access;
     }

Here is the caller graph for this function:

◆ getLastFinishedAttempt()

ILIAS\Test\Participants\Participant::getLastFinishedAttempt ( )

Definition at line 164 of file Participant.php.

                                             : ?int
     {
         return $this->last_finished_attempt;
     }

◆ getLastname()

ILIAS\Test\Participants\Participant::getLastname ( )

Definition at line 78 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTableIpRangeAction\getModal(), and ILIAS\Test\Participants\ParticipantTableExtraTimeAction\getModal().

                                  : string
     {
         return $this->lastname;
     }

Here is the caller graph for this function:

◆ getLastStartedAttempt()

ILIAS\Test\Participants\Participant::getLastStartedAttempt ( )

Definition at line 159 of file Participant.php.

                                            : ?int
     {
         return $this->last_started_attempt;
     }

◆ getLogin()

ILIAS\Test\Participants\Participant::getLogin ( )

Definition at line 83 of file Participant.php.

                               : string
     {
         return $this->login;
     }

◆ getMatriculation()

ILIAS\Test\Participants\Participant::getMatriculation ( )

Definition at line 88 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadOrderFields().

                                       : string
     {
         return $this->matriculation;
     }

Here is the caller graph for this function:

◆ getRemainingDuration()

ILIAS\Test\Participants\Participant::getRemainingDuration	(	int	$processing_time,
		bool	$reset_time_on_new_attempt
	)

Definition at line 189 of file Participant.php.

References ILIAS\Test\Participants\Participant\getFirstAccess(), ILIAS\Test\Participants\Participant\getLastAccess(), and ILIAS\Test\Participants\Participant\getTotalDuration().

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadOrderFields().

      : int {
         $remaining = $this->getTotalDuration($processing_time);
 
         $start = $this->getFirstAccess()?->getTimestamp();
         if ($reset_time_on_new_attempt) {
             $start = $this->running_attempt_start?->getTimestamp();
         }
 
         if ($start === null) {
             return $remaining;
         }
 
         $remaining += $start;
         if ($this->submitted) {
             $remaining -= $this->getLastAccess()?->getTimestamp() ?? time();
         } else {
             $remaining -= time();
         }
 
         return max(0, $remaining);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubmitted()

ILIAS\Test\Participants\Participant::getSubmitted ( )

Definition at line 145 of file Participant.php.

                                   : ?bool
     {
         return $this->submitted;
     }

◆ getTestId()

ILIAS\Test\Participants\Participant::getTestId ( )

Definition at line 63 of file Participant.php.

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

                                : ?int
     {
         return $this->test_id;
     }

Here is the caller graph for this function:

◆ getTotalDuration()

ILIAS\Test\Participants\Participant::getTotalDuration ( ?int $processing_time )

Definition at line 150 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadOrderFields(), and ILIAS\Test\Participants\Participant\getRemainingDuration().

                                                            : int
     {
         if (!$processing_time) {
             return 0;
         }
 
         return $processing_time + $this->extra_time * 60;
     }

Here is the caller graph for this function:

◆ getUserId()

ILIAS\Test\Participants\Participant::getUserId ( )

Definition at line 53 of file Participant.php.

References $user_id.

                                : int
     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ hasAnsweredQuestionsForScoredAttempt()

ILIAS\Test\Participants\Participant::hasAnsweredQuestionsForScoredAttempt ( )

Definition at line 184 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTable\getPostLoadFilters().

                                                           : bool
     {
         return $this->attempt_overview?->hasAnsweredQuestions() ?? false;
     }

Here is the caller graph for this function:

◆ hasUnfinishedAttempts()

ILIAS\Test\Participants\Participant::hasUnfinishedAttempts ( )

Definition at line 169 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTableFinishTestAction\allowActionForRecord().

                                            : bool
     {
         return $this->unfinished_attempts;
     }

Here is the caller graph for this function:

◆ isInvitedParticipant()

ILIAS\Test\Participants\Participant::isInvitedParticipant ( )

Definition at line 140 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTableIpRangeAction\allowActionForRecord().

                                           : bool
     {
         return $this->invitation_date > 0;
     }

Here is the caller graph for this function:

◆ withAddedExtraTime()

ILIAS\Test\Participants\Participant::withAddedExtraTime ( int $extra_time )

Definition at line 98 of file Participant.php.

                                                        : self
     {
         $clone = clone $this;
         $clone->extra_time += $extra_time;
         return $clone;
     }

◆ withAttemptOverviewInformation()

ILIAS\Test\Participants\Participant::withAttemptOverviewInformation ( ?AttemptOverview $attempt_overview )

Definition at line 219 of file Participant.php.

References ILIAS\Test\Participants\Participant\$attempt_overview.

Referenced by ILIAS\Test\Results\Data\Factory\addAttemptOverviewInformationToParticipants().

                                                                                       : self
     {
         $clone = clone $this;
         $clone->attempt_overview = $attempt_overview;
         return $clone;
     }

Here is the caller graph for this function:

◆ withClientIpFrom()

ILIAS\Test\Participants\Participant::withClientIpFrom ( ?string $ip )

Definition at line 115 of file Participant.php.

Referenced by ILIAS\Test\Participants\ParticipantTableIpRangeAction\onSubmit().

                                                  : self
     {
         if ($ip === '') {
             $ip = null;
         }
         $clone = clone $this;
         $clone->client_ip_from = $ip;
         return $clone;
     }

Here is the caller graph for this function:

◆ withClientIpTo()

ILIAS\Test\Participants\Participant::withClientIpTo ( ?string $ip )

Definition at line 130 of file Participant.php.

                                                : self
     {
         if ($ip === '') {
             $ip = null;
         }
         $clone = clone $this;
         $clone->client_ip_to = $ip;
         return $clone;
     }

◆ withRunningAttemptStart()

ILIAS\Test\Participants\Participant::withRunningAttemptStart ( \DateTimeImmutable $start_date )

Definition at line 226 of file Participant.php.

Referenced by ILIAS\Test\Results\Data\Factory\addAttemptOverviewInformationToParticipants().

                                                                            : self
     {
         $clone = clone $this;
         $clone->running_attempt_start = $start_date;
         return $clone;
     }

Here is the caller graph for this function:

Field Documentation

◆ $attempt_overview

AttemptOverview ILIAS\Test\Participants\Participant::$attempt_overview = null

private

Definition at line 27 of file Participant.php.

Referenced by ILIAS\Test\Participants\Participant\getAttemptOverviewInformation(), and ILIAS\Test\Participants\Participant\withAttemptOverviewInformation().

◆ $running_attempt_start

DateTimeImmutable ILIAS\Test\Participants\Participant::$running_attempt_start = null

private

Definition at line 28 of file Participant.php.

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

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

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getActiveId()

◆ getAnonymousId()

◆ getAttemptOverviewInformation()

◆ getAttempts()

◆ getClientIpFrom()

◆ getClientIpTo()

◆ getExtraTime()

◆ getFirstAccess()

◆ getFirstname()

◆ getLastAccess()

◆ getLastFinishedAttempt()

◆ getLastname()

◆ getLastStartedAttempt()

◆ getLogin()

◆ getMatriculation()

◆ getRemainingDuration()

◆ getSubmitted()

◆ getTestId()

◆ getTotalDuration()

◆ getUserId()

◆ hasAnsweredQuestionsForScoredAttempt()

◆ hasUnfinishedAttempts()

◆ isInvitedParticipant()

◆ withAddedExtraTime()

◆ withAttemptOverviewInformation()

◆ withClientIpFrom()

◆ withClientIpTo()

◆ withRunningAttemptStart()

Field Documentation

◆ $attempt_overview

◆ $running_attempt_start