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 $importname=null, 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, private readonly bool $scoring_finalized=false)

	getUserId ()

	getActiveId ()

	getTestId ()

	getAnonymousId ()

	getFirstname ()

	getLastname ()

	getLogin ()

	getImportname ()

	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)

	isScoringFinalized ()

	getDisplayName (Language $language, bool $anonymous_test=false)

Private Attributes
AttemptOverview	$attempt_overview = null

DateTimeImmutable	$running_attempt_start = null

Detailed Description

Definition at line 26 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	$importname = `null`,
		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`,
		private readonly bool	$scoring_finalized = `false`
	)

Definition at line 31 of file Participant.php.

53 {

54 }

Member Function Documentation

◆ getActiveId()

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

Definition at line 61 of file Participant.php.

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

Referenced by ILIAS\Test\Participants\ParticipantTableDeleteParticipantAction\allowActionForRecord(), ILIAS\Test\Participants\ParticipantTableDeleteResultsAction\allowActionForRecord(), and ILIAS\Test\Participants\ParticipantTableShowResultsAction\allowActionForRecord().

Here is the caller graph for this function:

◆ getAnonymousId()

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

Definition at line 71 of file Participant.php.

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

◆ getAttemptOverviewInformation()

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

Definition at line 222 of file Participant.php.

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

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

Here is the caller graph for this function:

◆ getAttempts()

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

Definition at line 113 of file Participant.php.

                                 : int
    {
        return $this->attempts;
    }

◆ getClientIpFrom()

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

Definition at line 118 of file Participant.php.

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

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

Here is the caller graph for this function:

◆ getClientIpTo()

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

Definition at line 133 of file Participant.php.

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

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

Here is the caller graph for this function:

◆ getDisplayName()

ILIAS\Test\Participants\Participant::getDisplayName	(	Language	$language,
		bool	$anonymous_test = `false`
	)

Definition at line 246 of file Participant.php.

                                                                                    : string
    {
        if ($this->user_id === ANONYMOUS_USER_ID && $this->importname !== null && $this->importname !== '') {
            return "{$this->importname} ({$language->txt('imported')})";
        }
 
        if ($anonymous_test) {
            return $language->txt('anonymous');
        }
 
        $display_name = '';
 
        if ($this->firstname) {
            $display_name .= $this->firstname . ' ';
        }
        if ($this->lastname) {
            $display_name .= $this->lastname;
        }
 
        return $display_name;
    }

References ANONYMOUS_USER_ID, and ILIAS\Language\Language\txt().

Here is the call graph for this function:

◆ getExtraTime()

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

Definition at line 101 of file Participant.php.

                                  : int
    {
        return $this->extra_time;
    }

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

Here is the caller graph for this function:

◆ getFirstAccess()

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

Definition at line 182 of file Participant.php.

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

◆ getFirstname()

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

Definition at line 76 of file Participant.php.

                                  : string
    {
        return $this->firstname;
    }

◆ getImportname()

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

Definition at line 91 of file Participant.php.

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

◆ getLastAccess()

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

Definition at line 187 of file Participant.php.

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

◆ getLastFinishedAttempt()

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

Definition at line 172 of file Participant.php.

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

◆ getLastname()

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

Definition at line 81 of file Participant.php.

                                 : string
    {
        return $this->lastname;
    }

◆ getLastStartedAttempt()

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

Definition at line 167 of file Participant.php.

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

◆ getLogin()

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

Definition at line 86 of file Participant.php.

                              : string
    {
        return $this->login;
    }

◆ getMatriculation()

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

Definition at line 96 of file Participant.php.

                                      : string
    {
        return $this->matriculation;
    }

◆ getRemainingDuration()

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

Definition at line 197 of file Participant.php.

     : 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);
    }

◆ getSubmitted()

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

Definition at line 153 of file Participant.php.

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

◆ getTestId()

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

Definition at line 66 of file Participant.php.

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

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

Here is the caller graph for this function:

◆ getTotalDuration()

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

Definition at line 158 of file Participant.php.

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

◆ getUserId()

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

Definition at line 56 of file Participant.php.

                               : int
    {
        return $this->user_id;
    }

References $user_id.

Referenced by ILIAS\Test\Participants\ParticipantTableExtraTimeAction\allowActionForRecord(), ILIAS\Test\Participants\ParticipantTable\buildAccessFilteredParticipantsList(), ILIAS\Test\Participants\ParticipantTableFinishTestAction\getModal(), ILIAS\Test\Participants\ParticipantTable\loadRecords(), ILIAS\Test\Participants\ParticipantRepository\removeParticipants(), ILIAS\Test\Participants\ParticipantTableExtraTimeAction\saveExtraTime(), and ILIAS\Test\Participants\ParticipantRepository\updateExtraTime().

Here is the caller graph for this function:

◆ hasAnsweredQuestionsForScoredAttempt()

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

Definition at line 192 of file Participant.php.

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

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

Here is the caller graph for this function:

◆ hasUnfinishedAttempts()

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

Definition at line 177 of file Participant.php.

                                           : bool
    {
        return $this->unfinished_attempts;
    }

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

Here is the caller graph for this function:

◆ isInvitedParticipant()

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

Definition at line 148 of file Participant.php.

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

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

Here is the caller graph for this function:

◆ isScoringFinalized()

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

Definition at line 241 of file Participant.php.

                                        : bool
    {
        return $this->scoring_finalized;
    }

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

Here is the caller graph for this function:

◆ withAddedExtraTime()

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

Definition at line 106 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 227 of file Participant.php.

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

◆ withClientIpFrom()

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

Definition at line 123 of file Participant.php.

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

◆ withClientIpTo()

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

Definition at line 138 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 234 of file Participant.php.

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

Field Documentation

◆ $attempt_overview

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

private

Definition at line 28 of file Participant.php.

◆ $running_attempt_start

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

private

Definition at line 29 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()

◆ getDisplayName()

◆ getExtraTime()

◆ getFirstAccess()

◆ getFirstname()

◆ getImportname()

◆ getLastAccess()

◆ getLastFinishedAttempt()

◆ getLastname()

◆ getLastStartedAttempt()

◆ getLogin()

◆ getMatriculation()

◆ getRemainingDuration()

◆ getSubmitted()

◆ getTestId()

◆ getTotalDuration()

◆ getUserId()

◆ hasAnsweredQuestionsForScoredAttempt()

◆ hasUnfinishedAttempts()

◆ isInvitedParticipant()

◆ isScoringFinalized()

◆ withAddedExtraTime()

◆ withAttemptOverviewInformation()

◆ withClientIpFrom()

◆ withClientIpTo()

◆ withRunningAttemptStart()

Field Documentation

◆ $attempt_overview

◆ $running_attempt_start