ilExercisePlaceholderDescription Class Reference

Inheritance diagram for ilExercisePlaceholderDescription:

Collaboration diagram for ilExercisePlaceholderDescription:

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 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 24 of file class.ilExercisePlaceholderDescription.php.

Constructor & Destructor Documentation

__construct()

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

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

References $DIC, $language, ILIAS\UI\examples\Symbol\Glyph\Language\language(), 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->defaultPlaceHolderDescriptionObject = $defaultPlaceholderDescriptionObject;

        $this->placeholder = $this->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()

ilExercisePlaceholderDescription::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 75 of file class.ilExercisePlaceholderDescription.php.

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

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

Here is the call graph for this function:

getPlaceholderDescriptions()

ilExercisePlaceholderDescription::getPlaceholderDescriptions

(

)

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

Returns

array - [PLACEHOLDER] => 'description'

Implements ilCertificatePlaceholderDescription.

Definition at line 98 of file class.ilExercisePlaceholderDescription.php.

References $placeholder.

                                                : array
    {
        return $this->placeholder;
    }

Field Documentation

$defaultPlaceHolderDescriptionObject

readonly ilDefaultPlaceholderDescription ilExercisePlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

Definition at line 26 of file class.ilExercisePlaceholderDescription.php.

$language

readonly ilLanguage ilExercisePlaceholderDescription::$language

private

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

Referenced by __construct().

$placeholder

array ilExercisePlaceholderDescription::$placeholder

private

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

Referenced by getPlaceholderDescriptions().

---

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

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