The placeholders a certificate of an LTI object offers: the default ones, the object, the scores and the completion. More...

Inheritance diagram for ilLTIToolPlaceholderDescription:

Collaboration diagram for ilLTIToolPlaceholderDescription:

Public Member Functions
	__construct ()

	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
ilLanguage	$language

array	$placeholders

Detailed Description

The placeholders a certificate of an LTI object offers: the default ones, the object, the scores and the completion.

ilCertificateGUIFactory creates it by this name.

Author: Saúl Díaz sdiaz.nosp@m.@sur.nosp@m.labs..nosp@m.com

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

Constructor & Destructor Documentation

◆ __construct()

ilLTIToolPlaceholderDescription::__construct ( )

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

    {
        global $DIC;
 
        $this->language = $DIC->language();
        $this->language->loadLanguageModule('certificate');
 
        $default = new ilDefaultPlaceholderDescription($this->language, $DIC['user']->getProfile());
        $own = [
            'OBJECT_TITLE' => 'lti_cert_ph_object_title',
            'OBJECT_DESCRIPTION' => 'lti_cert_ph_object_description',
            'MASTERY_SCORE' => 'lti_cert_ph_mastery_score',
            'REACHED_SCORE' => 'lti_cert_ph_reached_score',
            'DATE_COMPLETED' => 'certificate_ph_date_completed',
            'DATETIME_COMPLETED' => 'certificate_ph_datetime_completed',
        ];
 
        $util_helper = new ilCertificateUtilHelper();
        $this->placeholders = $default->getPlaceholderDescriptions() + array_map(
            fn(string $txt): string => $util_helper->prepareFormOutput($this->language->txt($txt)),
            $own
        );
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ createPlaceholderHtmlDescription()

ilLTIToolPlaceholderDescription::createPlaceholderHtmlDescription ( ?ilTemplate $template = null )

Exceptions

ilTemplateException

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

                                                                                  : string
    {
        $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->placeholders 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()

ilLTIToolPlaceholderDescription::getPlaceholderDescriptions ( )

Returns: array

Implements ilCertificatePlaceholderDescription.

Definition at line 59 of file class.ilLTIToolPlaceholderDescription.php.

                                                : array
    {
        return $this->placeholders;
    }

References $placeholders.

Field Documentation

◆ $language

ilLanguage ilLTIToolPlaceholderDescription::$language

private

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

◆ $placeholders

array ilLTIToolPlaceholderDescription::$placeholders

private

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

Referenced by getPlaceholderDescriptions().

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

components/ILIAS/LTI/classes/Object/Certificate/class.ilLTIToolPlaceholderDescription.php

Public Member Functions

Private Attributes