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
	$defaultPlaceHolderDescriptionObject
	$language
	$placeholder

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

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

Parameters

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

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

References $DIC, $language, language(), and ilUtil\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'] = ilUtil::prepareFormOutput($language->txt('certificate_var_result_passed'));
        $this->placeholder['RESULT_MARK'] = ilUtil::prepareFormOutput($language->txt('certificate_var_result_mark_short'));
        $this->placeholder['EXERCISE_TITLE'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_exercisetitle'));
        $this->placeholder['DATE_COMPLETED'] = ilUtil::prepareFormOutput($language->txt('certificate_ph_datetime_completed'));
        $this->placeholder['DATETIME_COMPLETED'] = ilUtil::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.

Parameters

ilTemplate

$template

Returns

mixed - [PLACEHOLDER] => 'description'

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

References 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

mixed - [PLACEHOLDER] => 'description'

Implements ilCertificatePlaceholderDescription.

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

References $placeholder.

                                                 : array
    {
        return $this->placeholder;
    }

Field Documentation

$defaultPlaceHolderDescriptionObject

ilExercisePlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

ilExercisePlaceholderDescription::$language

private

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

Referenced by __construct().

$placeholder

ilExercisePlaceholderDescription::$placeholder

private

Definition at line 22 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