ilCertificateAppEventListener Class Reference

Inheritance diagram for ilCertificateAppEventListener:

Collaboration diagram for ilCertificateAppEventListener:

Public Member Functions
	__construct (\ilDBInterface $db, \ilObjectDataCache $objectDataCache, \ilLogger $logger)
	ilCertificateAppEventListener constructor. More...
	withComponent (string $component)
	withEvent (string $event)
	withParameters (array $parameters)
	handle ()

Static Public Member Functions
static	handleEvent ($a_component, $a_event, $a_parameter)
	Handle an event in a listener. Parameters string $a_component component, e.g. "Modules/Forum" or "Services/User" string $a_event event e.g. "createUser", "updateUser", "deleteUser", ... array $a_parameter parameter array (assoc), array("name" => ..., "phone_office" => ...) More...
static	handleEvent ($a_component, $a_event, $a_parameter)
	Handle an event in a listener. More...

Protected Member Functions
	isLearningAchievementEvent ()
	isMigratingCertificateEvent ()
	isUserDeletedEvent ()

Protected Attributes
	$db
	$component = ''
	$event = ''
	$parameters = []

Private Member Functions
	handleLPUpdate ()
	handleNewMigratedUserCertificate ()
	handleDeletedUser ()
	processEntry ($type, $objectId, int $userId, ilCertificateTemplate $template, ilSetting $settings)

Private Attributes
	$objectDataCache
	$logger
	$certificateQueueRepository
	$certificateClassMap
	$templateRepository
	$userCertificateRepository
	$migrationRepository

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

ilCertificateAppEventListener constructor.

Parameters

\ilDBInterface	$db
\ilObjectDataCache	$objectDataCache
\ilLogger	$logger

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

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

References $db, $logger, and $objectDataCache.

Member Function Documentation

handle()

ilCertificateAppEventListener::handle

(

)

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

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

References handleDeletedUser(), handleLPUpdate(), handleNewMigratedUserCertificate(), isLearningAchievementEvent(), isMigratingCertificateEvent(), and isUserDeletedEvent().

Here is the call graph for this function:

handleDeletedUser()

ilCertificateAppEventListener::handleDeletedUser ( )

private

Exceptions

ILIAS\Filesystem\Exception\IOException

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

    {
        $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->info('User has been deleted. Try to delete user certificates');
 
        $userId = $this->parameters['usr_id'];
 
        $this->userCertificateRepository->deleteUserCertificates((int) $userId);
 
        $this->certificateQueueRepository->removeFromQueueByUserId((int) $userId);
 
        $this->migrationRepository->deleteFromMigrationJob((int) $userId);
 
        $portfolioFileService->deleteUserDirectory($userId);
 
        $this->logger->info(sprintf('All relevant data sources for the user certificates for user(user_id: "%s" deleted)', $userId));
    }

Referenced by handle().

Here is the caller graph for this function:

handleEvent()

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

static

Handle an event in a listener.

Parameters

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

Implements ilAppEventListener.

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

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

References $DIC.

handleLPUpdate()

ilCertificateAppEventListener::handleLPUpdate ( )

private

Exceptions

