Inheritance diagram for ilCertificateAppEventListener:

Collaboration diagram for ilCertificateAppEventListener:

Public Member Functions
	__construct (ilDBInterface $db, ilObjectDataCache $objectDataCache, ilLogger $logger)

	withComponent (string $component)

	withEvent (string $event)

	withParameters (array $parameters)

	handle ()

Static Public Member Functions
static	handleEvent (string $a_component, string $a_event, array $a_parameter)

Protected Member Functions
	isLearningAchievementEvent ()

	isUserDeletedEvent ()

	isCompletedStudyProgramme ()

Protected Attributes
ilDBInterface	$db

string	$component = ''

string	$event = ''

array	$parameters = []

Private Member Functions
	handleLPUpdate ()

	handleDeletedUser ()

	processEntry (string $type, int $objectId, int $userId, ilCertificateTemplate $template, ilSetting $settings)

	handleCompletedStudyProgramme ()

Private Attributes
ilObjectDataCache	$objectDataCache

ilLogger	$logger

ilCertificateQueueRepository	$certificateQueueRepository

ilCertificateTypeClassMap	$certificateClassMap

ilCertificateTemplateRepository	$templateRepository

ilUserCertificateRepository	$userCertificateRepository

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateAppEventListener::__construct	(	ilDBInterface	$db,
		ilObjectDataCache	$objectDataCache,
		ilLogger	$logger
	)

Definition at line 42 of file class.ilCertificateAppEventListener.php.

References $db, $logger, $objectDataCache, and ILIAS\Repository\logger().

       {
         $this->db = $db;
         $this->objectDataCache = $objectDataCache;
         $this->logger = $logger;
         $this->certificateQueueRepository = new ilCertificateQueueRepository($this->db, $this->logger);
         $this->certificateClassMap = new ilCertificateTypeClassMap();
         $this->templateRepository = new ilCertificateTemplateDatabaseRepository($this->db, $this->logger);
         $this->userCertificateRepository = new ilUserCertificateRepository($this->db, $this->logger);
     }

Here is the call graph for this function:

Member Function Documentation

◆ handle()

ilCertificateAppEventListener::handle ( )

Exceptions

IOException

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

References Vendor\Package\$e, handleCompletedStudyProgramme(), handleDeletedUser(), handleLPUpdate(), isCompletedStudyProgramme(), isLearningAchievementEvent(), isUserDeletedEvent(), and ILIAS\Repository\logger().

                             : void
     {
         try {
             if ($this->isLearningAchievementEvent()) {
                 $this->handleLPUpdate();
             } elseif ($this->isUserDeletedEvent()) {
                 $this->handleDeletedUser();
             } elseif ($this->isCompletedStudyProgramme()) {
                 $this->handleCompletedStudyProgramme();
             }
         } catch (ilException $e) {
             $this->logger->error($e->getMessage());
         }
     }

Here is the call graph for this function:

◆ handleCompletedStudyProgramme()

ilCertificateAppEventListener::handleCompletedStudyProgramme ( )

private

Definition at line 328 of file class.ilCertificateAppEventListener.php.

References ILIAS\LTI\ToolProvider\$settings, ilCronConstants\IN_PROGRESS, and ILIAS\Repository\logger().

