ilCoursePlaceholderDescription Class Reference

Inheritance diagram for ilCoursePlaceholderDescription:

Collaboration diagram for ilCoursePlaceholderDescription:

Public Member Functions
	__construct (int $objectId, ?ilDefaultPlaceholderDescription $defaultPlaceholderDescriptionObject=null, ?ilLanguage $language=null, ?ilUserDefinedFieldsPlaceholderDescription $userDefinedFieldPlaceHolderDescriptionObject=null, ?ilObjectCustomUserFieldsPlaceholderDescription $customUserFieldsPlaceholderDescriptionObject=null)
	createPlaceholderHtmlDescription (?ilTemplate $template=null)
	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 ilObjectCustomUserFieldsPlaceholderDescription	$customUserFieldsPlaceholderDescriptionObject
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.ilCoursePlaceholderDescription.php.

Constructor & Destructor Documentation

__construct()

ilCoursePlaceholderDescription::__construct	(	int	$objectId,
		?ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = null,
		?ilLanguage	$language = null,
		?ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = null,
		?ilObjectCustomUserFieldsPlaceholderDescription	$customUserFieldsPlaceholderDescriptionObject = null
	)

Definition at line 31 of file class.ilCoursePlaceholderDescription.php.

References $customUserFieldsPlaceholderDescriptionObject, $DIC, $language, ilObjectCustomUserFieldsPlaceholderDescription\getPlaceholderDescriptions(), 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;

        if (null === $customUserFieldsPlaceholderDescriptionObject) {
            $customUserFieldsPlaceholderDescriptionObject = new ilObjectCustomUserFieldsPlaceholderDescription($objectId);
        }
        $this->customUserFieldsPlaceholderDescriptionObject = $customUserFieldsPlaceholderDescriptionObject;

        $customUserFieldsPlaceholderHtmlDescription = $this->customUserFieldsPlaceholderDescriptionObject->getPlaceholderDescriptions();
        $defaultPlaceholderDescription = $this->defaultPlaceHolderDescriptionObject->getPlaceholderDescriptions();

        $this->placeholder = array_merge($defaultPlaceholderDescription, $customUserFieldsPlaceholderHtmlDescription);
        $this->placeholder['COURSE_TITLE'] = $this->language->txt('crs_title');
        $this->placeholder['DATE_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
            $language->txt('certificate_ph_date_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()

ilCoursePlaceholderDescription::createPlaceholderHtmlDescription

(

?ilTemplate

$template = null

)

Definition at line 72 of file class.ilCoursePlaceholderDescription.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()

ilCoursePlaceholderDescription::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 95 of file class.ilCoursePlaceholderDescription.php.

References $placeholder.

                                                : array
    {
        return $this->placeholder;
    }

Field Documentation

$customUserFieldsPlaceholderDescriptionObject

readonly ilObjectCustomUserFieldsPlaceholderDescription ilCoursePlaceholderDescription::$customUserFieldsPlaceholderDescriptionObject

private

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

Referenced by __construct().

$defaultPlaceHolderDescriptionObject

readonly ilDefaultPlaceholderDescription ilCoursePlaceholderDescription::$defaultPlaceHolderDescriptionObject

private

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

$language

readonly ilLanguage ilCoursePlaceholderDescription::$language

private

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

Referenced by __construct().

$placeholder

array ilCoursePlaceholderDescription::$placeholder

private

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

Referenced by getPlaceholderDescriptions().

---

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

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