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 ()
	This method MUST return an array containing an array with the the description as array value. More...
	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
	$defaultPlaceHolderDescriptionObject
	$language
	$placeholder

Detailed Description

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

Constructor & Destructor Documentation

__construct()

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

Parameters

ilDefaultPlaceholderDescription | null	$defaultPlaceholderDescriptionObject
ilLanguage | null	$language
ilUserDefinedFieldsPlaceholderDescription | null	$userDefinedFieldPlaceHolderDescriptionObject

Definition at line 35 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'] = ilUtil::prepareFormOutput($this->language->txt('lti_cert_ph_object_title'));
        $this->placeholder['OBJECT_DESCRIPTION'] = ilUtil::prepareFormOutput($this->language->txt('lti_cert_ph_object_description'));
        $this->placeholder['MASTERY_SCORE'] = ilUtil::prepareFormOutput($this->language->txt('lti_cert_ph_mastery_score'));
        $this->placeholder['REACHED_SCORE'] = ilUtil::prepareFormOutput($this->language->txt('lti_cert_ph_reached_score'));
        $this->placeholder['DATE_COMPLETED'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_date_completed'));
        $this->placeholder['DATETIME_COMPLETED'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_datetime_completed'));
    }

References $DIC, $language, language(), and ilUtil\prepareFormOutput().

Here is the call graph for this function:

Member Function Documentation

createPlaceholderHtmlDescription()

ilLTIConsumerPlaceholderDescription::createPlaceholderHtmlDescription

(

ilTemplate

$template = null

)

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

                                                                                  : string
    {
        if (null === $template) {
            $template = new ilTemplate('tpl.default_description.html', true, true, 'Services/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 language().

Here is the call graph for this function:

getPlaceholderDescriptions()

ilLTIConsumerPlaceholderDescription::getPlaceholderDescriptions

(

)

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

Returns

array<string, string> A [PLACEHOLDER] => 'description' map

Implements ilCertificatePlaceholderDescription.

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

                                                 : array
    {
        return $this->placeholder;
    }

References $placeholder.

Field Documentation

$defaultPlaceHolderDescriptionObject

ilLTIConsumerPlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

ilLTIConsumerPlaceholderDescription::$language

private

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

Referenced by __construct().

$placeholder

ilLTIConsumerPlaceholderDescription::$placeholder

private

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

Referenced by getPlaceholderDescriptions().

---

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

• Modules/LTIConsumer/classes/Certificate/class.ilLTIConsumerPlaceholderDescription.php