Re-assign users (according to restart-date). More...

Inheritance diagram for ilPrgRestartAssignmentsCronJob:

Collaboration diagram for ilPrgRestartAssignmentsCronJob:

Public Member Functions
	__construct ()

	getTitle ()

	getDescription ()

	getId ()

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

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	run ()

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

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

	getNow ()

	log (string $msg)

Protected Attributes
ilComponentLogger	$log

ilLanguage	$lng

ilPRGAssignmentDBRepository	$assignment_repo

ilPrgCronJobAdapter	$adapter

array	$prgs = []

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
const	ID = 'prg_restart_assignments_temporal_progress'

const	ACTING_USR_ID = -1

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated This will be replaced with an ENUM in ILIAS 9 More...

Detailed Description

Re-assign users (according to restart-date).

This will result in a new/additional assignment

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

Constructor & Destructor Documentation

◆ __construct()

ilPrgRestartAssignmentsCronJob::__construct ( )

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

    {
        global $DIC;
        $this->log = $DIC['ilLog'];
        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('prg');
 
        $dic = ilStudyProgrammeDIC::dic();
        $this->assignment_repo = $dic['repo.assignment'];
        $this->adapter = $dic['cron.restart'];
    }

References $DIC, $dic, ilStudyProgrammeDIC\dic(), ILIAS\Repository\lng(), and log().

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgRestartAssignmentsCronJob::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

Definition at line 76 of file class.ilPrgRestartAssignmentsCronJob.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_IN_DAYS;
    }

References ilCronJob\SCHEDULE_TYPE_IN_DAYS.

◆ getDefaultScheduleValue()

ilPrgRestartAssignmentsCronJob::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

Definition at line 81 of file class.ilPrgRestartAssignmentsCronJob.php.

◆ getDescription()

ilPrgRestartAssignmentsCronJob::getDescription ( )

Reimplemented from ilCronJob.

Definition at line 56 of file class.ilPrgRestartAssignmentsCronJob.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilPrgRestartAssignmentsCronJob::getId ( )

Reimplemented from ilCronJob.

Definition at line 61 of file class.ilPrgRestartAssignmentsCronJob.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getNow()

ilPrgRestartAssignmentsCronJob::getNow ( )

protected

Reimplemented in ilPrgRestartAssignmentsCronJobMock.

Definition at line 153 of file class.ilPrgRestartAssignmentsCronJob.php.

                               : DateTimeImmutable
    {
        return new DateTimeImmutable();
    }

Referenced by run().

Here is the caller graph for this function:

◆ getStudyProgramme()

ilPrgRestartAssignmentsCronJob::getStudyProgramme ( int $prg_obj_id )

protected

Reimplemented in ilPrgRestartAssignmentsCronJobMock.

Definition at line 145 of file class.ilPrgRestartAssignmentsCronJob.php.

                                                         : ilObjStudyProgramme
    {
        if (!array_key_exists($prg_obj_id, $this->prgs)) {
            $this->prgs[$prg_obj_id] = ilObjStudyProgramme::getInstanceByObjId($prg_obj_id);
        }
        return $this->prgs[$prg_obj_id];
    }

References ilObjStudyProgramme\getInstanceByObjId().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilPrgRestartAssignmentsCronJob::getTitle ( )

Reimplemented from ilCronJob.

Definition at line 51 of file class.ilPrgRestartAssignmentsCronJob.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgRestartAssignmentsCronJob::hasAutoActivation ( )

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

Reimplemented from ilCronJob.

Definition at line 66 of file class.ilPrgRestartAssignmentsCronJob.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilPrgRestartAssignmentsCronJob::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

Definition at line 71 of file class.ilPrgRestartAssignmentsCronJob.php.

                                         : bool
    {
        return true;
    }

◆ log()

ilPrgRestartAssignmentsCronJob::log ( string $msg )

protected

Reimplemented in ilPrgRestartAssignmentsCronJobMock.

Definition at line 158 of file class.ilPrgRestartAssignmentsCronJob.php.

                                       : void
    {
        $this->log->write($msg);
    }

References log().

Referenced by __construct(), log(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilPrgRestartAssignmentsCronJob::run ( )

Reimplemented from ilCronJob.

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

                         : ilCronJobResult
    {
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_NO_ACTION);
 
        $programmes_to_reassign = $this->adapter->getRelevantProgrammeIds();
        if (count($programmes_to_reassign) === 0) {
            return $result;
        }
 
        $today = $this->getNow();
        $programmes_and_due = [];
 
        foreach ($programmes_to_reassign as $programme_obj_id => $days_offset) {
            $interval = new DateInterval('P' . $days_offset . 'D');
            $due = $today->add($interval);
            $programmes_and_due[$programme_obj_id] = $due;
        }
 
        $assignments = $this->assignment_repo->getAboutToExpire($programmes_and_due, false);
 
        if (count($assignments) === 0) {
            return $result;
        }
 
        foreach ($assignments as $ass) {
            if ($ass->getRestartedAssignmentId() < 0) {
                $prg = $this->getStudyProgramme($ass->getRootId());
 
                $restart_settings = $prg->getSettings()->getValidityOfQualificationSettings();
                if ($restart_settings->getRestartRecheck()
                    && !$ass->isManuallyAssigned()
                    && !$prg->getApplicableMembershipSourceForUser($ass->getUserId(), null)
                ) {
                    continue;
                }
 
                $this->log(
                    sprintf(
                        'PRG, RestartAssignments: user %s\'s assignment %s is being restarted (Programme %s)',
                        $ass->getUserId(),
                        $ass->getId(),
                        $ass->getRootId()
                    )
                );
 
                $restarted = $prg->assignUser($ass->getUserId(), self::ACTING_USR_ID, false);
                $ass = $ass->withRestarted($restarted->getId(), $today);
                $this->assignment_repo->store($ass);
 
                $this->adapter->actOnSingleAssignment($restarted);
 
                $result->setStatus(ilCronJobResult::STATUS_OK);
            }
        }
 
        return $result;
    }