Inform a user, that her qualification is about to expire. More...

Inheritance diagram for ilPrgUserNotRestartedCronJob:

Collaboration diagram for ilPrgUserNotRestartedCronJob:

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 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
	getNow ()

	log (string $msg)

Protected Attributes
ilComponentLogger	$log

ilLanguage	$lng

ilPRGAssignmentDBRepository	$assignment_repo

ilPrgCronJobAdapter	$adapter

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

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
const	ID = 'prg_user_not_restarted'

Detailed Description

Inform a user, that her qualification is about to expire.

Definition at line 28 of file class.ilPrgUserNotRestartedCronJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilPrgUserNotRestartedCronJob::__construct ( )

Definition at line 37 of file class.ilPrgUserNotRestartedCronJob.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.notRestarted'];
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUserNotRestartedCronJob::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 74 of file class.ilPrgUserNotRestartedCronJob.php.

                                            : JobScheduleType
    {
        return JobScheduleType::IN_DAYS;
    }

◆ getDefaultScheduleValue()

ilPrgUserNotRestartedCronJob::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 79 of file class.ilPrgUserNotRestartedCronJob.php.

◆ getDescription()

ilPrgUserNotRestartedCronJob::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 54 of file class.ilPrgUserNotRestartedCronJob.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilPrgUserNotRestartedCronJob::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 59 of file class.ilPrgUserNotRestartedCronJob.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getNow()

ilPrgUserNotRestartedCronJob::getNow ( )

protected

Reimplemented in ilPrgUserNotRestartedCronJobMock.

Definition at line 124 of file class.ilPrgUserNotRestartedCronJob.php.

                               : DateTimeImmutable
    {
        return new DateTimeImmutable();
    }

Referenced by run().

Here is the caller graph for this function:

◆ getTitle()

ilPrgUserNotRestartedCronJob::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 49 of file class.ilPrgUserNotRestartedCronJob.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgUserNotRestartedCronJob::hasAutoActivation ( )

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

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 64 of file class.ilPrgUserNotRestartedCronJob.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilPrgUserNotRestartedCronJob::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 69 of file class.ilPrgUserNotRestartedCronJob.php.

                                         : bool
    {
        return true;
    }

◆ log()

ilPrgUserNotRestartedCronJob::log ( string $msg )

protected

Reimplemented in ilPrgUserNotRestartedCronJobMock.

Definition at line 129 of file class.ilPrgUserNotRestartedCronJob.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()

ilPrgUserNotRestartedCronJob::run ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                         : JobResult
    {
        $result = new JobResult();
        $result->setStatus(JobResult::STATUS_NO_ACTION);
 
        $programmes_to_send = $this->adapter->getRelevantProgrammeIds();
        if (count($programmes_to_send) == 0) {
            return $result;
        }
 
        $today = $this->getNow();
        $programmes_and_due = [];
        foreach ($programmes_to_send as $programme_obj_id => $days_offset_mail) {
            $interval = new DateInterval('P' . $days_offset_mail . 'D');
            $due = $today->add($interval);
            $programmes_and_due[$programme_obj_id] = $due;
        }
 
        $assignments = $this->assignment_repo->getAboutToExpire($programmes_and_due, true);
 
        if (count($assignments) == 0) {
            return $result;
        }
        foreach ($assignments as $ass) {
            $pgs = $ass->getProgressTree();
            $this->log(
                sprintf(
                    'PRG, UserNotRestarted: user %s\'s qualification is about to expire at assignment %s (prg obj_id %s)',
                    $ass->getUserId(),
                    $ass->getId(),
                    $pgs->getNodeId()
                )
            );
            $this->adapter->actOnSingleAssignment($ass);
            $this->assignment_repo->storeExpiryInfoSentFor($ass);
        }
        $result->setStatus(JobResult::STATUS_OK);
        return $result;
    }