ilTestPassesSelector Class Reference

Collaboration diagram for ilTestPassesSelector:

Public Member Functions
	__construct (private ilDBInterface $db, private ilObjTest $test_obj)
	getActiveId ()
	setActiveId (?int $active_id)
	getLastFinishedPass ()
	setLastFinishedPass (?int $last_finished_pass)
	loadLastFinishedPass ()
	getExistingPasses ()
	hasExistingPasses ()
	getNumExistingPasses ()
	openPassExists ()
	getClosedPasses ()
	getReportablePasses ()
	hasReportablePasses ()
	getLastFinishedPassTimestamp ()
	hasTestPassedOnce (int $active_id)

Private Member Functions
	passesLoaded ()
	ensureLoadedPasses ()
	loadPasses ()
	getLazyLoadedPasses ()
	fetchReportablePasses (array $existing_passes)
	fetchClosedPasses (array $existing_passes)
	fetchLastPass (array $existing_passes)
	isReportableAttempt (int $last_attempt, int $attempt)
	checkLastFinishedPassInitialised ()
	isClosedPass (int $pass)
	isReportingDateReached ()
	isProcessingTimeReached (int $pass)

Private Attributes
int	$active_id = null
int	$last_finished_pass = null
array	$passes = null
array	$test_passed_once_cache = []

Detailed Description

Definition at line 29 of file class.ilTestPassesSelector.php.

Constructor & Destructor Documentation

__construct()

ilTestPassesSelector::__construct	(	private ilDBInterface	$db,
		private ilObjTest	$test_obj
	)

Definition at line 36 of file class.ilTestPassesSelector.php.

      {
    }

Member Function Documentation

checkLastFinishedPassInitialised()

ilTestPassesSelector::checkLastFinishedPassInitialised ( )

private

Definition at line 224 of file class.ilTestPassesSelector.php.

References getLastFinishedPass().

