ilCertificateLearningHistoryProvider Class Reference

Inheritance diagram for ilCertificateLearningHistoryProvider:

Collaboration diagram for ilCertificateLearningHistoryProvider:

Public Member Functions
	__construct (int $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ?ilTemplate $template=null, ?Container $dic=null, ?ilUserCertificateRepository $userCertificateRepository=null, ?ilCtrlInterface $ctrl=null, ?ilSetting $certificateSettings=null, ?Factory $uiFactory=null, ?Renderer $uiRenderer=null, ?ilCertificateUtilHelper $utilHelper=null)
	isActive ()
	getEntries (int $ts_start, int $ts_end)
	Get entries. More...
	getName ()
Public Member Functions inherited from ilAbstractLearningHistoryProvider
	__construct (int $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ?ilTemplate $template=null)
	isActive ()
	getEntries (int $ts_start, int $ts_end)
	getName ()

Protected Attributes
Factory	$uiFactory
Renderer	$uiRenderer
Protected Attributes inherited from ilAbstractLearningHistoryProvider
int	$user_id
ilLearningHistoryFactory	$factory
ilLanguage	$lng

Private Attributes
readonly ilUserCertificateRepository	$userCertificateRepository
readonly ilCtrlInterface	$ctrl
readonly ilSetting	$certificateSettings
readonly ilCertificateUtilHelper	$utilHelper

Additional Inherited Members
Protected Member Functions inherited from ilAbstractLearningHistoryProvider
	getUserId ()
	getFactory ()
	getLanguage ()
	getEmphasizedTitle (string $title)

Detailed Description

Author

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

Definition at line 28 of file class.ilCertificateLearningHistoryProvider.php.

Constructor & Destructor Documentation

__construct()

ilCertificateLearningHistoryProvider::__construct	(	int	$user_id,
		ilLearningHistoryFactory	$factory,
		ilLanguage	$lng,
		?ilTemplate	$template = null,
		?Container	$dic = null,
		?ilUserCertificateRepository	$userCertificateRepository = null,
		?ilCtrlInterface	$ctrl = null,
		?ilSetting	$certificateSettings = null,
		?Factory	$uiFactory = null,
		?Renderer	$uiRenderer = null,
		?ilCertificateUtilHelper	$utilHelper = null
	)

Definition at line 37 of file class.ilCertificateLearningHistoryProvider.php.

      {
        $lng->loadLanguageModule("cert");
 
        parent::__construct($user_id, $factory, $lng, $template);
 
        if (null === $dic) {
            global $DIC;
            $dic = $DIC;
        }
 
        if (null === $userCertificateRepository) {
            $database = $dic->database();
            $looger = $dic->logger()->cert();
            $userCertificateRepository = new ilUserCertificateRepository($database, $looger);
        }
        $this->userCertificateRepository = $userCertificateRepository;
 
        if (null === $ctrl) {
            $ctrl = $dic->ctrl();
        }
        $this->ctrl = $ctrl;
 
        if (null === $certificateSettings) {
            $certificateSettings = new ilSetting("certificate");
        }
        $this->certificateSettings = $certificateSettings;
 
        if (null === $uiFactory) {
            $uiFactory = $dic->ui()->factory();
        }
        $this->uiFactory = $uiFactory;
 
        if (null === $uiRenderer) {
            $uiRenderer = $dic->ui()->renderer();
        }
        $this->uiRenderer = $uiRenderer;
 
        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;
    }

References $certificateSettings, $ctrl, $DIC, $dic, ilAbstractLearningHistoryProvider\$factory, ilAbstractLearningHistoryProvider\$lng, ilAbstractLearningHistoryProvider\$template, $uiFactory, $uiRenderer, ilAbstractLearningHistoryProvider\$user_id, $userCertificateRepository, $utilHelper, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), and ilLanguage\loadLanguageModule().

Here is the call graph for this function:

Member Function Documentation

getEntries()

ilCertificateLearningHistoryProvider::getEntries	(	int	$ts_start,
		int	$ts_end
	)

Get entries.

Returns

ilLearningHistoryEntry[]

Implements ilLearningHistoryProviderInterface.

Definition at line 101 of file class.ilCertificateLearningHistoryProvider.php.

                                                          : array
    {
        $entries = [];
 
        $certificates = $this->userCertificateRepository->fetchActiveCertificatesInIntervalForPresentation(
            $this->user_id,
            $ts_start,
            $ts_end
        );
 
        foreach ($certificates as $certificate) {
            $objectId = $certificate->getUserCertificate()->getObjId();
 
            $this->ctrl->setParameterByClass(
                ilUserCertificateGUI::class,
                'certificate_id',
                $certificate->getUserCertificate()->getId()
            );
            $href = $this->ctrl->getLinkTargetByClass(
                [
                    ilDashboardGUI::class,
                    ilAchievementsGUI::class,
                    ilUserCertificateGUI::class
                ],
                'download'
            );
            $this->ctrl->clearParametersByClass(ilUserCertificateGUI::class);
 
            $prefixTextWithLink = sprintf(
                $this->lng->txt('certificate_achievement_sub_obj'),
                $this->uiRenderer->render($this->uiFactory->link()->standard(
                    $this->getEmphasizedTitle($certificate->getObjectTitle()),
                    $href
                ))
            );
 
            $text = sprintf(
                $this->lng->txt('certificate_achievement'),
                $prefixTextWithLink
            );
 
            $entries[] = new ilLearningHistoryEntry(
                $text,
                $text,
                $this->utilHelper->getImagePath("standard/icon_cert.svg"),
                $certificate->getUserCertificate()->getAcquiredTimestamp(),
                $objectId
            );
        }
 
        return $entries;
    }

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

getName()

ilCertificateLearningHistoryProvider::getName

(

)

Implements ilLearningHistoryProviderInterface.

Definition at line 154 of file class.ilCertificateLearningHistoryProvider.php.

                             : string
    {
        return $this->lng->txt('certificates');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

isActive()

ilCertificateLearningHistoryProvider::isActive

(

)

Implements ilLearningHistoryProviderInterface.

Definition at line 92 of file class.ilCertificateLearningHistoryProvider.php.

                              : bool
    {
        return (bool) $this->certificateSettings->get('active', '0');
    }

Field Documentation

$certificateSettings

readonly ilSetting ilCertificateLearningHistoryProvider::$certificateSettings

private

Definition at line 32 of file class.ilCertificateLearningHistoryProvider.php.

Referenced by __construct().

$ctrl

readonly ilCtrlInterface ilCertificateLearningHistoryProvider::$ctrl

private

Definition at line 31 of file class.ilCertificateLearningHistoryProvider.php.

Referenced by __construct().

$uiFactory

Factory ilCertificateLearningHistoryProvider::$uiFactory

protected

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

Referenced by __construct().

$uiRenderer

Renderer ilCertificateLearningHistoryProvider::$uiRenderer

protected

Definition at line 34 of file class.ilCertificateLearningHistoryProvider.php.

Referenced by __construct().

$userCertificateRepository

readonly ilUserCertificateRepository ilCertificateLearningHistoryProvider::$userCertificateRepository

private

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

Referenced by __construct().

$utilHelper

readonly ilCertificateUtilHelper ilCertificateLearningHistoryProvider::$utilHelper

private

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

Referenced by __construct().

---

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

• components/ILIAS/Certificate/classes/LearningHistory/class.ilCertificateLearningHistoryProvider.php