ilScormPlaceholderDescription Class Reference

Inheritance diagram for ilScormPlaceholderDescription:

Collaboration diagram for ilScormPlaceholderDescription:

Public Member Functions
	__construct (private readonly ilObject $object, ?ilDefaultPlaceholderDescription $defaultPlaceholderDescriptionObject=null, ?ilLanguage $language=null, ?ilObjectLP $learningProgressObject=null, ?ilUserDefinedFieldsPlaceholderDescription $userDefinedFieldPlaceHolderDescriptionObject=null, ?Profile $profile=null)
	createPlaceholderHtmlDescription (?ilTemplate $template=null)
	This methods MUST return an array containing an array with the the description as array value. More...
	getPlaceholderDescriptions ()
	This method MUST return an array containing an array with the the description as array value. More...
Public Member Functions inherited from ilCertificatePlaceholderDescription
	getPlaceholderDescriptions ()
	This method MUST return an array containing an array with the the description as array value. More...
	createPlaceholderHtmlDescription ()

Private Attributes
readonly ilDefaultPlaceholderDescription	$defaultPlaceHolderDescriptionObject
readonly ilLanguage	$language
array	$placeholder
readonly ilObjectLP	$learningProgressObject

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilScormPlaceholderDescription::__construct	(	private readonly ilObject	$object,
		?ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = null,
		?ilLanguage	$language = null,
		?ilObjectLP	$learningProgressObject = null,
		?ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = null,
		?Profile	$profile = null
	)

Definition at line 30 of file class.ilScormPlaceholderDescription.php.

      {
        global $DIC;
 
        if (null === $language) {
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderDescriptionObject) {
            $defaultPlaceholderDescriptionObject = new ilDefaultPlaceholderDescription(
                $language,
                $profile ?? $DIC['user']->getProfile(),
                $userDefinedFieldPlaceHolderDescriptionObject
            );
        }
        $this->defaultPlaceHolderDescriptionObject = $defaultPlaceholderDescriptionObject;
 
        if (null === $learningProgressObject) {
            $learningProgressObject = ilObjectLP::getInstance($this->object->getId());
        }
        $this->learningProgressObject = $learningProgressObject;
 
        $this->placeholder = $this->defaultPlaceHolderDescriptionObject->getPlaceholderDescriptions();
 
        $this->placeholder['SCORM_TITLE'] = $language->txt('certificate_ph_scormtitle');
        $this->placeholder['SCORM_POINTS'] = $language->txt('certificate_ph_scormpoints');
        $this->placeholder['SCORM_POINTS_MAX'] = $language->txt('certificate_ph_scormmaxpoints');
        $this->placeholder['DATE_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_ph_date_completed')
        );
        $this->placeholder['DATETIME_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_ph_datetime_completed')
        );
    }

References $DIC, $language, $learningProgressObject, ilObjectLP\getInstance(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilLanguage\loadLanguageModule(), ILIAS\Repository\object(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

Here is the call graph for this function:

Member Function Documentation

createPlaceholderHtmlDescription()

ilScormPlaceholderDescription::createPlaceholderHtmlDescription

(

?ilTemplate

$template = null

)

This methods MUST return an array containing an array with the the description as array value.

Parameters

ilTemplate | null

$template

Returns

string - [PLACEHOLDER] => 'description'

Definition at line 79 of file class.ilScormPlaceholderDescription.php.

                                                                                  : string
    {
        if (null === $template) {
            $template = new ilTemplate('tpl.scorm_description.html', true, true, 'components/ILIAS/Certificate');
        }
 
        $template->setCurrentBlock('items');
 
        foreach ($this->placeholder as $id => $caption) {
            $template->setVariable('ID', $id);
            $template->setVariable('TXT', $caption);
            $template->parseCurrentBlock();
        }
 
        $template->setVariable('PH_INTRODUCTION', $this->language->txt('certificate_ph_introduction'));
 
        $collection = $this->learningProgressObject->getCollectionInstance();
        $items = [];
        if ($collection !== null) {
            $items = $collection->getPossibleItems();
        }
 
        if ($items) {
            $template->setCurrentBlock('SCOS');
            $template->setVariable('PH_SCOS', $this->language->txt('certificate_ph_scos'));
            $template->parseCurrentBlock();
            $template->setCurrentBlock('SCO_HEADER');
            $template->setVariable('PH_TITLE_SCO', $this->language->txt('certificate_ph_title_sco'));
            $template->setVariable('PH_SCO_TITLE', $this->language->txt('certificate_ph_sco_title'));
            $template->setVariable('PH_SCO_POINTS_RAW', $this->language->txt('certificate_ph_sco_points_raw'));
            $template->setVariable('PH_SCO_POINTS_MAX', $this->language->txt('certificate_ph_sco_points_max'));
            $template->setVariable('PH_SCO_POINTS_SCALED', $this->language->txt('certificate_ph_sco_points_scaled'));
        } else {
            $template->setCurrentBlock('NO_SCO');
            $template->setVariable('PH_NO_SCO', $this->language->txt('certificate_ph_no_sco'));
        }
        $template->parseCurrentBlock();
 
        if ($collection !== null) {
            $counter = 0;
            foreach ($items as $item_id => $sahs_item) {
                if ($collection->isAssignedEntry($item_id)) {
                    $template->setCurrentBlock('SCO');
                    $template->setVariable('SCO_TITLE', $sahs_item['title']);
                    $template->setVariable('PH_SCO_TITLE', '[SCO_T_' . $counter . ']');
                    $template->setVariable('PH_SCO_POINTS_RAW', '[SCO_P_' . $counter . ']');
                    $template->setVariable('PH_SCO_POINTS_MAX', '[SCO_PM_' . $counter . ']');
                    $template->setVariable('PH_SCO_POINTS_SCALED', '[SCO_PP_' . $counter . ']');
                    $template->parseCurrentBlock();
                    $counter++;
                }
            }
        }
 
        return $template->get();
    }

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

Here is the call graph for this function:

getPlaceholderDescriptions()

ilScormPlaceholderDescription::getPlaceholderDescriptions

(

)

This method MUST return an array containing an array with the the description as array value.

Returns

array - [PLACEHOLDER] => 'description'

Implements ilCertificatePlaceholderDescription.

Definition at line 141 of file class.ilScormPlaceholderDescription.php.

                                                : array
    {
        return $this->placeholder;
    }

References $placeholder.

Field Documentation

$defaultPlaceHolderDescriptionObject

readonly ilDefaultPlaceholderDescription ilScormPlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

readonly ilLanguage ilScormPlaceholderDescription::$language

private

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

Referenced by __construct().

$learningProgressObject

readonly ilObjectLP ilScormPlaceholderDescription::$learningProgressObject

private

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

Referenced by __construct().

$placeholder

array ilScormPlaceholderDescription::$placeholder

private

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

Referenced by getPlaceholderDescriptions().

---

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

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