Inheritance diagram for ilScormPlaceholderValues:

Collaboration diagram for ilScormPlaceholderValues:

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

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

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

Private Attributes
ilLanguage	$language

ilDefaultPlaceholderValues	$defaultPlaceholderValuesObject

ilCertificateDateHelper	$dateHelper

ilCertificateObjectHelper	$objectHelper

ilCertificateUtilHelper	$utilHelper

ilCertificateObjectLPHelper	$objectLPHelper

ilCertificateLPStatusHelper	$lpStatusHelper

Detailed Description

Definition at line 21 of file class.ilScormPlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

ilScormPlaceholderValues::__construct	(	?ilDefaultPlaceholderValues	$defaultPlaceholderValues = `null`,
		?ilLanguage	$language = `null`,
		?ilCertificateDateHelper	$dateHelper = `null`,
		?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilCertificateUtilHelper	$utilHelper = `null`,
		?ilCertificateObjectLPHelper	$objectLPHelper = `null`,
		?ilCertificateLPStatusHelper	$lpStatusHelper = `null`
	)

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

      {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;
 
        if (null === $dateHelper) {
            $dateHelper = new ilCertificateDateHelper();
        }
        $this->dateHelper = $dateHelper;
 
        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;
 
        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;
 
        if (null === $objectLPHelper) {
            $objectLPHelper = new ilCertificateObjectLPHelper();
        }
        $this->objectLPHelper = $objectLPHelper;
 
        if (null === $lpStatusHelper) {
            $lpStatusHelper = new ilCertificateLPStatusHelper();
        }
        $this->lpStatusHelper = $lpStatusHelper;
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValues()

ilScormPlaceholderValues::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

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

Exceptions

ilDatabaseException
ilDateTimeException
ilException
ilObjectNotFoundException

Implements ilCertificatePlaceholderValues.

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

                                                                 : array
    {
        $this->language->loadLanguageModule('certificate');
 
        $object = $this->objectHelper->getInstanceByObjId($objId);
        $points = $object->getPointsInPercent();
        if (is_null($points)) {
            $txtPoints = $this->language->txt('certificate_points_notavailable');
        } else {
            $txtPoints = number_format(
                $points,
                1,
                $this->language->txt('lang_sep_decimal'),
                $this->language->txt('lang_sep_thousand')
            ) . ' %';
        }
 
        $max_points = $object->getMaxPoints();
        $txtMaxPoints = $max_points;
        if (is_null($max_points)) {
            $txtMaxPoints = $this->language->txt('certificate_points_notavailable');
        } elseif ($max_points != floor($max_points)) {
            $txtMaxPoints = number_format(
                $max_points,
                1,
                $this->language->txt('lang_sep_decimal'),
                $this->language->txt('lang_sep_thousand')
            );
        }
 
        $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);
 
        $placeHolders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);
 
        $placeHolders['SCORM_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
        $placeHolders['SCORM_POINTS'] = $txtPoints;
        $placeHolders['SCORM_POINTS_MAX'] = $txtMaxPoints;
 
        $placeHolders['DATE_COMPLETED'] = '';
        $placeHolders['DATETIME_COMPLETED'] = '';
 
        if ($completionDate !== '') {
            $placeHolders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate);
            $placeHolders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate);
        }
 
        $olp = $this->objectLPHelper->getInstance($object->getId());
        $collection = $olp->getCollectionInstance();
 
        if ($collection) {
            $counter = 0;
            foreach ($collection->getPossibleItems() as $item_id => $sahs_item) {
                if ($collection->isAssignedEntry($item_id)) {
                    $placeHolders['SCO_T_' . $counter] = $sahs_item['title'];
                    $a_scores = $collection->getScoresForUserAndCP_Node_Id($item_id, $userId);
 
                    $placeHolders['SCO_P_' . $counter] = $this->language->txt('certificate_points_notavailable');
                    if ($a_scores['raw'] !== null) {
                        $placeHolders['SCO_P_' . $counter] = number_format(
                            (float) $a_scores['raw'],
                            1,
                            $this->language->txt('lang_sep_decimal'),
                            $this->language->txt('lang_sep_thousand')
                        );
                    }
 
                    $placeHolders['SCO_PM_' . $counter] = $this->language->txt('certificate_points_notavailable');
                    if ($a_scores['max'] !== null) {
                        $placeHolders['SCO_PM_' . $counter] = number_format(
                            (float) $a_scores['max'],
                            1,
                            $this->language->txt('lang_sep_decimal'),
                            $this->language->txt('lang_sep_thousand')
                        );
                    }
 
                    $placeHolders['SCO_PP_' . $counter] = $this->language->txt('certificate_points_notavailable');
                    if ($a_scores['scaled'] !== null) {
                        $placeHolders['SCO_PP_' . $counter] = number_format(
                            (float) ($a_scores['scaled'] * 100),
                            1,
                            $this->language->txt('lang_sep_decimal'),
                            $this->language->txt('lang_sep_thousand')
                        );
 
                        $placeHolders['SCO_PP_' . $counter] .= ' %';
                    }
 
                    $counter++;
                }
            }
        }
 
        return $placeHolders;
    }

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

Here is the call graph for this function:

◆ getPlaceholderValuesForPreview()

ilScormPlaceholderValues::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 196 of file class.ilScormPlaceholderValues.php.

                                                                           : array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);
 
        $object = $this->objectHelper->getInstanceByObjId($objId);
 
        $placeholders['SCORM_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());
 
        $placeholders['SCORM_POINTS'] = number_format(
            80.7,
            1,
            $this->language->txt('lang_sep_decimal'),
            $this->language->txt('lang_sep_thousand')
        ) . ' %';
 
        $placeholders['SCORM_POINTS_MAX'] = number_format(
            90,
            0,
            $this->language->txt('lang_sep_decimal'),
            $this->language->txt('lang_sep_thousand')
        );
 
        $insert_tags = [];
        foreach ($placeholders as $id => $caption) {
            $insert_tags[$id] = $caption;
        }
 
        $olp = $this->objectLPHelper->getInstance($objId);
        $collection = $olp->getCollectionInstance();
 
        if ($collection) {
            $counter = 0;
            foreach ($collection->getPossibleItems() as $item_id => $sahs_item) {
                if ($collection->isAssignedEntry($item_id)) {
                    $insert_tags['SCO_T_' . $counter] = $sahs_item['title'];
 
                    $insert_tags['SCO_P_' . $counter] = number_format(
                        30.3,
                        1,
                        $this->language->txt('lang_sep_decimal'),
                        $this->language->txt('lang_sep_thousand')
                    );
 
                    $insert_tags['SCO_PM_' . $counter] = number_format(
                        90.9,
                        1,
                        $this->language->txt('lang_sep_decimal'),
                        $this->language->txt('lang_sep_thousand')
                    );
 
                    $insert_tags['SCO_PP_' . $counter] = number_format(
                        33.3333,
                        1,
                        $this->language->txt('lang_sep_decimal'),
                        $this->language->txt('lang_sep_thousand')
                    ) . ' %';
 
                    $counter++;
                }
            }
        }
 
        return $insert_tags;
    }