ilException

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

    {
        $status = $this->parameters['status'] ?? \ilLpStatus::LP_STATUS_NOT_ATTEMPTED_NUM;
 
        $settings = new ilSetting('certificate');
 
        if ($status == \ilLPStatus::LP_STATUS_COMPLETED_NUM) {
            $objectId = $this->parameters['obj_id'] ?? 0;
            $userId = $this->parameters['usr_id'] ?? 0;
 
            $type = $this->objectDataCache->lookupType($objectId);
 
            $this->logger->info(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->info(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->info(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->info(sprintf(
                        "Did not find an active certificate template for case: usr_id: %s/obj_id: %s/type: %s",
                        $userId,
                        $objectId,
                        $type
                    ));
                }
            } else {
                $this->logger->info(sprintf(
                    "Object type is not of interest, skipping certificate evaluation for this object"
                ));
            }
 
            if ($type === 'crs') {
                $this->logger->info(
                    'Skipping handling for course, because courses cannot be certificate trigger ' .
                    '(with globally disabled learning progress) for other certificate enabled objects'
                );
                return;
            }
 
            $this->logger->info(
                'Triggering certificate evaluation of possible depending course objects ...'
            );
 
            foreach (\ilObject::_getAllReferences($objectId) as $refId) {
                $templateRepository = new \ilCertificateTemplateRepository($this->db, $this->logger);
                $progressEvaluation = new \ilCertificateCourseLearningProgressEvaluation($templateRepository);
 
                $templatesOfCompletedCourses = $progressEvaluation->evaluate($refId, $userId);
                if (0 === count($templatesOfCompletedCourses)) {
                    $this->logger->info(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->info(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->info(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->info(
                'Finished certificate evaluation'
            );
        }
    }

References $template, $templateRepository, $type, ilObject\_getAllReferences(), ilLPStatus\LP_STATUS_COMPLETED_NUM, and processEntry().

Referenced by handle().

Here is the call graph for this function:

Here is the caller graph for this function:

handleNewMigratedUserCertificate()

ilCertificateAppEventListener::handleNewMigratedUserCertificate ( )

private

Exceptions

ilDatabaseException

Exceptions

ilException

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

    {
        $this->logger->info('Try to create new certificates based on event');
 
        if (false === array_key_exists('obj_id', $this->parameters)) {
            $this->logger->error('Object ID is not added to the event. Abort.');
            return;
        }
 
        if (false === array_key_exists('user_id', $this->parameters)) {
            $this->logger->error('User ID is not added to the event. Abort.');
            return;
        }
 
        if (false === array_key_exists('background_image_path', $this->parameters)) {
            $this->logger->error('Background Image Path is not added to the event. Abort.');
            return;
        }
 
        if (false === array_key_exists('acquired_timestamp', $this->parameters)) {
            $this->logger->error('Acquired Timestamp is not added to the event. Abort.');
            return;
        }
 
        if (false === array_key_exists('ilias_version', $this->parameters)) {
            $this->logger->error('ILIAS version is not added to the event. Abort.');
            return;
        }
 
        if (false === array_key_exists('certificate_content', $this->parameters)) {
            $this->logger->error('Certificate content is not added to the event. Abort.');
            return;
        }
 
        $objId = $this->parameters['obj_id'] ?? 0;
        $userId = $this->parameters['user_id'] ?? 0;
        $backgroundImagePath = $this->parameters['background_image_path'] ?? '';
        $acquiredTimestamp = $this->parameters['acquired_timestamp'] ?? '';
        $iliasVersion = $this->parameters['ilias_version'] ?? '';
        $certificateContent = $this->parameters['certificate_content'] ?? '';
 
        if ('' === $certificateContent) {
            $this->logger->error('Certificate content is empty. Abort.');
            return;
        }
 
        if ('' === $acquiredTimestamp || $acquiredTimestamp <= 0) {
            $this->logger->error('Acquired Timestamp is empty. Abort.');
            return;
        }
 
        $templateRepository = new \ilCertificateTemplateRepository($this->db, $this->logger);
        $template = $templateRepository->fetchFirstCreatedTemplate($objId);
 
        try {
            $certificate = $this->userCertificateRepository->fetchActiveCertificate($userId, $objId);
            $this->logger->error(sprintf('There are already certificates generated for user_id "%s" and object_id "%s". Abort.', $userId, $objId));
            return;
        } catch (ilException $exception) {
            $this->logger->info('No active user certificate found. Resume migration.');
        }
 
        $type = $this->objectDataCache->lookupType($objId);
 
        $classMap = new ilCertificateTypeClassMap();
        if (!$classMap->typeExistsInMap($type)) {
            $this->logger->error(sprintf('Migrations for type "%s" not supported. Abort.', $type));
            return;
        }
 
        $user = \ilObjectFactory::getInstanceByObjId($userId, false);
        if (!$user || !($user instanceof \ilObjUser)) {
            throw new \ilException(sprintf('The given user ID("%s") is not a user', $userId));
        }
 
        $userCertificate = new \ilUserCertificate(
            $template->getId(),
            $objId,
            $type,
            $userId,
            $user->getFullname(),
            $acquiredTimestamp,
            $certificateContent,
            '',
            null,
            1,
            $iliasVersion,
            true,
            $backgroundImagePath,
            ''
        );
 
        $this->userCertificateRepository->save($userCertificate);
    }

References $certificate, Sabre\Xml\$classMap, $template, $templateRepository, $type, $user, and ilObjectFactory\getInstanceByObjId().

Referenced by handle().

Here is the call graph for this function:

Here is the caller graph for this function:

isLearningAchievementEvent()

ilCertificateAppEventListener::isLearningAchievementEvent ( )

protected

Returns

bool

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

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

Referenced by handle().

Here is the caller graph for this function:

isMigratingCertificateEvent()

ilCertificateAppEventListener::isMigratingCertificateEvent ( )

protected

Returns

bool

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

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

Referenced by handle().

Here is the caller graph for this function:

isUserDeletedEvent()

ilCertificateAppEventListener::isUserDeletedEvent ( )

protected

Returns

bool

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

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

Referenced by handle().

Here is the caller graph for this function:

processEntry()

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

private

Parameters

	$type
	$objectId
int	$userId
ilCertificateTemplate	$template
ilSetting	$settings

Exceptions

ilDatabaseException
ilException
ilInvalidCertificateException

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

    {
        $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, array());
            return;
        }
 
        $this->certificateQueueRepository->addToQueue($entry);
    }

References $template, $type, ilSetting\get(), and ilCronConstants\IN_PROGRESS.

Referenced by handleLPUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

withComponent()

ilCertificateAppEventListener::withComponent

(

string

$component

)

Parameters

string

$component

Returns

\ilCertificateAppEventListener

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

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

References $component.

withEvent()

ilCertificateAppEventListener::withEvent

(

string

$event

)

Parameters

string

$event

Returns

\ilCertificateAppEventListener

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

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

References $event.

withParameters()

ilCertificateAppEventListener::withParameters

(

array

$parameters

)

Parameters

array

$parameters

Returns

\ilCertificateAppEventListener

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

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

References $parameters.

Field Documentation

$certificateClassMap

ilCertificateAppEventListener::$certificateClassMap

private

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

$certificateQueueRepository

ilCertificateAppEventListener::$certificateQueueRepository

private

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

$component

ilCertificateAppEventListener::$component = ''

protected

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

Referenced by withComponent().

$db

ilCertificateAppEventListener::$db

protected

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

Referenced by __construct().

$event

ilCertificateAppEventListener::$event = ''

protected

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

Referenced by withEvent().

$logger

ilCertificateAppEventListener::$logger

private

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

Referenced by __construct().

$migrationRepository

ilCertificateAppEventListener::$migrationRepository

private

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

$objectDataCache

ilCertificateAppEventListener::$objectDataCache

private

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

Referenced by __construct().

$parameters

ilCertificateAppEventListener::$parameters = []

protected

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

Referenced by withParameters().

$templateRepository

ilCertificateAppEventListener::$templateRepository

private

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

Referenced by handleLPUpdate(), and handleNewMigratedUserCertificate().

$userCertificateRepository

ilCertificateAppEventListener::$userCertificateRepository

private

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

---

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

• Services/Certificate/classes/class.ilCertificateAppEventListener.php