Class ilCronFinishUnfinishedTestPasses. More...

Inheritance diagram for ilCronFinishUnfinishedTestPasses:

Collaboration diagram for ilCronFinishUnfinishedTestPasses:

Public Member Functions
	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	run ()
	Run job. More...

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

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

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

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

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

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Protected Member Functions
	gatherUsersWithUnfinishedPasses ()

	getTestsFinishAndProcessingTime ()

	processPasses ()

	finishPassForUser ($active_id, $obj_id)

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$log

	$lng

	$db

	$obj_data_cache

	$now

	$unfinished_passes

	$test_ids

	$test_ending_times

	$processLockerFactory

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Detailed Description

Class ilCronFinishUnfinishedTestPasses.

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

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

Member Function Documentation

◆ finishPassForUser()

ilCronFinishUnfinishedTestPasses::finishPassForUser	(	$active_id,
		$obj_id
	)

protected

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

    {
        $this->processLockerFactory->setActiveId($active_id);
        $processLocker = $this->processLockerFactory->getLocker();
        
        $pass_finisher = new ilTestPassFinishTasks($active_id, $obj_id);
        $pass_finisher->performFinishTasks($processLocker);
        
        $this->log->info('Test session with active id (' . $active_id . ') and obj_id (' . $obj_id . ') is now finished.');
    }

Referenced by processPasses().

Here is the caller graph for this function:

◆ gatherUsersWithUnfinishedPasses()

ilCronFinishUnfinishedTestPasses::gatherUsersWithUnfinishedPasses ( )

protected

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

    {
        $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'];
        }
    }

References $query, $result, and $row.

Referenced by run().

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCronFinishUnfinishedTestPasses::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCronFinishUnfinishedTestPasses::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return;
    }

◆ getDescription()

ilCronFinishUnfinishedTestPasses::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $lng;
 
        return $lng->txt("finish_unfinished_passes_desc");
    }

References $lng.

◆ getId()

ilCronFinishUnfinishedTestPasses::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return 'finish_unfinished_passes';
    }

◆ getTestsFinishAndProcessingTime()

ilCronFinishUnfinishedTestPasses::getTestsFinishAndProcessingTime ( )

protected

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

    {
        $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) . ')');
    }

References $query, $result, and $row.

Referenced by run().

Here is the caller graph for this function:

◆ getTitle()

ilCronFinishUnfinishedTestPasses::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

    {
        global $lng;
 
        return $lng->txt("finish_unfinished_passes");
    }

References $lng.

◆ hasAutoActivation()

ilCronFinishUnfinishedTestPasses::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ hasCustomSettings()

ilCronFinishUnfinishedTestPasses::hasCustomSettings ( )

Has cron job any custom setting which can be edited?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCronFinishUnfinishedTestPasses::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ processPasses()

ilCronFinishUnfinishedTestPasses::processPasses ( )

protected

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

    {
        $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'];
                    $test_obj                           = new ilObjTest($obj_id, false);
                    $startingTime                       = $test_obj->getStartingTimeOfUser($data['active_id'], $data['last_started_pass']);
                    $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('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.');
                }
            }
        }
    }

References $data, $key, $now, and finishPassForUser().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilCronFinishUnfinishedTestPasses::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        $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;
    }