Inheritance diagram for ILIAS\Certificate\API\UserCertificateAPI:

Collaboration diagram for ILIAS\Certificate\API\UserCertificateAPI:

Public Member Functions
	__construct (?UserDataRepository $user_data_repository=null, ?ilCertificateTemplateRepository $template_repository=null, ?ilCertificateQueueRepository $queue_repository=null, private readonly ilCertificateTypeClassMap $type_class_map=new ilCertificateTypeClassMap(), ?ilLogger $logger=null, ?ilObjectDataCache $object_data_cache=null,)

	getUserCertificateData (UserDataFilter $filter, array $ilCtrlStack=[])

	getUserCertificateDataMaxCount (UserDataFilter $filter)

	certificateCriteriaMetForGivenTemplate (int $usr_id, ilCertificateTemplate $template)

	certificateCriteriaMet (int $usr_id, int $obj_id)

	isActiveCertificateTemplateAvailableFor (int $obj_id)

	getUserCertificateData (UserDataFilter $filter, array $ilCtrlStack=[])

	getUserCertificateDataMaxCount (UserDataFilter $filter)

	certificateCriteriaMetForGivenTemplate (int $usr_id, ilCertificateTemplate $template)

	certificateCriteriaMet (int $usr_id, int $obj_id)

	isActiveCertificateTemplateAvailableFor (int $obj_id)

Private Member Functions
	processEntry (int $userId, ilCertificateTemplate $template)

Private Attributes
readonly UserDataRepository	$user_data_repository

readonly ilCertificateTemplateRepository	$template_repository

readonly ilCertificateQueueRepository	$queue_repository

readonly ilLogger	$logger

readonly ilObjectDataCache	$object_data_cache

Detailed Description

Definition at line 42 of file UserCertificateAPI.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Certificate\API\UserCertificateAPI::__construct	(	?UserDataRepository	$user_data_repository = `null`,
		?ilCertificateTemplateRepository	$template_repository = `null`,
		?ilCertificateQueueRepository	$queue_repository = `null`,
		private readonly ilCertificateTypeClassMap	$type_class_map = `new ilCertificateTypeClassMap()`,
		?ilLogger	$logger = `null`,
		?ilObjectDataCache	$object_data_cache = `null`
	)

Definition at line 50 of file UserCertificateAPI.php.

      {
        global $DIC;
 
        $this->logger = $logger ?? $DIC->logger()->cert();
        $this->object_data_cache = $object_data_cache ?? $DIC['ilObjDataCache'];
        $this->user_data_repository = $user_data_repository ?? new UserDataRepository(
            $DIC->database(),
            $DIC->ctrl()
        );
        $this->template_repository = $template_repository ?? new ilCertificateTemplateDatabaseRepository(
            $DIC->database(),
            $this->logger
        );
        $this->queue_repository = $queue_repository ?? new ilCertificateQueueRepository(
            $DIC->database(),
            $this->logger
        );
    }

References $DIC, ILIAS\Certificate\API\UserCertificateAPI\$object_data_cache, ILIAS\Certificate\API\UserCertificateAPI\$queue_repository, ILIAS\Certificate\API\UserCertificateAPI\$template_repository, ILIAS\Certificate\API\UserCertificateAPI\$user_data_repository, and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

◆ certificateCriteriaMet()

ILIAS\Certificate\API\UserCertificateAPI::certificateCriteriaMet	(	int	$usr_id,
		int	$obj_id
	)

Exceptions

ilCertificateConsumerNotSupported
ilCertificateIssuingObjectNotFound
ilCertificateOwnerNotFound
ilCouldNotFindCertificateTemplate
ilInvalidCertificateException

Implements ILIAS\Certificate\API\UserCertificateApiInterface.

Definition at line 107 of file UserCertificateAPI.php.

                                                                    : void
    {
        $type = $this->object_data_cache->lookupType($obj_id);
        if (!$this->type_class_map->typeExistsInMap($type)) {
            throw new ilCertificateConsumerNotSupported(
                \sprintf(
                    "Oject type '%s' is not supported by the certificate component!",
                    $type
                )
            );
        }
 
        $template = $this->template_repository->fetchCurrentlyActiveCertificate($obj_id);
        if ($template->getObjType() !== $type) {
            $this->logger->error(
                'Object type mismatch between template and determined type for object with id {obj_id}: '
                    . 'Expected {type} but got {template_type}!',
                [
                    'obj_id' => $obj_id,
                    'type' => $type,
                    'template_type' => $template->getObjType()
                ]
            );
        }
 
        $this->certificateCriteriaMetForGivenTemplate($usr_id, $template);
    }

References ILIAS\Certificate\API\UserCertificateAPI\certificateCriteriaMetForGivenTemplate(), and ILIAS\Repository\logger().

Here is the call graph for this function:

◆ certificateCriteriaMetForGivenTemplate()

ILIAS\Certificate\API\UserCertificateAPI::certificateCriteriaMetForGivenTemplate	(	int	$usr_id,
		ilCertificateTemplate	$template
	)

Exceptions

ilCertificateIssuingObjectNotFound
ilCertificateOwnerNotFound
ilInvalidCertificateException

Implements ILIAS\Certificate\API\UserCertificateApiInterface.

