Class ilCronFinishUnfinishedTestPasses. More...

Inheritance diagram for ilCronFinishUnfinishedTestPasses:

Collaboration diagram for ilCronFinishUnfinishedTestPasses:

Public Member Functions
	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	hasCustomSettings ()

	run ()

Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)

	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule (?JobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...

	getAllScheduleTypes ()
	Get all available schedule types. More...

	getScheduleTypesWithValues ()

	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...

	isManuallyExecutable ()

	hasCustomSettings ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomConfiguration (mixed $form_data)

	saveCustomSettings (\ilPropertyFormGUI $a_form)

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (\ilDBInterface $db, \ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...

	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Protected Member Functions
	gatherUsersWithUnfinishedPasses ()

	getTestsFinishAndProcessingTime ()

	processPasses ()

	finishPassForUser ($active_id, $obj_id)

Protected Attributes
readonly TestLogger	$logger

readonly ilLanguage	$lng

readonly ilDBInterface	$db

readonly ilObjUser	$user

readonly ilObjectDataCache	$obj_data_cache

int	$now

array	$unfinished_passes

array	$test_ids

array	$test_ending_times

ilTestProcessLockerFactory	$processLockerFactory

TestResultRepository	$test_result_repository

Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Member Functions
	finishPassOnEndingTime (int $test_id, int $active_id)

	finishPassOnProcessingTime (int $test_id, int $usr_id, int $active_id)

Detailed Description

Class ilCronFinishUnfinishedTestPasses.

Author: Guido Vollbach gvoll.nosp@m.bach.nosp@m.@data.nosp@m.bay..nosp@m.de

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

Member Function Documentation

◆ finishPassForUser()

ilCronFinishUnfinishedTestPasses::finishPassForUser	(	$active_id,
		$obj_id
	)

protected

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

References ilObject\_exists(), ILIAS\Repository\logger(), null, and ILIAS\Repository\user().

Referenced by finishPassOnEndingTime(), and finishPassOnProcessingTime().

                                                              : void
     {
         $processLocker = $this->processLockerFactory->withContextId((int) $active_id)->getLocker();
 
         $test_session = new ilTestSession($this->db, $this->user);
         $test_session->loadFromDb($active_id);
 
         if (ilObject::_exists($obj_id)) {
             $this->test_result_repository->updateTestAttemptResult(
                 $active_id,
                 $test_session->getPass(),
                 null,
                 $obj_id
             );
 
             (new ilTestPassFinishTasks(
                 $test_session,
                 $obj_id,
                 $this->test_result_repository
             ))->performFinishTasks($processLocker, StatusOfAttempt::FINISHED_BY_CRONJOB);
             $this->logger->info('Test session with active id (' . $active_id . ') and obj_id (' . $obj_id . ') is now finished.');
         } else {
             $this->logger->info('Test object with id (' . $obj_id . ') does not exist.');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finishPassOnEndingTime()

ilCronFinishUnfinishedTestPasses::finishPassOnEndingTime	(	int	$test_id,
		int	$active_id
	)

private

Definition at line 193 of file class.ilCronFinishUnfinishedTestPasses.php.

References finishPassForUser(), and ILIAS\Repository\logger().

Referenced by processPasses().

                                                                          : bool
     {
         $now = time();
         if ($this->test_ending_times[$test_id]['ending_time_enabled'] !== 1) {
             $this->logger->info('Test (' . $test_id . ') has no ending time.');
             return false;
         }
 
         $this->logger->info('Test (' . $test_id . ') has ending time ('
             . $this->test_ending_times[$test_id]['ending_time'] . ')');
         $ending_time = $this->test_ending_times[$test_id]['ending_time'];
         if ($ending_time >= $now) {
             $this->logger->info('Test (' . $test_id . ') ending time ('
                 . $this->test_ending_times[$test_id]['ending_time']
                 . ') > now (' . $now . ') is not reached.');
             return false;
         }
 
         $this->finishPassForUser($active_id, $this->test_ending_times[$test_id]['obj_fi']);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ finishPassOnProcessingTime()

ilCronFinishUnfinishedTestPasses::finishPassOnProcessingTime	(	int	$test_id,
		int	$usr_id,
		int	$active_id
	)

private

Definition at line 215 of file class.ilCronFinishUnfinishedTestPasses.php.

References ilObject\_exists(), finishPassForUser(), and ILIAS\Repository\logger().

Referenced by processPasses().

      : bool {
         if ($this->test_ending_times[$test_id]['enable_processing_time'] !== 1) {
             $this->logger->info('Test (' . $test_id . ') has no processing time.');
             return false;
         }
 
         $this->logger->info('Test (' . $test_id . ') has processing time (' . $this->test_ending_times[$test_id]['processing_time'] . ')');
         $obj_id = $this->test_ending_times[$test_id]['obj_fi'];
 
         if (!ilObject::_exists($obj_id)) {
             $this->logger->info('Test object with id (' . $obj_id . ') does not exist.');
             return false;
         }
 
         $test_obj = new ilObjTest($obj_id, false);
         $startingTime = $test_obj->getStartingTimeOfUser($active_id);
         $max_processing_time = $test_obj->isMaxProcessingTimeReached($startingTime, $active_id);
         if (!$max_processing_time) {
             $this->logger->info('Max Processing time not reached for user id ('
                 . $usr_id . ') in test with active id ('
                 . $active_id . '). Starting time: ' . $startingTime
                 . ' Processing time: ' . $test_obj->getProcessingTime() . ' / '
                 . $test_obj->getProcessingTimeInSeconds() . 's');
             return false;
         }
 
         $this->logger->info('Max Processing time reached for user id ('
             . $usr_id . ') so test with active id ('
             . $active_id . ') will be finished.');
         $this->finishPassForUser($active_id, $this->test_ending_times[$test_id]['obj_fi']);
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherUsersWithUnfinishedPasses()

ilCronFinishUnfinishedTestPasses::gatherUsersWithUnfinishedPasses ( )

protected

Definition at line 134 of file class.ilCronFinishUnfinishedTestPasses.php.

Referenced by run().

                                                         : void
     {
         $query = '
             SELECT      tst_active.active_id,
                     tst_active.tries,
                     tst_active.user_fi usr_id,
                     tst_active.test_fi test_fi,
                     usr_data.login,
                     usr_data.lastname,
                     usr_data.firstname,
                     tst_active.submitted test_finished,
                     usr_data.matriculation,
                     usr_data.active,
                     tst_active.lastindex,
                     tst_active.last_started_pass last_started
             FROM tst_active
             LEFT JOIN usr_data
             ON tst_active.user_fi = usr_data.usr_id
             WHERE IFNULL(tst_active.last_finished_pass, -1) <> tst_active.last_started_pass
         ';
         $result = $this->db->query($query);
         while ($row = $this->db->fetchAssoc($result)) {
             $this->unfinished_passes[] = $row;
             $this->test_ids[] = $row['test_fi'];
         }
     }

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCronFinishUnfinishedTestPasses::getDefaultScheduleType ( )

Definition at line 87 of file class.ilCronFinishUnfinishedTestPasses.php.

                                             : JobScheduleType
     {
         return JobScheduleType::DAILY;
     }

◆ getDefaultScheduleValue()

ilCronFinishUnfinishedTestPasses::getDefaultScheduleValue ( )

Definition at line 92 of file class.ilCronFinishUnfinishedTestPasses.php.

◆ getDescription()

ilCronFinishUnfinishedTestPasses::getDescription ( )

Definition at line 82 of file class.ilCronFinishUnfinishedTestPasses.php.

References ILIAS\Repository\lng().

Referenced by ilCronFinishUnfinishedTestPassesTest\testGetDescription().

                                     : string
     {
         return $this->lng->txt('finish_unfinished_passes_desc');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilCronFinishUnfinishedTestPasses::getId ( )

Definition at line 72 of file class.ilCronFinishUnfinishedTestPasses.php.

                            : string
     {
         return 'finish_unfinished_passes';
     }

◆ getTestsFinishAndProcessingTime()

ilCronFinishUnfinishedTestPasses::getTestsFinishAndProcessingTime ( )

protected

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

References ILIAS\Repository\logger().

Referenced by run().

                                                         : void
     {
         $query = 'SELECT test_id, obj_fi, ending_time, ending_time_enabled, processing_time, enable_processing_time FROM tst_tests WHERE ' .
                     $this->db->in('test_id', $this->test_ids, false, 'integer');
         $result = $this->db->query($query);
         while ($row = $this->db->fetchAssoc($result)) {
             $this->test_ending_times[$row['test_id']] = $row;
         }
         $this->logger->info('Gathered data for ' . count($this->test_ids) . ' test id(s) => (' . implode(',', $this->test_ids) . ')');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilCronFinishUnfinishedTestPasses::getTitle ( )

Definition at line 77 of file class.ilCronFinishUnfinishedTestPasses.php.

References ILIAS\Repository\lng().

Referenced by ilCronFinishUnfinishedTestPassesTest\testGetTitle().

                               : string
     {
         return $this->lng->txt('finish_unfinished_passes');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoActivation()

ilCronFinishUnfinishedTestPasses::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCronFinishUnfinishedTestPasses::hasCustomSettings ( )

Definition at line 107 of file class.ilCronFinishUnfinishedTestPasses.php.

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCronFinishUnfinishedTestPasses::hasFlexibleSchedule ( )

Definition at line 102 of file class.ilCronFinishUnfinishedTestPasses.php.

                                          : bool
     {
         return true;
     }

◆ processPasses()

ilCronFinishUnfinishedTestPasses::processPasses ( )

protected

Definition at line 172 of file class.ilCronFinishUnfinishedTestPasses.php.

References $data, finishPassOnEndingTime(), finishPassOnProcessingTime(), and ILIAS\Repository\logger().

Referenced by run().

                                       : void
     {
         foreach ($this->unfinished_passes as $data) {
             $test_id = $data['test_fi'];
             if (!array_key_exists($test_id, $this->test_ending_times)) {
                 continue;
             }
             if (!$this->finishPassOnEndingTime($test_id, $data['active_id'])
                 && !$this->finishPassOnProcessingTime(
                     $test_id,
                     $data['usr_id'],
                     $data['active_id']
                 )
             ) {
                 $this->logger->info('Test session with active id ('
                     . $data['active_id'] . ') can not be finished by this cron job.');
             }
         }
 
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilCronFinishUnfinishedTestPasses::run ( )

Definition at line 112 of file class.ilCronFinishUnfinishedTestPasses.php.

References gatherUsersWithUnfinishedPasses(), getTestsFinishAndProcessingTime(), ILIAS\Repository\logger(), and processPasses().

                          : JobResult
     {
         $this->logger->info('start inf cronjob...');
 
         $result = new JobResult();
 
         $this->gatherUsersWithUnfinishedPasses();
         if (count($this->unfinished_passes) > 0) {
             $this->logger->info('found ' . count($this->unfinished_passes) . ' unfinished passes starting analyses.');
             $this->getTestsFinishAndProcessingTime();
             $this->processPasses();
         } else {
             $this->logger->info('No unfinished passes found.');
         }
 
         $result->setStatus(JobResult::STATUS_OK);
 
         $this->logger->info(' ...finishing cronjob.');
 
         return $result;
     }