Referenced by isClosedPass().

    {
        if ($this->getLastFinishedPass() === null) {
            throw new ilTestException('invalid object state: last finished pass was not set!');
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureLoadedPasses()

ilTestPassesSelector::ensureLoadedPasses ( )

private

Definition at line 67 of file class.ilTestPassesSelector.php.

References loadPasses(), and passesLoaded().

Referenced by getLazyLoadedPasses().

    {
        if (!$this->passesLoaded()) {
            $this->loadPasses();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchClosedPasses()

ilTestPassesSelector::fetchClosedPasses ( array  $existing_passes )

private

Definition at line 170 of file class.ilTestPassesSelector.php.

References isClosedPass().

Referenced by getClosedPasses().

                                                              : array
    {
        $closed_passes = [];

        foreach ($existing_passes as $pass) {
            if ($this->isClosedPass($pass)) {
                $closed_passes[] = $pass;
            }
        }

        return $closed_passes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

fetchLastPass()

ilTestPassesSelector::fetchLastPass ( array  $existing_passes )

private

Definition at line 183 of file class.ilTestPassesSelector.php.

Referenced by fetchReportablePasses().

                                                          : ?int
    {
        $last_pass = null;

        foreach ($existing_passes as $pass) {
            if ($last_pass === null || $pass > $last_pass) {
                $last_pass = $pass;
            }
        }

        return $last_pass;
    }

Here is the caller graph for this function:

fetchReportablePasses()

ilTestPassesSelector::fetchReportablePasses ( array  $existing_passes )

private

Definition at line 155 of file class.ilTestPassesSelector.php.

References fetchLastPass(), and isReportableAttempt().

Referenced by getReportablePasses().

                                                                  : array
    {
        $last_pass = $this->fetchLastPass($existing_passes);

        $reportable_passes = [];

        foreach ($existing_passes as $pass) {
            if ($this->isReportableAttempt($last_pass, $pass)) {
                $reportable_passes[] = $pass;
            }
        }

        return $reportable_passes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActiveId()

ilTestPassesSelector::getActiveId

(

)

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

References $active_id.

Referenced by isProcessingTimeReached(), isReportableAttempt(), loadLastFinishedPass(), and loadPasses().

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

Here is the caller graph for this function:

getClosedPasses()

ilTestPassesSelector::getClosedPasses

(

)

Definition at line 138 of file class.ilTestPassesSelector.php.

References fetchClosedPasses(), and getExistingPasses().

Referenced by openPassExists().

                                     : array
    {
        $existing_passes = $this->getExistingPasses();
        return $this->fetchClosedPasses($existing_passes);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExistingPasses()

ilTestPassesSelector::getExistingPasses

(

)

Definition at line 118 of file class.ilTestPassesSelector.php.

References getLazyLoadedPasses().

Referenced by getClosedPasses(), getNumExistingPasses(), getReportablePasses(), hasExistingPasses(), and openPassExists().

                                       : array
    {
        return array_keys($this->getLazyLoadedPasses());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLastFinishedPass()

ilTestPassesSelector::getLastFinishedPass

(

)

Definition at line 52 of file class.ilTestPassesSelector.php.

References $last_finished_pass.

Referenced by checkLastFinishedPassInitialised(), getLastFinishedPassTimestamp(), isClosedPass(), and ilObjTest\isNextPassAllowed().

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

Here is the caller graph for this function:

getLastFinishedPassTimestamp()

ilTestPassesSelector::getLastFinishedPassTimestamp

(

)

Definition at line 267 of file class.ilTestPassesSelector.php.

References $last_finished_pass, getLastFinishedPass(), and getLazyLoadedPasses().

Referenced by ilObjTest\isNextPassAllowed().

                                                  : ?int
    {
        $last_finished_pass = $this->getLastFinishedPass();
        if ($last_finished_pass === null || $last_finished_pass === -1) {
            return null;
        }

        $passes = $this->getLazyLoadedPasses();
        if (!isset($passes[$last_finished_pass])) {
            return null;
        }
        return $passes[$last_finished_pass]['tstamp'];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLazyLoadedPasses()

ilTestPassesSelector::getLazyLoadedPasses ( )

private

Definition at line 97 of file class.ilTestPassesSelector.php.

References $passes, and ensureLoadedPasses().

Referenced by getExistingPasses(), and getLastFinishedPassTimestamp().

                                          : array
    {
        $this->ensureLoadedPasses();
        return $this->passes;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getNumExistingPasses()

ilTestPassesSelector::getNumExistingPasses

(

)

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

References getExistingPasses().

                                          : int
    {
        return count($this->getExistingPasses());
    }

Here is the call graph for this function:

getReportablePasses()

ilTestPassesSelector::getReportablePasses

(

)

Definition at line 144 of file class.ilTestPassesSelector.php.

References fetchReportablePasses(), and getExistingPasses().

Referenced by hasReportablePasses().

                                         : array
    {
        $existing_passes = $this->getExistingPasses();
        return $this->fetchReportablePasses($existing_passes);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasExistingPasses()

ilTestPassesSelector::hasExistingPasses

(

)

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

References getExistingPasses().

                                       : bool
    {
        return $this->getExistingPasses() !== [];
    }

Here is the call graph for this function:

hasReportablePasses()

ilTestPassesSelector::hasReportablePasses

(

)

Definition at line 150 of file class.ilTestPassesSelector.php.

References getReportablePasses().

                                         : bool
    {
        return (bool) count($this->getReportablePasses());
    }

Here is the call graph for this function:

hasTestPassedOnce()

ilTestPassesSelector::hasTestPassedOnce

(

int

$active_id

)

Definition at line 281 of file class.ilTestPassesSelector.php.

References $active_id, and $res.

Referenced by isReportableAttempt().

                                                     : bool
    {
        if (!isset($this->test_passed_once_cache[$active_id])) {
            $this->test_passed_once_cache[$active_id] = false;

            $res = $this->db->queryF(
                'SELECT passed_once FROM tst_result_cache WHERE active_fi = %s',
                ['integer'],
                [$active_id]
            );

            while ($row = $this->db->fetchAssoc($res)) {
                $this->test_passed_once_cache[$active_id] = (bool) $row['passed_once'];
            }
        }

        return $this->test_passed_once_cache[$active_id];
    }

Here is the caller graph for this function:

isClosedPass()

ilTestPassesSelector::isClosedPass ( int  $pass )

private

Definition at line 231 of file class.ilTestPassesSelector.php.

References checkLastFinishedPassInitialised(), getLastFinishedPass(), and isProcessingTimeReached().

Referenced by fetchClosedPasses(), and isReportableAttempt().

                                            : bool
    {
        $this->checkLastFinishedPassInitialised();

        if ($pass <= $this->getLastFinishedPass()) {
            return true;
        }

        if ($this->isProcessingTimeReached($pass)) {
            return true;
        }

        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isProcessingTimeReached()

ilTestPassesSelector::isProcessingTimeReached ( int  $pass )

private

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

References getActiveId().

Referenced by isClosedPass().

                                                       : bool
    {
        if (!$this->test_obj->getEnableProcessingTime()) {
            return false;
        }

        $startingTime = $this->test_obj->getStartingTimeOfUser($this->getActiveId(), $pass);

        if ($startingTime === false) {
            return false;
        }

        return $this->test_obj->isMaxProcessingTimeReached($startingTime, $this->getActiveId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isReportableAttempt()

ilTestPassesSelector::isReportableAttempt ( int  $last_attempt, int  $attempt  )

private

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

References getActiveId(), hasTestPassedOnce(), isClosedPass(), and isReportingDateReached().

Referenced by fetchReportablePasses().

                                                                         : bool
    {
        switch ($this->test_obj->getScoreSettings()->getResultSummarySettings()->getScoreReporting()) {
            case ScoreReportingTypes::SCORE_REPORTING_IMMIDIATLY:
                return true;

            case ScoreReportingTypes::SCORE_REPORTING_DATE:
                return $this->isReportingDateReached();

            case ScoreReportingTypes::SCORE_REPORTING_FINISHED:
                if ($attempt < $last_attempt) {
                    return true;
                }

                return $this->isClosedPass($attempt);

            case ScoreReportingTypes::SCORE_REPORTING_AFTER_PASSED:
                if (!$this->hasTestPassedOnce($this->getActiveId())) {
                    return false;
                }

                return $this->isClosedPass($attempt);

            default:
                return false;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isReportingDateReached()

ilTestPassesSelector::isReportingDateReached ( )

private

Definition at line 246 of file class.ilTestPassesSelector.php.

Referenced by isReportableAttempt().

                                             : bool
    {
        $reporting_date = $this->test_obj->getScoreSettings()->getResultSummarySettings()->getReportingDate();
        return $reporting_date <= new DateTimeImmutable('now', new DateTimeZone('UTC'));
    }

Here is the caller graph for this function:

loadLastFinishedPass()

ilTestPassesSelector::loadLastFinishedPass

(

)

Definition at line 103 of file class.ilTestPassesSelector.php.

References $res, getActiveId(), and setLastFinishedPass().

                                          : void
    {
        $query = 'SELECT last_finished_pass FROM tst_active WHERE active_id = %s';

        $res = $this->db->queryF(
            $query,
            ['integer'],
            [$this->getActiveId()]
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $this->setLastFinishedPass($row['last_finished_pass']);
        }
    }

Here is the call graph for this function:

loadPasses()

ilTestPassesSelector::loadPasses ( )

private

Definition at line 73 of file class.ilTestPassesSelector.php.

References $res, and getActiveId().

Referenced by ensureLoadedPasses().

                                 : void
    {
        $query = '
                        SELECT DISTINCT tst_pass_result.* FROM tst_pass_result
                        LEFT JOIN tst_test_result
                        ON tst_pass_result.pass = tst_test_result.pass
                        AND tst_pass_result.active_fi = tst_test_result.active_fi
                        WHERE tst_pass_result.active_fi = %s
                        ORDER BY tst_pass_result.pass
                ';

        $res = $this->db->queryF(
            $query,
            ['integer'],
            [$this->getActiveId()]
        );

        $this->passes = [];

        while ($row = $this->db->fetchAssoc($res)) {
            $this->passes[$row['pass']] = $row;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

openPassExists()

ilTestPassesSelector::openPassExists

(

)

Definition at line 133 of file class.ilTestPassesSelector.php.

References getClosedPasses(), and getExistingPasses().

                                    : bool
    {
        return count($this->getExistingPasses()) > count($this->getClosedPasses());
    }

Here is the call graph for this function:

passesLoaded()

ilTestPassesSelector::passesLoaded ( )

private

Definition at line 62 of file class.ilTestPassesSelector.php.

Referenced by ensureLoadedPasses().

                                   : bool
    {
        return is_array($this->passes);
    }

Here is the caller graph for this function:

setActiveId()

ilTestPassesSelector::setActiveId

(

?int

$active_id

)

Definition at line 47 of file class.ilTestPassesSelector.php.

References $active_id.

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

setLastFinishedPass()

ilTestPassesSelector::setLastFinishedPass

(

?int

$last_finished_pass

)

Definition at line 57 of file class.ilTestPassesSelector.php.

References $last_finished_pass.

Referenced by loadLastFinishedPass().

                                                                 : void
    {
        $this->last_finished_pass = $last_finished_pass === null ? -1 : $last_finished_pass;
    }

Here is the caller graph for this function:

Field Documentation

$active_id

int ilTestPassesSelector::$active_id = null

private

Definition at line 31 of file class.ilTestPassesSelector.php.

Referenced by getActiveId(), hasTestPassedOnce(), and setActiveId().

$last_finished_pass

int ilTestPassesSelector::$last_finished_pass = null

private

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

Referenced by getLastFinishedPass(), getLastFinishedPassTimestamp(), and setLastFinishedPass().

$passes

array ilTestPassesSelector::$passes = null

private

Definition at line 33 of file class.ilTestPassesSelector.php.

Referenced by getLazyLoadedPasses().

$test_passed_once_cache

array ilTestPassesSelector::$test_passed_once_cache = []

private

Definition at line 34 of file class.ilTestPassesSelector.php.

---

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

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