Inheritance diagram for ILIAS\Course\Certificate\CoursePlaceholderDescription:

Collaboration diagram for ILIAS\Course\Certificate\CoursePlaceholderDescription:

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 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 34 of file CoursePlaceholderDescription.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Course\Certificate\CoursePlaceholderDescription::__construct	(	int	$objectId,
		?ilDefaultPlaceholderDescription	$defaultPlaceholderDescriptionObject = `null`,
		?ilLanguage	$language = `null`,
		?ilUserDefinedFieldsPlaceholderDescription	$userDefinedFieldPlaceHolderDescriptionObject = `null`,
		?ilObjectCustomUserFieldsPlaceholderDescription	$customUserFieldsPlaceholderDescriptionObject = `null`
	)

Definition at line 41 of file CoursePlaceholderDescription.php.

References ILIAS\Course\Certificate\CoursePlaceholderDescription\$customUserFieldsPlaceholderDescriptionObject, $DIC, ILIAS\Course\Certificate\CoursePlaceholderDescription\$language, ilObjectCustomUserFieldsPlaceholderDescription\getPlaceholderDescriptions(), 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->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()

ILIAS\Course\Certificate\CoursePlaceholderDescription::createPlaceholderHtmlDescription ( ?ilTemplate $template = null )

Definition at line 82 of file CoursePlaceholderDescription.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\Course\Certificate\CoursePlaceholderDescription::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 CoursePlaceholderDescription.php.

References ILIAS\Course\Certificate\CoursePlaceholderDescription\$placeholder.

                                                 : array
     {
         return $this->placeholder;
     }

Field Documentation

◆ $customUserFieldsPlaceholderDescriptionObject

readonly ilObjectCustomUserFieldsPlaceholderDescription ILIAS\Course\Certificate\CoursePlaceholderDescription::$customUserFieldsPlaceholderDescriptionObject

private

Definition at line 37 of file CoursePlaceholderDescription.php.

Referenced by ILIAS\Course\Certificate\CoursePlaceholderDescription\__construct().