ilScormPlaceholderValues Class Reference

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)
	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...
Public Member Functions inherited from ilCertificatePlaceholderValues
	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...

Private Attributes
readonly ilLanguage	$language
readonly ilDefaultPlaceholderValues	$defaultPlaceholderValuesObject
readonly ilCertificateDateHelper	$dateHelper
readonly ilCertificateObjectHelper	$objectHelper
readonly ilCertificateUtilHelper	$utilHelper
readonly ilCertificateObjectLPHelper	$objectLPHelper
readonly 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.

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

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

Here is the call graph for this function:

Member Function Documentation

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.

Implements ilCertificatePlaceholderValues.

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

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

                                                                           : 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 !== null) {
            $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;
    }

Here is the call graph for this function:

Field Documentation

$dateHelper

readonly ilCertificateDateHelper ilScormPlaceholderValues::$dateHelper

private

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

Referenced by __construct().

$defaultPlaceholderValuesObject

readonly ilDefaultPlaceholderValues ilScormPlaceholderValues::$defaultPlaceholderValuesObject

private

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

$language

readonly ilLanguage ilScormPlaceholderValues::$language

private

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

Referenced by __construct().

$lpStatusHelper

readonly ilCertificateLPStatusHelper ilScormPlaceholderValues::$lpStatusHelper

private

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

Referenced by __construct().

$objectHelper

readonly ilCertificateObjectHelper ilScormPlaceholderValues::$objectHelper

private

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

Referenced by __construct().

$objectLPHelper

readonly ilCertificateObjectLPHelper ilScormPlaceholderValues::$objectLPHelper

private

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

Referenced by __construct().

$utilHelper

readonly ilCertificateUtilHelper ilScormPlaceholderValues::$utilHelper

private

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

Referenced by __construct().

---

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

• components/ILIAS/ScormAicc/classes/Certificate/class.ilScormPlaceholderValues.php