This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPrgUpdateProgressCronJob:

Collaboration diagram for ilPrgUpdateProgressCronJob:

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 Attributes
Pimple Container	$dic

ilLanguage	$lng

ilStudyProgrammeSettingsDBRepository	$settings_repo

ilPRGAssignmentDBRepository	$assignment_repo

int	$acting_user_id

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
const	ID = 'prg_update_progress'

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

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning This will set progresses to FAILED, if they are past the deadline (and not successful, yet)

Definition at line 25 of file class.ilPrgUpdateProgressCronJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilPrgUpdateProgressCronJob::__construct ( )

Definition at line 35 of file class.ilPrgUpdateProgressCronJob.php.

    {
        global $DIC;
        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('prg');
 
        $dic = ilStudyProgrammeDIC::dic();
        $this->settings_repo = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
        $this->assignment_repo = $dic['repo.assignment'];
        $this->acting_user_id = $dic['current_user']->getId();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilPrgUpdateProgressCronJob::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

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

                                            : int
    {
        return self::SCHEDULE_TYPE_IN_DAYS;
    }

References ilCronJob\SCHEDULE_TYPE_IN_DAYS.

◆ getDefaultScheduleValue()

ilPrgUpdateProgressCronJob::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

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

◆ getDescription()

ilPrgUpdateProgressCronJob::getDescription ( )

Reimplemented from ilCronJob.

Definition at line 52 of file class.ilPrgUpdateProgressCronJob.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilPrgUpdateProgressCronJob::getId ( )

Reimplemented from ilCronJob.

Definition at line 57 of file class.ilPrgUpdateProgressCronJob.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getTitle()

ilPrgUpdateProgressCronJob::getTitle ( )

Reimplemented from ilCronJob.

Definition at line 47 of file class.ilPrgUpdateProgressCronJob.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilPrgUpdateProgressCronJob::hasAutoActivation ( )

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

Reimplemented from ilCronJob.

Definition at line 62 of file class.ilPrgUpdateProgressCronJob.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilPrgUpdateProgressCronJob::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

Definition at line 67 of file class.ilPrgUpdateProgressCronJob.php.

                                         : bool
    {
        return true;
    }

◆ run()

ilPrgUpdateProgressCronJob::run ( )

Reimplemented from ilCronJob.

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

                         : ilCronJobResult
    {
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_NO_ACTION);
 
        $now = new DateTimeImmutable();
 
        foreach ($this->assignment_repo->getPassedDeadline($now) as $assignment) {
            $assignment = $assignment->markProgressesFailedForExpiredDeadline(
                $this->settings_repo,
                $this->acting_user_id
            );
            $this->assignment_repo->store($assignment);
        }
 
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }