Collaboration diagram for ilTestPassesSelector:

Public Member Functions
	__construct (ilDBInterface $db, ilObjTest $testOBJ)

	getActiveId ()

	setActiveId ($activeId)

	getLastFinishedPass ()

	setLastFinishedPass ($lastFinishedPass)

	loadLastFinishedPass ()

	getExistingPasses ()

	hasExistingPasses ()

	getNumExistingPasses ()

	openPassExists ()

	getClosedPasses ()

	getReportablePasses ()

	hasReportablePasses ()

	getLastFinishedPassTimestamp ()

	hasTestPassedOnce ($activeId)

Protected Attributes
	$db

	$testOBJ

Private Member Functions
	passesLoaded ()

	ensureLoadedPasses ()

	loadPasses ()

	getLazyLoadedPasses ()

	fetchReportablePasses ($existingPasses)

	fetchClosedPasses ($existingPasses)

	fetchLastPass ($existingPasses)

	isReportablePass ($lastPass, $pass)

	checkLastFinishedPassInitialised ()

	isClosedPass ($pass)

	isReportingDateReached ()

	isProcessingTimeReached ($pass)

Private Attributes
	$activeId

	$lastFinishedPass = null

	$passes = null

	$testPassedOnceCache = array()

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestPassesSelector::__construct	(	ilDBInterface	$db,
		ilObjTest	$testOBJ
	)

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

References $db, and $testOBJ.

     {
         $this->db = $db;
         $this->testOBJ = $testOBJ;
     }

Member Function Documentation

◆ checkLastFinishedPassInitialised()

ilTestPassesSelector::checkLastFinishedPassInitialised ( )

private

Definition at line 238 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 71 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 ( $existingPasses )

private

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

References isClosedPass().

