ilLTIConsumerPlaceholderDescription Class Reference

Inheritance diagram for ilLTIConsumerPlaceholderDescription:

Collaboration diagram for ilLTIConsumerPlaceholderDescription:

Public Member Functions
	__construct (?ilDefaultPlaceholderDescription $defaultPlaceholderDescriptionObject=null, ?ilLanguage $language=null, ?ilUserDefinedFieldsPlaceholderDescription $userDefinedFieldPlaceHolderDescriptionObject=null)
	getPlaceholderDescriptions ()
	createPlaceholderHtmlDescription (ilTemplate $template=null)
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
ilDefaultPlaceholderDescription	$defaultPlaceHolderDescriptionObject
ilLanguage	$language
array	$placeholder

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilLTIConsumerPlaceholderDescription::__construct	(	?ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = null,
		?ilLanguage	$language = null,
		?ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = null
	)

Definition at line 37 of file class.ilLTIConsumerPlaceholderDescription.php.

      {
        global $DIC;
 
        if (null === $language) {
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;
 
        if (null === $defaultPlaceholderDescriptionObject) {
            $defaultPlaceholderDescriptionObject = new ilDefaultPlaceholderDescription($language, $userDefinedFieldPlaceHolderDescriptionObject);
        }
        $this->defaultPlaceHolderDescriptionObject = $defaultPlaceholderDescriptionObject;
 
        $this->placeholder = $this->defaultPlaceHolderDescriptionObject->getPlaceholderDescriptions();
        $this->placeholder['OBJECT_TITLE'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $this->language->txt('lti_cert_ph_object_title')
        );
        $this->placeholder['OBJECT_DESCRIPTION'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $this->language->txt('lti_cert_ph_object_description')
        );
        $this->placeholder['MASTERY_SCORE'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $this->language->txt('lti_cert_ph_mastery_score')
        );
        $this->placeholder['REACHED_SCORE'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $this->language->txt('lti_cert_ph_reached_score')
        );
        $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, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilLanguage\loadLanguageModule(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

Here is the call graph for this function:

Member Function Documentation

createPlaceholderHtmlDescription()

ilLTIConsumerPlaceholderDescription::createPlaceholderHtmlDescription

(

ilTemplate

$template = null

)

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

                                                                                 : string
    {
        if (null === $template) {
            $template = new ilTemplate('tpl.default_description.html', true, true, 'components/ILIAS/Certificate');
        }
 
        $template->setVariable('PLACEHOLDER_INTRODUCTION', $this->language->txt('certificate_ph_introduction'));
 
        $template->setCurrentBlock('items');
        foreach ($this->placeholder as $id => $caption) {
            $template->setVariable('ID', $id);
            $template->setVariable('TXT', $caption);
            $template->parseCurrentBlock();
        }
 
        return $template->get();
    }

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

Here is the call graph for this function:

getPlaceholderDescriptions()

ilLTIConsumerPlaceholderDescription::getPlaceholderDescriptions

(

)

Returns

mixed[]

Implements ilCertificatePlaceholderDescription.

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

                                                : array
    {
        return $this->placeholder;
    }

References $placeholder.

Field Documentation

$defaultPlaceHolderDescriptionObject

ilDefaultPlaceholderDescription ilLTIConsumerPlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

ilLanguage ilLTIConsumerPlaceholderDescription::$language

private

Definition at line 33 of file class.ilLTIConsumerPlaceholderDescription.php.

Referenced by __construct().

$placeholder

array ilLTIConsumerPlaceholderDescription::$placeholder

private

Definition at line 35 of file class.ilLTIConsumerPlaceholderDescription.php.

Referenced by getPlaceholderDescriptions().

---

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

• components/ILIAS/LTIConsumer/classes/Certificate/class.ilLTIConsumerPlaceholderDescription.php