class.ilPrgInvalidateExpiredProgressesCronJob.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Cron\Job\Schedule\JobScheduleType;
use ILIAS\Cron\Job\JobResult;
use ILIAS\Cron\CronJob;

/*
 * This invalidates a successful progress if validityOfQualification is reached.
 *
 * This is deprecated, I think.
 * It is perfectly feasible to raise some event for this, though,
 * but invalidation is reached by a date rather than a flag set by a cron job.
 */
class ilPrgInvalidateExpiredProgressesCronJob extends CronJob
{
    private const ID = 'prg_invalidate_expired_progresses';

    protected ilComponentLogger $log;
    protected ilLanguage $lng;
    protected ilPRGAssignmentDBRepository $assignment_repo;
    protected ilStudyProgrammeSettingsDBRepository $settings_repo;

    public function __construct()
    {
        global $DIC;
        $this->log = $DIC['ilLog'];
        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('prg');

        $dic = ilStudyProgrammeDIC::dic();
        $this->assignment_repo = $dic['repo.assignment'];
        $this->settings_repo = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
    }

    public function getTitle(): string
    {
        return $this->lng->txt('prg_invalidate_expired_progresses_title');
    }

    public function getDescription(): string
    {
        return $this->lng->txt('prg_invalidate_expired_progresses_desc');
    }

    public function getId(): string
    {
        return self::ID;
    }

    public function hasAutoActivation(): bool
    {
        return true;
    }

    public function hasFlexibleSchedule(): bool
    {
        return true;
    }

    public function getDefaultScheduleType(): JobScheduleType
    {
        return JobScheduleType::IN_DAYS;
    }

    public function getDefaultScheduleValue(): ?int
    {
        return 1;
    }

    public function run(): JobResult
    {
        $result = new JobResult();
        $expired = $this->assignment_repo->getExpiredAndNotInvalidated();

        if ($expired === []) {
            $result->setStatus(JobResult::STATUS_NO_ACTION);
            return $result;
        }

        foreach ($expired as $assignment) {
            try {
                $assignment = $assignment->invalidate($this->settings_repo);
                $this->assignment_repo->store($assignment);
            } catch (ilException $e) {
                $this->log->write('an error occured: ' . $e->getMessage());
                $result->setStatus(JobResult::STATUS_FAIL);
                return $result;
            }
        }

        $result->setStatus(JobResult::STATUS_OK);
        return $result;
    }
}