ilScormPlaceholderDescription Class Reference

Inheritance diagram for ilScormPlaceholderDescription:

Collaboration diagram for ilScormPlaceholderDescription:

Public Member Functions
	__construct (ilObject $object, ilDefaultPlaceholderDescription $defaultPlaceholderDescriptionObject=null, ilLanguage $language=null, ilObjectLP $learningProgressObject=null, ilUserDefinedFieldsPlaceholderDescription $userDefinedFieldPlaceHolderDescriptionObject=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
	createPlaceholderHtmlDescription ()

Private Attributes
	$defaultPlaceHolderDescriptionObject
	$language
	$placeholder
	$object
	$learningProgressObject

Detailed Description

Author

Niels Theen nthee.nosp@m.n@da.nosp@m.tabay.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilScormPlaceholderDescription::__construct	(	ilObject	$object,
		ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = null,
		ilLanguage	$language = null,
		ilObjectLP	$learningProgressObject = null,
		ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = null
	)

Parameters

ilObject	$object
ilDefaultPlaceholderDescription | null	$defaultPlaceholderDescriptionObject
ilLanguage | null	$language
ilObjectLP | null	$learningProgressObject
ilUserDefinedFieldsPlaceholderDescription | null	$userDefinedFieldPlaceHolderDescriptionObject

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

References $DIC, $language, $learningProgressObject, $object, ilObjectLP\getInstance(), language(), and ilUtil\prepareFormOutput().

      {
        global $DIC;

        $this->object = $object;

        if (null === $language) {
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;

        if (null === $defaultPlaceholderDescriptionObject) {
            $defaultPlaceholderDescriptionObject = new ilDefaultPlaceholderDescription($language, $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'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_date_completed'));
        $this->placeholder['DATETIME_COMPLETED'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_datetime_completed'));
    }

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

mixed - [PLACEHOLDER] => 'description'

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

References language().

                                                                                  : string
    {
        if (null === $template) {
            $template = new ilTemplate('tpl.scorm_description.html', true, true, 'Services/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();
        if ($collection) {
            $items = $collection->getPossibleItems();
        }

        if (!$items) {
            $template->setCurrentBlock('NO_SCO');
            $template->setVariable('PH_NO_SCO', $this->language->txt('certificate_ph_no_sco'));
            $template->parseCurrentBlock();
        } else {
            $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'));
            $template->parseCurrentBlock();
        }

        if ($collection) {
            $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();
    }

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

mixed - [PLACEHOLDER] => 'description'

Implements ilCertificatePlaceholderDescription.

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

References $placeholder.

                                                 : array
    {
        return $this->placeholder;
    }

Field Documentation

$defaultPlaceHolderDescriptionObject

ilScormPlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

ilScormPlaceholderDescription::$language

private

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

Referenced by __construct().

$learningProgressObject

ilScormPlaceholderDescription::$learningProgressObject

private

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

Referenced by __construct().

$object

ilScormPlaceholderDescription::$object

private

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

Referenced by __construct().

$placeholder

ilScormPlaceholderDescription::$placeholder

private

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

Referenced by getPlaceholderDescriptions().

---

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

• Services/Certificate/classes/Placeholder/Description/class.ilScormPlaceholderDescription.php