Definition at line 86 of file UserCertificateAPI.php.

                                                                                                        : void
    {
        if (!$template->isCurrentlyActive()) {
            $this->logger->debug(
                \sprintf(
                    'Did not trigger certificate achievement for inactive template: usr_id: %s/obj_id: %s/type: %s/template_id: %s',
                    $usr_id,
                    $template->getObjId(),
                    $template->getObjType(),
                    $template->getId()
                )
            );
            return;
        }
 
        $this->processEntry(
            $usr_id,
            $template
        );
    }

References ilCertificateTemplate\getId(), ilCertificateTemplate\getObjId(), ilCertificateTemplate\getObjType(), ilCertificateTemplate\isCurrentlyActive(), ILIAS\Repository\logger(), and ILIAS\Certificate\API\UserCertificateAPI\processEntry().

Referenced by ILIAS\Certificate\API\UserCertificateAPI\certificateCriteriaMet().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserCertificateData()

ILIAS\Certificate\API\UserCertificateAPI::getUserCertificateData	(	UserDataFilter	$filter,
		array	$ilCtrlStack = `[]`
	)

Parameters

list<class-string> $ilCtrlStack An array of ilCtrl-enabled GUI class names that are used to create the link, if this is an empty array (default) no link will be generated

Returns: array<int, UserCertificateDto>

Implements ILIAS\Certificate\API\UserCertificateApiInterface.

Definition at line 76 of file UserCertificateAPI.php.

                                                                                           : array
    {
        return $this->user_data_repository->getUserData($filter, $ilCtrlStack);
    }

◆ getUserCertificateDataMaxCount()

ILIAS\Certificate\API\UserCertificateAPI::getUserCertificateDataMaxCount ( UserDataFilter $filter )

Implements ILIAS\Certificate\API\UserCertificateApiInterface.

Definition at line 81 of file UserCertificateAPI.php.

                                                                          : int
    {
        return $this->user_data_repository->getUserCertificateDataMaxCount($filter);
    }

◆ isActiveCertificateTemplateAvailableFor()

ILIAS\Certificate\API\UserCertificateAPI::isActiveCertificateTemplateAvailableFor ( int $obj_id )

Implements ILIAS\Certificate\API\UserCertificateApiInterface.

Definition at line 135 of file UserCertificateAPI.php.

                                                                        : bool
    {
        try {
            return $this->template_repository->fetchCurrentlyActiveCertificate($obj_id)->isCurrentlyActive();
        } catch (ilCouldNotFindCertificateTemplate) {
            return false;
        }
    }

◆ processEntry()

ILIAS\Certificate\API\UserCertificateAPI::processEntry	(	int	$userId,
		ilCertificateTemplate	$template
	)

private

Exceptions

ilCertificateIssuingObjectNotFound
ilCertificateOwnerNotFound
ilCouldNotFindCertificateTemplate
ilInvalidCertificateException

Definition at line 150 of file UserCertificateAPI.php.

     : void {
        $this->logger->debug(
            \sprintf(
                'Trigger persisting certificate achievement for: usr_id: %s/obj_id: %s/type: %s/template_id: %s',
                $userId,
                $template->getObjId(),
                $template->getObjType(),
                $template->getId()
            )
        );
 
        $entry = new ilCertificateQueueEntry(
            $template->getObjId(),
            $userId,
            $this->type_class_map->getPlaceHolderClassNameByType($template->getObjType()),
            ilCronConstants::IN_PROGRESS,
            $template->getId(),
            time()
        );
 
        $mode = (new ilSetting('certificate'))->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->queue_repository->addToQueue($entry);
    }

Referenced by ILIAS\Certificate\API\UserCertificateAPI\certificateCriteriaMetForGivenTemplate().

Here is the caller graph for this function:

Field Documentation

◆ $logger

readonly ilLogger ILIAS\Certificate\API\UserCertificateAPI::$logger

private

Definition at line 47 of file UserCertificateAPI.php.

◆ $object_data_cache

readonly ilObjectDataCache ILIAS\Certificate\API\UserCertificateAPI::$object_data_cache

private

Definition at line 48 of file UserCertificateAPI.php.

Referenced by ILIAS\Certificate\API\UserCertificateAPI\__construct().

◆ $queue_repository

readonly ilCertificateQueueRepository ILIAS\Certificate\API\UserCertificateAPI::$queue_repository

private

Definition at line 46 of file UserCertificateAPI.php.

Referenced by ILIAS\Certificate\API\UserCertificateAPI\__construct().

◆ $template_repository

readonly ilCertificateTemplateRepository ILIAS\Certificate\API\UserCertificateAPI::$template_repository

private

Definition at line 45 of file UserCertificateAPI.php.

Referenced by ILIAS\Certificate\API\UserCertificateAPI\__construct().

◆ $user_data_repository

readonly UserDataRepository ILIAS\Certificate\API\UserCertificateAPI::$user_data_repository

private

Definition at line 44 of file UserCertificateAPI.php.

Referenced by ILIAS\Certificate\API\UserCertificateAPI\__construct().

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

components/ILIAS/Certificate/classes/API/UserCertificateAPI.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ certificateCriteriaMet()

◆ certificateCriteriaMetForGivenTemplate()

◆ getUserCertificateData()

◆ getUserCertificateDataMaxCount()

◆ isActiveCertificateTemplateAvailableFor()

◆ processEntry()

Field Documentation

◆ $logger

◆ $object_data_cache

◆ $queue_repository

◆ $template_repository

◆ $user_data_repository