Inheritance diagram for ilCertificateCron:

Collaboration diagram for ilCertificateCron:

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

	getTitle ()

	getDescription ()

	init ()

	run ()

	getId ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

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

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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
ilLanguage	$lng

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Private Attributes
Container	$dic

Detailed Description

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, $dic, ILIAS\DI\Container\language(), and ILIAS\Repository\lng().

       {
         if (null === $dic) {
             global $DIC;
             $dic = $DIC;
         }
         $this->dic = $dic;
 
         if ($dic && isset($dic['lng'])) {
             $language = $dic->language();
             $language->loadLanguageModule('certificate');
         }
 
         $this->lng = $language;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getDefaultScheduleType()

ilCertificateCron::getDefaultScheduleType ( )

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

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_IN_MINUTES;
     }

◆ getDefaultScheduleValue()

ilCertificateCron::getDefaultScheduleValue ( )

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

References $objId, ilCertificateQueueEntry\getAdapterClass(), ilCertificateQueueEntry\getId(), getId(), ilCertificateQueueEntry\getObjId(), ilCertificateQueueEntry\getStartedTimestamp(), ilCertificateQueueEntry\getTemplateId(), ilCertificateQueueEntry\getUserId(), ILIAS_VERSION_NUMERIC, ILIAS\Repository\logger(), and processEntry().

Here is the call graph for this function:

◆ getDescription()

ilCertificateCron::getDescription ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilCertificateCron::getId ( )

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

Referenced by getDefaultScheduleValue().

                            : string
     {
         return 'certificate';
     }

Here is the caller graph for this function:

◆ getTitle()

ilCertificateCron::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ hasAutoActivation()

ilCertificateCron::hasAutoActivation ( )

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

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCertificateCron::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ init()

ilCertificateCron::init ( )

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

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

Referenced by run().

                           : 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');
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilCertificateCron::run ( )

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

References init(), ILIAS\Repository\logger(), processEntry(), ILIAS\Repository\settings(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and ilStr\subStr().

                          : 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 ($succeededGenerations !== []) {
             $message = sprintf(
                 'Generated %s certificate(s) in run. Result: %s',
                 count($succeededGenerations),
                 implode(' | ', $succeededGenerations)
             );
             $this->logger->info($message);
             $result->setMessage(ilStr::subStr($message, 0, 400));
         } else {
             $result->setMessage('0 certificates generated in current run.');
         }
 
         return $result;
     }

Here is the call graph for this function:

Field Documentation

◆ $dic

Container ilCertificateCron::$dic

private

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

Referenced by __construct().

◆ $lng

ilLanguage ilCertificateCron::$lng

protected

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

The documentation for this class was generated from the following file:

components/ILIAS/Certificate/classes/class.ilCertificateCron.php

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ init()

◆ run()

Field Documentation

◆ $dic

◆ $lng