Inheritance diagram for ilCmiXapiPlaceholderValues:

Collaboration diagram for ilCmiXapiPlaceholderValues:

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)
	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...

	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...

Protected Member Functions
	getReachedScore (int $objectId, int $userId)

Private Attributes
	$defaultPlaceholderValuesObject

	$objectHelper

	$userObjectHelper

	$utilHelper

	$lpStatusHelper

	$dateHelper

	$language

Detailed Description

Definition at line 14 of file class.ilCmiXapiPlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

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

Definition at line 61 of file class.ilCmiXapiPlaceholderValues.php.

References $dateHelper, $DIC, $language, $lpStatusHelper, $objectHelper, $userObjectHelper, $utilHelper, and language().

       {
         if (null === $language) {
             global $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;
     }

Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValues()

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

This method MUST return an array that contains the actual data for the given user of the given object.

ilInvalidCertificateException MUST be thrown if the data could not be determined or the user did NOT achieve the certificate.

Parameters

int	$userId
int	$objId

Exceptions

ilInvalidCertificateException

Returns: mixed - [PLACEHOLDER] => 'actual value'

Implements ilCertificatePlaceholderValues.

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

References getReachedScore().

                                                                   : 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['REACHED_SCORE'] = $this->utilHelper->prepareFormOutput($this->getReachedScore((int) $objId, (int) $userId));
 
         return $placeholders;
     }

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilCmiXapiPlaceholderValues::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.

Parameters

int	$userId
int	$objId

Returns: array

Implements ilCertificatePlaceholderValues.

Definition at line 107 of file class.ilCmiXapiPlaceholderValues.php.

References language().

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

Here is the call graph for this function:

◆ getReachedScore()

ilCmiXapiPlaceholderValues::getReachedScore	(	int	$objectId,
		int	$userId
	)

protected

Definition at line 135 of file class.ilCmiXapiPlaceholderValues.php.

References Vendor\Package\$e, ilCmiXapiResult\getEmptyInstance(), and ilCmiXapiResult\getInstanceByObjIdAndUsrId().

Referenced by getPlaceholderValues().

                                                                    : string
     {
         try {
             $cmixResult = ilCmiXapiResult::getInstanceByObjIdAndUsrId(
                 $objectId,
                 $userId
             );
         } catch (ilCmiXapiException $e) {
             $cmixResult = ilCmiXapiResult::getEmptyInstance();
         }
 
         $reachedScore = sprintf('%0.2f %%', $cmixResult->getScore() * 100);
 
         return $reachedScore;
     }