ILIAS\Exercise\Certificate\ExercisePlaceholderDescription Class Reference

Inheritance diagram for ILIAS\Exercise\Certificate\ExercisePlaceholderDescription:

Collaboration diagram for ILIAS\Exercise\Certificate\ExercisePlaceholderDescription:

Public Member Functions
	__construct (?ilDefaultPlaceholderDescription $defaultPlaceholderDescriptionObject=null, ?ilLanguage $language=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 description as array value. More...
Public Member Functions inherited from ilCertificatePlaceholderDescription
	createPlaceholderHtmlDescription ()

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

Detailed Description

Author

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

Definition at line 33 of file ExercisePlaceholderDescription.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Exercise\Certificate\ExercisePlaceholderDescription::__construct	(	?ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = null,
		?ilLanguage	$language = null,
		?ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = null
	)

Definition at line 39 of file ExercisePlaceholderDescription.php.

References $DIC, ILIAS\Exercise\Certificate\ExercisePlaceholderDescription\$language, ILIAS\UI\examples\Symbol\Glyph\Language\language(), null, and ilLegacyFormElementsUtil\prepareFormOutput().

      {
        global $DIC;

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

        if (null === $defaultPlaceholderDescriptionObject) {
            $defaultPlaceholderDescriptionObject = new ilDefaultPlaceholderDescription(
                $language,
                $userDefinedFieldPlaceHolderDescriptionObject
            );
        }
        $this->placeholder = $defaultPlaceholderDescriptionObject->getPlaceholderDescriptions();

        $this->placeholder['RESULT_PASSED'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_var_result_passed')
        );
        $this->placeholder['RESULT_MARK'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_var_result_mark_short')
        );
        $this->placeholder['EXERCISE_TITLE'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_ph_exercisetitle')
        );
        $this->placeholder['DATE_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_ph_datetime_completed')
        );
        $this->placeholder['DATETIME_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_ph_datetime_completed')
        );
    }

Here is the call graph for this function:

Member Function Documentation

createPlaceholderHtmlDescription()

ILIAS\Exercise\Certificate\ExercisePlaceholderDescription::createPlaceholderHtmlDescription

(

?ilTemplate

$template = null

)

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

Returns

string - [PLACEHOLDER] => 'description'

Definition at line 82 of file ExercisePlaceholderDescription.php.

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

                                                                                  : 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();
    }

Here is the call graph for this function:

getPlaceholderDescriptions()

ILIAS\Exercise\Certificate\ExercisePlaceholderDescription::getPlaceholderDescriptions

(

)

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

Returns

array - [PLACEHOLDER] => 'description'

Implements ilCertificatePlaceholderDescription.

Definition at line 105 of file ExercisePlaceholderDescription.php.

References ILIAS\Exercise\Certificate\ExercisePlaceholderDescription\$placeholder.

                                                : array
    {
        return $this->placeholder;
    }

Field Documentation

$defaultPlaceHolderDescriptionObject

readonly ilDefaultPlaceholderDescription ILIAS\Exercise\Certificate\ExercisePlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

Definition at line 35 of file ExercisePlaceholderDescription.php.

$language

readonly ilLanguage ILIAS\Exercise\Certificate\ExercisePlaceholderDescription::$language

private

Definition at line 36 of file ExercisePlaceholderDescription.php.

Referenced by ILIAS\Exercise\Certificate\ExercisePlaceholderDescription\__construct().

$placeholder

array ILIAS\Exercise\Certificate\ExercisePlaceholderDescription::$placeholder

private

Definition at line 37 of file ExercisePlaceholderDescription.php.

Referenced by ILIAS\Exercise\Certificate\ExercisePlaceholderDescription\getPlaceholderDescriptions().

---

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

• components/ILIAS/Exercise/Certificate/ExercisePlaceholderDescription.php