Referenced by handle().

                                                     : void
     {
         $settings = new ilSetting('certificate');
         $objectId = $this->parameters['prg_id'] ?? 0;
         $userId = $this->parameters['usr_id'] ?? 0;
         try {
             $template = $this->templateRepository->fetchCurrentlyActiveCertificate($objectId);
             if (true === $template->isCurrentlyActive()) {
                 $entry = new ilCertificateQueueEntry(
                     $objectId,
                     $userId,
                     ilStudyProgrammePlaceholderValues::class,
                     ilCronConstants::IN_PROGRESS,
                     $template->getId(),
                     time()
                 );
                 $mode = $settings->get('persistent_certificate_mode', '');
                 if ($mode === 'persistent_certificate_mode_instant') {
                     $cronjob = new ilCertificateCron();
                     $cronjob->init();
                     $cronjob->processEntry(0, $entry, []);
                     return;
                 }
                 $this->certificateQueueRepository->addToQueue($entry);
             }
         } catch (ilException $exception) {
             $this->logger->warning($exception->getMessage());
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleDeletedUser()

ilCertificateAppEventListener::handleDeletedUser ( )

private

Exceptions

IOException

Definition at line 274 of file class.ilCertificateAppEventListener.php.

References ILIAS\Repository\logger().

Referenced by handle().

                                         : void
     {
         $portfolioFileService = new ilPortfolioCertificateFileService();
 
         if (false === array_key_exists('usr_id', $this->parameters)) {
             $this->logger->error('User ID is not added to the event. Abort.');
             return;
         }
 
         $this->logger->debug('User has been deleted. Try to delete user certificates');
 
         $userId = $this->parameters['usr_id'];
 
         $this->userCertificateRepository->deleteUserCertificates((int) $userId);
 
         $this->certificateQueueRepository->removeFromQueueByUserId((int) $userId);
 
         $portfolioFileService->deleteUserDirectory($userId);
 
         $this->logger->debug(sprintf(
             'All relevant data sources for the user certificates for user (usr_id: "%s" deleted)',
             $userId
         ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ handleEvent()

static ilCertificateAppEventListener::handleEvent	(	string	$a_component,
		string	$a_event,
		array	$a_parameter
	)

static

Parameters

string	$a_component
string	$a_event
array	$a_parameter

Exceptions

IOException

Implements ilAppEventListener.

Definition at line 131 of file class.ilCertificateAppEventListener.php.

References $DIC.

                                                                                                 : void
     {
         global $DIC;
 
         $listener = new self(
             $DIC->database(),
             $DIC['ilObjDataCache'],
             $DIC->logger()->cert()
         );
 
         $listener
             ->withComponent($a_component)
             ->withEvent($a_event)
             ->withParameters($a_parameter)
             ->handle();
     }

◆ handleLPUpdate()

ilCertificateAppEventListener::handleLPUpdate ( )

private

Definition at line 148 of file class.ilCertificateAppEventListener.php.

References $refId, ILIAS\LTI\ToolProvider\$settings, $type, ilObject\_getAllReferences(), ILIAS\Repository\int(), ILIAS\Repository\logger(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, and processEntry().

Referenced by handle().

                                      : void
     {
         $status = (int) ($this->parameters['status'] ?? ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM);
 
         $settings = new ilSetting('certificate');
 
         if ($status === ilLPStatus::LP_STATUS_COMPLETED_NUM) {
             $objectId = (int) ($this->parameters['obj_id'] ?? 0);
             $userId = (int) ($this->parameters['usr_id'] ?? 0);
 
             $type = $this->objectDataCache->lookupType($objectId);
 
             $this->logger->debug(sprintf(
                 "Certificate evaluation triggered, received 'completed' learning progress for: usr_id: %s/obj_id: %s/type: %s",
                 $userId,
                 $objectId,
                 $type
             ));
 
             if ($this->certificateClassMap->typeExistsInMap($type)) {
                 try {
                     $template = $this->templateRepository->fetchCurrentlyActiveCertificate($objectId);
 
                     if (true === $template->isCurrentlyActive()) {
                         $this->logger->debug(sprintf(
                             "Trigger persisting certificate achievement for: usr_id: %s/obj_id: %s/type: %s/template_id: %s",
                             $userId,
                             $objectId,
                             $type,
                             $template->getId()
                         ));
                         $this->processEntry($type, $objectId, $userId, $template, $settings);
                     } else {
                         $this->logger->debug(sprintf(
                             "Did not trigger certificate achievement for inactive template: usr_id: %s/obj_id: %s/type: %s/template_id: %s",
                             $userId,
                             $objectId,
                             $type,
                             $template->getId()
                         ));
                     }
                 } catch (ilException $exception) {
                     $this->logger->debug(sprintf(
                         "Did not find an active certificate template for case: usr_id: %s/obj_id: %s/type: %s",
                         $userId,
                         $objectId,
                         $type
                     ));
                 }
             } else {
                 $this->logger->debug(
                     "Object type ($type) is not of interest, skipping certificate evaluation for this object"
                 );
             }
 
             if ($type === 'crs') {
                 $this->logger->debug(
                     'Skipping handling for course, because courses cannot be certificate trigger ' .
                     '(with globally disabled learning progress) for other certificate enabled objects'
                 );
                 return;
             }
 
             $this->logger->debug(
                 'Triggering certificate evaluation of possible depending course objects ...'
             );
 
             $progressEvaluation = new ilCertificateCourseLearningProgressEvaluation(
                 new ilCachedCertificateTemplateRepository(
                     $this->templateRepository
                 )
             );
             foreach (ilObject::_getAllReferences($objectId) as $refId) {
                 $templatesOfCompletedCourses = $progressEvaluation->evaluate($refId, $userId);
                 if (0 === count($templatesOfCompletedCourses)) {
                     $this->logger->debug(sprintf(
                         "No dependent course certificate template configuration found for child object: usr_id: %s/obj_id: %s/ref_id: %s/type: %s",
                         $userId,
                         $objectId,
                         $refId,
                         $type
                     ));
                     continue;
                 }
 
                 foreach ($templatesOfCompletedCourses as $courseTemplate) {
                     // We do not check if we support the type anymore, because the type 'crs' is always supported
                     try {
                         $courseObjectId = $courseTemplate->getObjId();
 
                         if (true === $courseTemplate->isCurrentlyActive()) {
                             $type = $this->objectDataCache->lookupType($courseObjectId);
 
                             $this->logger->debug(sprintf(
                                 "Trigger persisting certificate achievement for: usr_id: %s/obj_id: %s/type: %s/template_id: %s",
                                 $userId,
                                 $courseObjectId,
                                 'crs',
                                 $courseTemplate->getId()
                             ));
                             $this->processEntry($type, $courseObjectId, $userId, $courseTemplate, $settings);
                         } else {
                             $this->logger->debug(sprintf(
                                 "Did not trigger certificate achievement for inactive template: usr_id: %s/obj_id: %s/type: %s/template_id: %s",
                                 $userId,
                                 $objectId,
                                 $type,
                                 $courseTemplate->getId()
                             ));
                         }
                     } catch (ilException $exception) {
                         $this->logger->warning($exception->getMessage());
                         continue;
                     }
                 }
             }
 
             $this->logger->debug(
                 'Finished certificate evaluation'
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isCompletedStudyProgramme()

ilCertificateAppEventListener::isCompletedStudyProgramme ( )

protected

Definition at line 99 of file class.ilCertificateAppEventListener.php.

References ILIAS\Repository\event().

Referenced by handle().

                                                   : bool
     {
         return (
             'Modules/StudyProgramme' === $this->component &&
             'userSuccessful' === $this->event
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLearningAchievementEvent()

ilCertificateAppEventListener::isLearningAchievementEvent ( )

protected

Definition at line 83 of file class.ilCertificateAppEventListener.php.

References ILIAS\Repository\event().

Referenced by handle().

                                                    : bool
     {
         return (
             'Services/Tracking' === $this->component &&
             'updateStatus' === $this->event
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUserDeletedEvent()

ilCertificateAppEventListener::isUserDeletedEvent ( )

protected

Definition at line 91 of file class.ilCertificateAppEventListener.php.

References ILIAS\Repository\event().

Referenced by handle().

                                            : bool
     {
         return (
             'Services/User' === $this->component &&
             'deleteUser' === $this->event
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processEntry()

ilCertificateAppEventListener::processEntry	(	string	$type,
		int	$objectId,
		int	$userId,
		ilCertificateTemplate	$template,
		ilSetting	$settings
	)

private

Definition at line 299 of file class.ilCertificateAppEventListener.php.

References ilSetting\get(), ilCertificateTemplate\getId(), and ilCronConstants\IN_PROGRESS.

Referenced by handleLPUpdate().

      : void {
         $className = $this->certificateClassMap->getPlaceHolderClassNameByType($type);
 
         $entry = new ilCertificateQueueEntry(
             $objectId,
             $userId,
             $className,
             ilCronConstants::IN_PROGRESS,
             $template->getId(),
             time()
         );
 
         $mode = $settings->get('persistent_certificate_mode', 'persistent_certificate_mode_cron');
         if ($mode === 'persistent_certificate_mode_instant') {
             $cronjob = new ilCertificateCron();
             $cronjob->init();
             $cronjob->processEntry(0, $entry, []);
             return;
         }
 
         $this->certificateQueueRepository->addToQueue($entry);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withComponent()

ilCertificateAppEventListener::withComponent ( string $component )

Definition at line 56 of file class.ilCertificateAppEventListener.php.

References $component.

                                                     : self
     {
         $clone = clone $this;
 
         $clone->component = $component;
 
         return $clone;
     }

◆ withEvent()

ilCertificateAppEventListener::withEvent ( string $event )

Definition at line 65 of file class.ilCertificateAppEventListener.php.

References $event.

                                             : self
     {
         $clone = clone $this;
 
         $clone->event = $event;
 
         return $clone;
     }

◆ withParameters()

ilCertificateAppEventListener::withParameters ( array $parameters )

Definition at line 74 of file class.ilCertificateAppEventListener.php.

References $parameters.

                                                      : self
     {
         $clone = clone $this;
 
         $clone->parameters = $parameters;
 
         return $clone;
     }