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, \ILIAS\DI\Container $dic=null, ilUserCertificateRepository $userCertificateRepository=null, ilCtrl $controller=null, ilSetting $certificateSettings=null, Factory $uiFactory=null, Renderer $uiRenderer=null, ilCertificateUtilHelper $utilHelper=null)
	isActive ()
	Is active? More...
	getEntries ($ts_start, $ts_end)
	Get entries. More...
	getName ()
	Get name of provider (in user language) More...
Public Member Functions inherited from ilAbstractLearningHistoryProvider
	__construct ( $user_id, ilLearningHistoryFactory $factory, ilLanguage $lng, ilTemplate $template=null)
	Constructor. More...

Protected Attributes
	$uiFactory
	$uiRenderer
Protected Attributes inherited from ilAbstractLearningHistoryProvider
	$user_id
	$factory
	$lng

Private Attributes
	$userCertificateRepository
	$controller
	$certificateSettings
	$utilHelper

Additional Inherited Members
Protected Member Functions inherited from ilAbstractLearningHistoryProvider
	getUserId ()
	Get user id. More...
	getFactory ()
	Get factory. More...
	getLanguage ()
	Get language object. More...
	getEmphasizedTitle ($title)
	Get emphasized title. More...

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCertificateLearningHistoryProvider::__construct	(	int	$user_id,
		ilLearningHistoryFactory	$factory,
		ilLanguage	$lng,
		ilTemplate	$template = null,
		\ILIAS\DI\Container	$dic = null,
		ilUserCertificateRepository	$userCertificateRepository = null,
		ilCtrl	$controller = null,
		ilSetting	$certificateSettings = null,
		Factory	$uiFactory = null,
		Renderer	$uiRenderer = null,
		ilCertificateUtilHelper	$utilHelper = null
	)

Parameters

int	$user_id
ilLearningHistoryFactory	$factory
ilLanguage	$lng
ilTemplate | null	$template
\ILIAS\DI\Container | null	$dic
ilUserCertificateRepository | null	$userCertificateRepository
ilCtrl	$controller
ilSetting | null	$certificateSettings
Factory | null	$uiFactory
Renderer | null	$uiRenderer
ilCertificateUtilHelper | null	$utilHelper

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

References $certificateSettings, $controller, $DIC, ilAbstractLearningHistoryProvider\$template, $uiFactory, $uiRenderer, $userCertificateRepository, $utilHelper, and ilLanguage\loadLanguageModule().

      {
        $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 === $controller) {
            $controller = $dic->ctrl();
        }
        $this->controller = $controller;

        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;
    }

Here is the call graph for this function:

Member Function Documentation

getEntries()

ilCertificateLearningHistoryProvider::getEntries	(		$ts_start,
			$ts_end
	)

Get entries.

Parameters

int	$ts_start
int	$ts_end

Returns

ilLearningHistoryEntry[]

Implements ilLearningHistoryProviderInterface.

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

References $certificate, $certificates, $text, and ilAbstractLearningHistoryProvider\getEmphasizedTitle().

    {
        $entries = array();

        $certificates = $this->userCertificateRepository->fetchActiveCertificatesInIntervalForPresentation($this->user_id, $ts_start, $ts_end);

        foreach ($certificates as $certificate) {
            $objectId = $certificate->getUserCertificate()->getObjId();

            $this->controller->setParameterByClass(
                'ilUserCertificateGUI',
                'certificate_id',
                $certificate->getUserCertificate()->getId()
            );
            $href = $this->controller->getLinkTargetByClass(['ilPersonalDesktopGUI', 'ilAchievementsGUI', 'ilUserCertificateGUI'], 'download');
            $this->controller->clearParametersByClass('ilUserCertificateGUI');

            $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("icon_cert.svg"),
                $certificate->getUserCertificate()->getAcquiredTimestamp(),
                $objectId
            );
        }

        return $entries;
    }

Here is the call graph for this function:

getName()

ilCertificateLearningHistoryProvider::getName

(

)

Get name of provider (in user language)

Returns

string

Implements ilLearningHistoryProviderInterface.

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

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

isActive()

ilCertificateLearningHistoryProvider::isActive

(

)

Is active?

Returns

bool

Implements ilLearningHistoryProviderInterface.

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

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

Field Documentation

$certificateSettings

ilCertificateLearningHistoryProvider::$certificateSettings

private

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

Referenced by __construct().

$controller

ilCertificateLearningHistoryProvider::$controller

private

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

Referenced by __construct().

$uiFactory

ilCertificateLearningHistoryProvider::$uiFactory

protected

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

Referenced by __construct().

$uiRenderer

ilCertificateLearningHistoryProvider::$uiRenderer

protected

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

Referenced by __construct().

$userCertificateRepository

ilCertificateLearningHistoryProvider::$userCertificateRepository

private

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

Referenced by __construct().

$utilHelper

ilCertificateLearningHistoryProvider::$utilHelper

private

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

Referenced by __construct().

---

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

• Services/Certificate/classes/LearningHistory/class.ilCertificateLearningHistoryProvider.php