Inheritance diagram for ilLTIConsumerPlaceholderValues:

Collaboration diagram for ilLTIConsumerPlaceholderValues:

Public Member Functions
	__construct (?ilDefaultPlaceholderValues $defaultPlaceholderValues=null, ?ilLanguage $language=null, ?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateUserObjectHelper $userObjectHelper=null, ?ilCertificateLPStatusHelper $lpStatusHelper=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilCertificateDateHelper $dateHelper=null)

	getPlaceholderValuesForPreview (int $userId, int $objId)

	getPlaceholderValues (int $userId, int $objId)

	getPlaceholderValues (int $userId, int $objId)
	This method MUST return an array that contains the actual data for the given user of the given object. More...

	getPlaceholderValuesForPreview (int $userId, int $objId)
	This method is different then the 'getPlaceholderValues' method, this method is used to create a placeholder value array containing dummy values that is used to create a preview certificate. More...

Protected Member Functions
	getMasteryScore (ilObjLTIConsumer $object)

	getReachedScore (ilObjLTIConsumer $object, int $userId)

Private Attributes
ilDefaultPlaceholderValues	$defaultPlaceholderValuesObject

ilCertificateObjectHelper	$objectHelper

ilCertificateUtilHelper	$utilHelper

ilCertificateLPStatusHelper	$lpStatusHelper

	$dateHelper

ilLanguage	$language

Detailed Description

Definition at line 29 of file class.ilLTIConsumerPlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

ilLTIConsumerPlaceholderValues::__construct	(	?ilDefaultPlaceholderValues	$defaultPlaceholderValues = `null`,
		?ilLanguage	$language = `null`,
		?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilCertificateUserObjectHelper	$userObjectHelper = `null`,
		?ilCertificateLPStatusHelper	$lpStatusHelper = `null`,
		?ilCertificateUtilHelper	$utilHelper = `null`,
		?ilCertificateDateHelper	$dateHelper = `null`
	)

Parameters

ilDefaultPlaceholderValues \| null	$defaultPlaceholderValues
ilLanguage \| null	$language
ilCertificateObjectHelper \| null	$objectHelper
ilCertificateUserObjectHelper \| null	$userObjectHelper
ilCertificateLPStatusHelper \| null	$lpStatusHelper
ilCertificateUtilHelper \| null	$utilHelper
ilCertificateDateHelper \| null	$dateHelper

Definition at line 57 of file class.ilLTIConsumerPlaceholderValues.php.

      {
        if (null === $language) {
            global $DIC; /* @var \ILIAS\DI\Container $DIC */
            $language = $DIC->language();
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
 
        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;
 
        if (null === $userObjectHelper) {
            $userObjectHelper = new ilCertificateUserObjectHelper();
        }
//        $this->userObjectHelper = $userObjectHelper;
 
        if (null === $lpStatusHelper) {
            $lpStatusHelper = new ilCertificateLPStatusHelper();
        }
        $this->lpStatusHelper = $lpStatusHelper;
 
        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;
 
        if (null === $dateHelper) {
            $dateHelper = new ilCertificateDateHelper();
        }
        $this->dateHelper = $dateHelper;
    }

References $dateHelper, $DIC, $language, $lpStatusHelper, $objectHelper, $utilHelper, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

Member Function Documentation

◆ getMasteryScore()

ilLTIConsumerPlaceholderValues::getMasteryScore ( ilObjLTIConsumer $object )

protected

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

                                                                : string
    {
        return sprintf('%0.2f %%', $object->getMasteryScorePercent());
    }

References ilObjLTIConsumer\getMasteryScorePercent().

Referenced by getPlaceholderValues().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlaceholderValues()

ilLTIConsumerPlaceholderValues::getPlaceholderValues	(	int	$userId,
		int	$objId
	)

Exceptions

ilDatabaseException
ilDateTimeException
ilException
ilInvalidCertificateException
ilObjectNotFoundException

Returns: mixed[]

Implements ilCertificatePlaceholderValues.

Definition at line 129 of file class.ilLTIConsumerPlaceholderValues.php.

                                                                 : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
 
        /* @var ilObjLTIConsumer $object */
        $object = $this->objectHelper->getInstanceByObjId($objId);
 
        $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
        $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($object->getDescription());
 
        $placeholders['MASTERY_SCORE'] = $this->utilHelper->prepareFormOutput($this->getMasteryScore($object));
        $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->getReachedScore($object, $userId));
 
        $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);
        if ($completionDate != false &&
            $completionDate !== null &&
            $completionDate !== ''
        ) {
            $placeHolders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeHolders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }
 
        return $placeholders;
    }

References $objId, getMasteryScore(), and getReachedScore().

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilLTIConsumerPlaceholderValues::getPlaceholderValuesForPreview	(	int	$userId,
		int	$objId
	)

Exceptions

ilDateTimeException
ilException

Returns: mixed[]

Implements ilCertificatePlaceholderValues.

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

                                                                           : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
 
        $placeholders['OBJECT_TITLE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_object_title'));
        $placeholders['OBJECT_DESCRIPTION'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_object_description'));
 
        $placeholders['MASTERY_SCORE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_mastery_score'));
        $placeholders['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->language->txt('lti_cert_ph_reached_score'));
 
        return $placeholders;
    }

References $objId, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Here is the call graph for this function:

◆ getReachedScore()

ilLTIConsumerPlaceholderValues::getReachedScore	(	ilObjLTIConsumer	$object,
		int	$userId
	)

protected

Definition at line 159 of file class.ilLTIConsumerPlaceholderValues.php.

                                                                             : string
    {
        $userResult = ilLTIConsumerResult::getByKeys($object->getId(), $userId);
 
        $reachedScore = sprintf('%0.2f %%', 0);
        if ($userResult !== null) {
            $reachedScore = sprintf('%0.2f %%', $userResult->getResult() * 100);
        }
 
        return $reachedScore;
    }