Inheritance diagram for ilCertificateAppEventListener:

Collaboration diagram for ilCertificateAppEventListener:

Public Member Functions
	__construct (private readonly UserCertificateApiInterface $user_certificate_api, private readonly ilDBInterface $db, private readonly ilObjectDataCache $objectDataCache, private readonly 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)
	Handle an event in a listener. More...

static	handleEvent (string $a_component, string $a_event, array $a_parameter)
	Handle an event in a listener. More...

Protected Member Functions
	isLearningAchievementEvent ()

	isUserDeletedEvent ()

Private Member Functions
	handleLPUpdate ()

	handleDeletedUser ()

Private Attributes
string	$component = ''

string	$event = ''

array	$parameters = []

readonly ilCertificateQueueRepository	$certificateQueueRepository

readonly ilCertificateTemplateRepository	$templateRepository

readonly ilUserCertificateRepository	$userCertificateRepository

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilCertificateAppEventListener::__construct	(	private readonly UserCertificateApiInterface	$user_certificate_api,
		private readonly ilDBInterface	$db,
		private readonly ilObjectDataCache	$objectDataCache,
		private readonly ilLogger	$logger
	)

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

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

References ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ handle()

ilCertificateAppEventListener::handle ( )

Exceptions

IOException

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

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

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

Here is the call graph for this function:

◆ handleDeletedUser()

ilCertificateAppEventListener::handleDeletedUser ( )

private

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

                                        : void
    {
        if (!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 = (int) $this->parameters['usr_id'];
 
        $this->userCertificateRepository->deleteUserCertificates($userId);
        $this->certificateQueueRepository->removeFromQueueByUserId($userId);
 
        $portfolioFileService = new ilPortfolioCertificateFileService();
        $portfolioFileService->deleteUserDirectory($userId);
 
        $this->logger->debug(sprintf(
            'All relevant data sources for the user certificates for user (usr_id: "%s" deleted)',
            $userId
        ));
    }

References ILIAS\Repository\int(), ILIAS\Repository\logger(), and ILIAS\UI\examples\Prompt\Standard\parameters().

Referenced by handle().

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

Handle an event in a listener.

Parameters

string	$a_component	component, e.g. "components/ILIAS/Forum" or "components/ILIAS/User"
string	$a_event	event e.g. "createUser", "updateUser", "deleteUser", ...
	array<string,mixed>	$a_parameter parameter array (assoc), array("name" => ..., "phone_office" => ...)

Implements ilAppEventListener.

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

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

References $DIC.

◆ handleLPUpdate()

ilCertificateAppEventListener::handleLPUpdate ( )

private

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

                                     : void
    {
        $status = (int) ($this->parameters['status'] ?? ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM);
        if ($status !== ilLPStatus::LP_STATUS_COMPLETED_NUM) {
            return;
        }
 
        $object_id = (int) ($this->parameters['obj_id'] ?? 0);
        $usr_id = (int) ($this->parameters['usr_id'] ?? 0);
        $type = $this->objectDataCache->lookupType($object_id);
 
        $this->logger->debug(sprintf(
            "Certificate evaluation triggered, received 'completed' learning progress for: usr_id: %s/obj_id: %s/type: %s",
            $usr_id,
            $object_id,
            $type
        ));
 
        try {
            $this->user_certificate_api->certificateCriteriaMet(
                $usr_id,
                $object_id
            );
        } catch (ilCouldNotFindCertificateTemplate | ilCertificateConsumerNotSupported) {
            $this->logger->debug(sprintf(
                'Consumer not supported, or did not find an active certificate template for case: usr_id: %s/obj_id: %s/type: %s',
                $usr_id,
                $object_id,
                $type
            ));
        } catch (ilException $e) {
            $this->logger->warning($e->getMessage());
        }
 
        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 CertificateCourseLearningProgressEvaluation(
            new ilCachedCertificateTemplateRepository(
                $this->templateRepository
            )
        );
        foreach (ilObject::_getAllReferences($object_id) as $refId) {
            $templatesOfCompletedCourses = $progressEvaluation->evaluate($refId, $usr_id);
            if ([] === $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',
                    $usr_id,
                    $object_id,
                    $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 {
                    $this->user_certificate_api->certificateCriteriaMetForGivenTemplate(
                        $usr_id,
                        $courseTemplate
                    );
                } catch (ilException $e) {
                    $this->logger->warning($e->getMessage());
                    continue;
                }
            }
        }
 
        $this->logger->debug(
            'Finished certificate evaluation'
        );
    }

References Vendor\Package\$e, $refId, ilObject\_getAllReferences(), ILIAS\Repository\int(), ILIAS\Repository\logger(), ilLPStatus\LP_STATUS_COMPLETED_NUM, ilLPStatus\LP_STATUS_NOT_ATTEMPTED_NUM, ILIAS\Repository\objectDataCache(), and ILIAS\UI\examples\Prompt\Standard\parameters().

Referenced by handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLearningAchievementEvent()

ilCertificateAppEventListener::isLearningAchievementEvent ( )

protected

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

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

References ILIAS\Repository\event().

Referenced by handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUserDeletedEvent()

ilCertificateAppEventListener::isUserDeletedEvent ( )

protected

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

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

References ILIAS\Repository\event().

Referenced by handle().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withComponent()

ilCertificateAppEventListener::withComponent ( string $component )

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

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

References $component.

◆ withEvent()

ilCertificateAppEventListener::withEvent ( string $event )

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

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

References $event.

◆ withParameters()

ilCertificateAppEventListener::withParameters ( array $parameters )

Parameters

array<string,mixed> $parameters

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

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