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 ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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 ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	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
	$log

ilLanguage	$lng

ilDBInterface	$db

ilObjUser	$user

ilObjectDataCache	$obj_data_cache

int	$now

array	$unfinished_passes

array	$test_ids

array	$test_ending_times

ilTestProcessLockerFactory	$processLockerFactory

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Class ilCronFinishUnfinishedTestPasses.

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

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

Member Function Documentation

◆ finishPassForUser()

ilCronFinishUnfinishedTestPasses::finishPassForUser	(	$active_id,
		$obj_id
	)

protected

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

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

Referenced by processPasses().

                                                              : 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)) {
             $test = new ilObjTest($obj_id, false);
 
             $test->updateTestPassResults(
                 $active_id,
                 $test_session->getPass(),
                 $test->areObligationsEnabled(),
                 null,
                 $obj_id
             );
 
             (new ilTestPassFinishTasks($test_session, $test))->performFinishTasks($processLocker);
 
             $this->log->info('Test session with active id (' . $active_id . ') and obj_id (' . $obj_id . ') is now finished.');
         } else {
             $this->log->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:

◆ gatherUsersWithUnfinishedPasses()

ilCronFinishUnfinishedTestPasses::gatherUsersWithUnfinishedPasses ( )

protected

Definition at line 128 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 81 of file class.ilCronFinishUnfinishedTestPasses.php.

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilCronFinishUnfinishedTestPasses::getDefaultScheduleValue ( )

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

◆ getDescription()

ilCronFinishUnfinishedTestPasses::getDescription ( )

Definition at line 76 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 66 of file class.ilCronFinishUnfinishedTestPasses.php.

                            : string
     {
         return 'finish_unfinished_passes';
     }

◆ getTestsFinishAndProcessingTime()

ilCronFinishUnfinishedTestPasses::getTestsFinishAndProcessingTime ( )

protected

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

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->log->info('Gathered data for ' . count($this->test_ids) . ' test id(s) => (' . implode(',', $this->test_ids) . ')');
     }

Here is the caller graph for this function:

◆ getTitle()

ilCronFinishUnfinishedTestPasses::getTitle ( )

Definition at line 71 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 91 of file class.ilCronFinishUnfinishedTestPasses.php.

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCronFinishUnfinishedTestPasses::hasCustomSettings ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCronFinishUnfinishedTestPasses::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ processPasses()

ilCronFinishUnfinishedTestPasses::processPasses ( )

protected

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

References $data, ILIAS\LTI\ToolProvider\$key, ilObject\_exists(), and finishPassForUser().

Referenced by run().

                                       : void
     {
         $now = time();
         foreach ($this->unfinished_passes as $key => $data) {
             $test_id = $data['test_fi'];
             $can_not_be_finished = true;
             if (array_key_exists($test_id, $this->test_ending_times)) {
                 if ($this->test_ending_times[$test_id]['ending_time_enabled'] == 1) {
                     $this->log->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->finishPassForUser($data['active_id'], $this->test_ending_times[$test_id]['obj_fi']);
                         $can_not_be_finished = false;
                     } else {
                         $this->log->info('Test (' . $test_id . ') ending time (' . $this->test_ending_times[$test_id]['ending_time'] . ') > now (' . $now . ') is not reached.');
                     }
                 } else {
                     $this->log->info('Test (' . $test_id . ') has no ending time.');
                 }
                 if ($this->test_ending_times[$test_id]['enable_processing_time'] == 1) {
                     $this->log->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)) {
                         $test_obj = new ilObjTest($obj_id, false);
                         $startingTime = $test_obj->getStartingTimeOfUser($data['active_id']);
                         $max_processing_time = $test_obj->isMaxProcessingTimeReached($startingTime, $data['active_id']);
                         if ($max_processing_time) {
                             $this->log->info('Max Processing time reached for user id (' . $data['usr_id'] . ') so test with active id (' . $data['active_id'] . ') will be finished.');
                             $this->finishPassForUser($data['active_id'], $this->test_ending_times[$test_id]['obj_fi']);
                             $can_not_be_finished = false;
                         } else {
                             $this->log->info('Max Processing time not reached for user id (' . $data['usr_id'] . ') in test with active id (' . $data['active_id'] . '). Starting time: ' . $startingTime . ' Processing time: ' . $test_obj->getProcessingTime() . ' / ' . $test_obj->getProcessingTimeInSeconds() . 's');
                         }
                     } else {
                         $this->log->info('Test object with id (' . $obj_id . ') does not exist.');
                     }
                 } else {
                     $this->log->info('Test (' . $test_id . ') has no processing time.');
                 }
 
                 if ($can_not_be_finished) {
                     $this->log->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 106 of file class.ilCronFinishUnfinishedTestPasses.php.

References gatherUsersWithUnfinishedPasses(), getTestsFinishAndProcessingTime(), processPasses(), and ilCronJobResult\STATUS_OK.

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