Inheritance diagram for ilCertificateCron:

Collaboration diagram for ilCertificateCron:

Public Member Functions
	__construct (?ilCertificateQueueRepository $queueRepository=null, ?ilCertificateTemplateRepository $templateRepository=null, ?ilUserCertificateRepository $userRepository=null, ?ilCertificateValueReplacement $valueReplacement=null, ?ilLogger $logger=null, ?Container $dic=null, ?ilLanguage $language=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilSetting $setting=null, ?ilCronManager $cronManager=null)

	getTitle ()

	getDescription ()

	init ()

	run ()

	getId ()

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

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

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

Data Fields
const	DEFAULT_SCHEDULE_HOURS = 1

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...

Protected Attributes
ilLanguage	$lng

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
ilCertificateQueueRepository	$queueRepository

ilCertificateTemplateRepository	$templateRepository

ilUserCertificateRepository	$userRepository

ilLogger	$logger

ilCertificateValueReplacement	$valueReplacement

ilCertificateObjectHelper	$objectHelper

Container	$dic = null

ilSetting	$settings

ilCronManager	$cronManager

Detailed Description

Author: Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

Definition at line 26 of file class.ilCertificateCron.php.

Constructor & Destructor Documentation

◆ __construct()

ilCertificateCron::__construct	(	?ilCertificateQueueRepository	$queueRepository = `null`,
		?ilCertificateTemplateRepository	$templateRepository = `null`,
		?ilUserCertificateRepository	$userRepository = `null`,
		?ilCertificateValueReplacement	$valueReplacement = `null`,
		?ilLogger	$logger = `null`,
		?Container	$dic = `null`,
		?ilLanguage	$language = `null`,
		?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilSetting	$setting = `null`,
		?ilCronManager	$cronManager = `null`
	)

Definition at line 41 of file class.ilCertificateCron.php.

      {
        if (null === $dic) {
            global $DIC;
            $dic = $DIC;
        }
        $this->dic = $dic;
 
        $this->queueRepository = $queueRepository;
        $this->templateRepository = $templateRepository;
        $this->userRepository = $userRepository;
        $this->valueReplacement = $valueReplacement;
        $this->logger = $logger;
        $this->objectHelper = $objectHelper;
        $this->settings = $setting;
        $this->cronManager = $cronManager;
 
        if ($dic && isset($dic['lng'])) {
            $language = $dic->language();
            $language->loadLanguageModule('certificate');
        }
 
        $this->lng = $language;
    }

References $cronManager, $DIC, $dic, $logger, $objectHelper, $queueRepository, $templateRepository, $userRepository, $valueReplacement, ILIAS\DI\Container\language(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCertificateCron::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

Definition at line 207 of file class.ilCertificateCron.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_IN_MINUTES;
    }

References ilCronJob\SCHEDULE_TYPE_IN_MINUTES.

◆ getDefaultScheduleValue()

ilCertificateCron::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

Definition at line 212 of file class.ilCertificateCron.php.

◆ getDescription()

ilCertificateCron::getDescription ( )

Reimplemented from ilCronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilCertificateCron::getId ( )

Reimplemented from ilCronJob.

Definition at line 192 of file class.ilCertificateCron.php.

                           : string
    {
        return 'certificate';
    }

◆ getTitle()

ilCertificateCron::getTitle ( )

Reimplemented from ilCronJob.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ hasAutoActivation()

ilCertificateCron::hasAutoActivation ( )

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

Reimplemented from ilCronJob.

Definition at line 197 of file class.ilCertificateCron.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCertificateCron::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

Definition at line 202 of file class.ilCertificateCron.php.

                                         : bool
    {
        return true;
    }

◆ init()

ilCertificateCron::init ( )

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

                          : void
    {
        if (null === $this->dic) {
            global $DIC;
            $this->dic = $DIC;
        }
 
        $database = $this->dic->database();
 
        if (null === $this->logger) {
            $this->logger = $this->dic->logger()->cert();
        }
 
        if (null === $this->cronManager) {
            $this->cronManager = $this->dic->cron()->manager();
        }
 
        if (null === $this->queueRepository) {
            $this->queueRepository = new ilCertificateQueueRepository($database, $this->logger);
        }
 
        if (null === $this->templateRepository) {
            $this->templateRepository = new ilCertificateTemplateDatabaseRepository($database, $this->logger);
        }
 
        if (null === $this->userRepository) {
            $this->userRepository = new ilUserCertificateRepository($database, $this->logger);
        }
 
        if (null === $this->valueReplacement) {
            $this->valueReplacement = new ilCertificateValueReplacement();
        }
 
        if (null === $this->objectHelper) {
            $this->objectHelper = new ilCertificateObjectHelper();
        }
 
        if (null === $this->settings) {
            $this->settings = new ilSetting('certificate');
        }
    }

References $DIC, ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilCertificateCron::run ( )

Reimplemented from ilCronJob.

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

                         : ilCronJobResult
    {
        $this->init();
 
        $result = new ilCronJobResult();
        $result->setStatus(ilCronJobResult::STATUS_NO_ACTION);
 
        $currentMode = $this->settings->get('persistent_certificate_mode', 'persistent_certificate_mode_cron');
        if ($currentMode !== 'persistent_certificate_mode_cron') {
            $this->logger->warning(sprintf(
                'Will not start cron job, because the mode is not set as cron job. Current Mode in settings: "%s"',
                $currentMode
            ));
            return $result;
        }
 
        $this->logger->debug('START - Begin with cron job to create user certificates from templates');
 
        $entries = $this->queueRepository->getAllEntriesFromQueue();
 
        $status = ilCronJobResult::STATUS_OK;
 
        $entryCounter = 0;
        $succeededGenerations = [];
        foreach ($entries as $entry) {
            try {
                $succeededGenerations = $this->processEntry(
                    $entryCounter,
                    $entry,
                    $succeededGenerations
                );
 
                ++$entryCounter;
            } catch (ilInvalidCertificateException $exception) {
                $this->logger->warning($exception->getMessage());
                $this->logger->warning('The user MAY not be able to achieve the certificate based on the adapters settings');
                $this->logger->warning('Due the error, the entry will now be removed from the queue.');
 
                $this->queueRepository->removeFromQueue($entry->getId());
 
                continue;
            } catch (ilException $exception) {
                $this->logger->warning($exception->getMessage());
                $this->logger->warning('Due the error, the entry will now be removed from the queue.');
 
                $this->queueRepository->removeFromQueue($entry->getId());
                continue;
            }
        }
 
        $result->setStatus($status);
        if (count($succeededGenerations) > 0) {
            $result->setMessage(sprintf(
                'Generated %s certificate(s) in run. Result: %s',
                count($succeededGenerations),
                implode(' | ', $succeededGenerations)
            ));
        } else {
            $result->setMessage('0 certificates generated in current run.');
        }
 
        return $result;
    }