Referenced by getClosedPasses().

                                                        : array
     {
         $closedPasses = array();
 
         foreach ($existingPasses as $pass) {
             if ($this->isClosedPass($pass)) {
                 $closedPasses[] = $pass;
             }
         }
 
         return $closedPasses;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fetchLastPass()

ilTestPassesSelector::fetchLastPass ( $existingPasses )

private

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

Referenced by fetchReportablePasses().

     {
         $lastPass = null;
 
         foreach ($existingPasses as $pass) {
             if ($lastPass === null || $pass > $lastPass) {
                 $lastPass = $pass;
             }
         }
 
         return $lastPass;
     }

Here is the caller graph for this function:

◆ fetchReportablePasses()

ilTestPassesSelector::fetchReportablePasses ( $existingPasses )

private

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

References fetchLastPass(), and isReportablePass().

Referenced by getReportablePasses().

                                                            : array
     {
         $lastPass = $this->fetchLastPass($existingPasses);
 
         $reportablePasses = array();
 
         foreach ($existingPasses as $pass) {
             if ($this->isReportablePass($lastPass, $pass)) {
                 $reportablePasses[] = $pass;
             }
         }
 
         return $reportablePasses;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActiveId()

ilTestPassesSelector::getActiveId ( )

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

References $activeId.

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

     {
         return $this->activeId;
     }

Here is the caller graph for this function:

◆ getClosedPasses()

ilTestPassesSelector::getClosedPasses ( )

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

References fetchClosedPasses(), and getExistingPasses().

Referenced by openPassExists().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExistingPasses()

ilTestPassesSelector::getExistingPasses ( )

Definition at line 124 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 55 of file class.ilTestPassesSelector.php.

References $lastFinishedPass.

Referenced by checkLastFinishedPassInitialised(), getLastFinishedPassTimestamp(), and isClosedPass().

     {
         return $this->lastFinishedPass;
     }

Here is the caller graph for this function:

◆ getLastFinishedPassTimestamp()

ilTestPassesSelector::getLastFinishedPassTimestamp ( )

Returns: int timestamp

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

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

                                                   : ?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:

◆ getLazyLoadedPasses()

ilTestPassesSelector::getLazyLoadedPasses ( )

private

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

References $passes, and ensureLoadedPasses().

Referenced by getExistingPasses(), and getLastFinishedPassTimestamp().

     {
         $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 134 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 152 of file class.ilTestPassesSelector.php.

References fetchReportablePasses(), and getExistingPasses().

Referenced by hasReportablePasses().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasExistingPasses()

ilTestPassesSelector::hasExistingPasses ( )

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

References getExistingPasses().

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

Here is the call graph for this function:

◆ hasReportablePasses()

ilTestPassesSelector::hasReportablePasses ( )

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

References getReportablePasses().

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

Here is the call graph for this function:

◆ hasTestPassedOnce()

ilTestPassesSelector::hasTestPassedOnce ( $activeId )

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

References $activeId, $DIC, and $res.

Referenced by isReportablePass().

                                                 : bool
     {
         global $DIC; /* @var ILIAS\DI\Container $DIC */
 
         if (!isset($this->testPassedOnceCache[$activeId])) {
             $this->testPassedOnceCache[$activeId] = false;
 
             $res = $DIC->database()->queryF(
                 "SELECT passed_once FROM tst_result_cache WHERE active_fi = %s",
                 array('integer'),
                 array($activeId)
             );
 
             while ($row = $DIC->database()->fetchAssoc($res)) {
                 $this->testPassedOnceCache[$activeId] = (bool) $row['passed_once'];
             }
         }
 
         return $this->testPassedOnceCache[$activeId];
     }

Here is the caller graph for this function:

◆ isClosedPass()

ilTestPassesSelector::isClosedPass ( $pass )

private

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

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

Referenced by fetchClosedPasses(), and isReportablePass().

                                         : 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 ( $pass )

private

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

References getActiveId().

Referenced by isClosedPass().

                                                    : bool
     {
         if (!$this->testOBJ->getEnableProcessingTime()) {
             return false;
         }
 
         $startingTime = $this->testOBJ->getStartingTimeOfUser($this->getActiveId(), $pass);
 
         if ($startingTime === false) {
             return false;
         }
 
         return $this->testOBJ->isMaxProcessingTimeReached($startingTime, $this->getActiveId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isReportablePass()

ilTestPassesSelector::isReportablePass	(	$lastPass,
		$pass
	)

private

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

References getActiveId(), hasTestPassedOnce(), isClosedPass(), isReportingDateReached(), ilObjTest\SCORE_REPORTING_AFTER_PASSED, ilObjTest\SCORE_REPORTING_DATE, ilObjTest\SCORE_REPORTING_FINISHED, and ilObjTest\SCORE_REPORTING_IMMIDIATLY.

Referenced by fetchReportablePasses().

                                                        : bool
     {
         switch ($this->testOBJ->getScoreReporting()) {
             case ilObjTest::SCORE_REPORTING_IMMIDIATLY:
 
                 return true;
 
             case ilObjTest::SCORE_REPORTING_DATE:
 
                 return $this->isReportingDateReached();
 
             case ilObjTest::SCORE_REPORTING_FINISHED:
 
                 if ($pass < $lastPass) {
                     return true;
                 }
 
                 return $this->isClosedPass($pass);
 
             case ilObjTest::SCORE_REPORTING_AFTER_PASSED:
 
                 if (!$this->hasTestPassedOnce($this->getActiveId())) {
                     return false;
                 }
 
                 return $this->isClosedPass($pass);
         }
 
         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 260 of file class.ilTestPassesSelector.php.

Referenced by isReportablePass().

                                              : bool
     {
         $reporting_date = $this->testOBJ->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 107 of file class.ilTestPassesSelector.php.

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

     {
         $query = "
                         SELECT last_finished_pass FROM tst_active WHERE active_id = %s
                 ";
 
         $res = $this->db->queryF(
             $query,
             array('integer'),
             array($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 77 of file class.ilTestPassesSelector.php.

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

Referenced by ensureLoadedPasses().

     {
         $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,
             array('integer'),
             array($this->getActiveId())
         );
 
         $this->passes = array();
 
         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 139 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 66 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 ( $activeId )

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

References $activeId.

Referenced by ilTestSession\hasSinglePassReportable(), ilObjTest\removeQuestionFromSequences(), and ilTestScoring\updatePassAndTestResults().

     {
         $this->activeId = $activeId;
     }

Here is the caller graph for this function:

◆ setLastFinishedPass()

ilTestPassesSelector::setLastFinishedPass ( $lastFinishedPass )

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

References $lastFinishedPass.

Referenced by loadLastFinishedPass().

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

Here is the caller graph for this function:

Field Documentation

◆ $activeId

ilTestPassesSelector::$activeId

private

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

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

◆ $db

ilTestPassesSelector::$db

protected

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

Referenced by __construct().

◆ $lastFinishedPass

ilTestPassesSelector::$lastFinishedPass = null

private

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

Referenced by getLastFinishedPass(), and setLastFinishedPass().

◆ $passes

ilTestPassesSelector::$passes = null

private

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

Referenced by getLastFinishedPassTimestamp(), and getLazyLoadedPasses().

◆ $testOBJ

ilTestPassesSelector::$testOBJ

protected

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

Referenced by __construct().

◆ $testPassedOnceCache

ilTestPassesSelector::$testPassedOnceCache = array()

private

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

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

Modules/Test/classes/class.ilTestPassesSelector.php

Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkLastFinishedPassInitialised()

◆ ensureLoadedPasses()

◆ fetchClosedPasses()

◆ fetchLastPass()

◆ fetchReportablePasses()

◆ getActiveId()

◆ getClosedPasses()

◆ getExistingPasses()

◆ getLastFinishedPass()

◆ getLastFinishedPassTimestamp()

◆ getLazyLoadedPasses()

◆ getNumExistingPasses()

◆ getReportablePasses()

◆ hasExistingPasses()

◆ hasReportablePasses()

◆ hasTestPassedOnce()

◆ isClosedPass()

◆ isProcessingTimeReached()

◆ isReportablePass()

◆ isReportingDateReached()

◆ loadLastFinishedPass()

◆ loadPasses()

◆ openPassExists()

◆ passesLoaded()

◆ setActiveId()

◆ setLastFinishedPass()

Field Documentation

◆ $activeId

◆ $db

◆ $lastFinishedPass

◆ $passes

◆ $testOBJ

◆ $testPassedOnceCache