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, \ILIAS\DI\Container $dic=null, ilLanguage $language=null, ilCertificateObjectHelper $objectHelper=null, ilSetting $setting=null)

	getTitle ()

	getDescription ()

	init ()

	run ()

	getId ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $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...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	DEFAULT_SCHEDULE_HOURS = 1

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Attributes
	$lng

Private Attributes
	$queueRepository
	@var ilCertificateQueueRepository More...

	$templateRepository

	$userRepository

	$logger

	$valueReplacement

	$objectHelper

	$dic

	$settings

Additional Inherited Members
Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Detailed Description

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

Definition at line 7 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`,
		\ILIAS\DI\Container	$dic = `null`,
		ilLanguage	$language = `null`,
		ilCertificateObjectHelper	$objectHelper = `null`,
		ilSetting	$setting = `null`
	)

Parameters

ilCertificateQueueRepository	$queueRepository
ilCertificateTemplateRepository	$templateRepository
ilUserCertificateRepository	$userRepository
ilCertificateValueReplacement \| null	$valueReplacement
ilLogger \| null	$logger
\ILIAS\DI\Container \| null	$dic
ilLanguage \| null	$language
ilCertificateObjectHelper \| null	$objectHelper
ilSetting \| null	$setting

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

References $DIC, $dic, $language, $logger, $objectHelper, $queueRepository, $templateRepository, $userRepository, $valueReplacement, and settings().

       {
         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;
 
         if ($dic) {
             if (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 230 of file class.ilCertificateCron.php.

     {
         return self::SCHEDULE_TYPE_IN_MINUTES;
     }

◆ getDefaultScheduleValue()

ilCertificateCron::getDefaultScheduleValue ( )

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

References $template, $type, ilCertificateQueueEntry\getAdapterClass(), ilCertificateQueueEntry\getId(), getId(), ilCertificateQueueEntry\getObjId(), ilCertificateQueueEntry\getStartedTimestamp(), ilCertificateQueueEntry\getTemplateId(), ilCertificateQueueEntry\getUserId(), ILIAS_VERSION_NUMERIC, and ilCronManager\ping().

     {
         return 1;
     }

Here is the call graph for this function:

◆ getDescription()

ilCertificateCron::getDescription ( )

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

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

◆ getId()

ilCertificateCron::getId ( )

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

Referenced by getDefaultScheduleValue().

     {
         return 'certificate';
     }

Here is the caller graph for this function:

◆ getTitle()

ilCertificateCron::getTitle ( )

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

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

◆ hasAutoActivation()

ilCertificateCron::hasAutoActivation ( )

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

     {
         return true;
     }

◆ hasFlexibleSchedule()

ilCertificateCron::hasFlexibleSchedule ( )

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

     {
         return true;
     }

◆ init()

ilCertificateCron::init ( )

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

References $DIC, and settings().

Referenced by run().

     {
         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->queueRepository) {
             $this->queueRepository = new ilCertificateQueueRepository($database, $this->logger);
         }
 
         if (null === $this->templateRepository) {
             $this->templateRepository = new ilCertificateTemplateRepository($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 ( )

Exceptions

ilDatabaseException

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

References $result, init(), settings(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

     {
         $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->info('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;
     }

Here is the call graph for this function:

Field Documentation

◆ $dic

ilCertificateCron::$dic

private

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

Referenced by __construct().

◆ $lng

ilCertificateCron::$lng

protected

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

◆ $logger

ilCertificateCron::$logger

private

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

Referenced by __construct().

◆ $objectHelper

ilCertificateCron::$objectHelper

private

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

Referenced by __construct().

◆ $queueRepository

ilCertificateCron::$queueRepository

private

@var ilCertificateQueueRepository

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

Referenced by __construct().

◆ $settings

ilCertificateCron::$settings

private

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

◆ $templateRepository

ilCertificateCron::$templateRepository

private

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

Referenced by __construct().

◆ $userRepository

ilCertificateCron::$userRepository

private

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

Referenced by __construct().

◆ $valueReplacement

ilCertificateCron::$valueReplacement

private

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

Referenced by __construct().

◆ DEFAULT_SCHEDULE_HOURS

const ilCertificateCron::DEFAULT_SCHEDULE_HOURS = 1

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

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

Services/Certificate/classes/class.ilCertificateCron.php

Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ hasAutoActivation()

◆ hasFlexibleSchedule()

◆ init()

◆ run()

Field Documentation

◆ $dic

◆ $lng

◆ $logger

◆ $objectHelper

◆ $queueRepository

◆ $settings

◆ $templateRepository

◆ $userRepository

◆ $valueReplacement

◆ DEFAULT_SCHEDULE_HOURS