ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ILIAS\Course\Certificate\CoursePlaceholderDescription Class Reference
+ 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, ?Profile $profile=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
 getPlaceholderDescriptions ()
 This method MUST return an array containing an array with the the description as array value. More...
 
 createPlaceholderHtmlDescription ()
 

Private Attributes

readonly ilDefaultPlaceholderDescription $defaultPlaceHolderDescriptionObject
 
readonly ilObjectCustomUserFieldsPlaceholderDescription $customUserFieldsPlaceholderDescriptionObject
 
readonly ilLanguage $language
 
array $placeholder
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 42 of file CoursePlaceholderDescription.php.

49 {
50 global $DIC;
51
52 if (null === $language) {
53 $language = $DIC->language();
54 $language->loadLanguageModule('certificate');
55 }
56 $this->language = $language;
57
58 if (null === $defaultPlaceholderDescriptionObject) {
59 $defaultPlaceholderDescriptionObject = new ilDefaultPlaceholderDescription(
61 $profile ?? $DIC['user']->getProfile(),
62 $userDefinedFieldPlaceHolderDescriptionObject
63 );
64 }
65 $this->defaultPlaceHolderDescriptionObject = $defaultPlaceholderDescriptionObject;
66
69 }
70 $this->customUserFieldsPlaceholderDescriptionObject = $customUserFieldsPlaceholderDescriptionObject;
71
72 $customUserFieldsPlaceholderHtmlDescription = $this->customUserFieldsPlaceholderDescriptionObject->getPlaceholderDescriptions();
73 $defaultPlaceholderDescription = $this->defaultPlaceHolderDescriptionObject->getPlaceholderDescriptions();
74
75 $this->placeholder = array_merge($defaultPlaceholderDescription, $customUserFieldsPlaceholderHtmlDescription);
76 $this->placeholder['COURSE_TITLE'] = $this->language->txt('crs_title');
77 $this->placeholder['DATE_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
78 $language->txt('certificate_ph_date_completed')
79 );
80 $this->placeholder['DATETIME_COMPLETED'] = ilLegacyFormElementsUtil::prepareFormOutput(
81 $language->txt('certificate_ph_datetime_completed')
82 );
83 }
readonly ilObjectCustomUserFieldsPlaceholderDescription $customUserFieldsPlaceholderDescriptionObject
Collection of basic placeholder values that can be used.
loadLanguageModule(string $a_module)
Load language module.
txt(string $a_topic, string $a_default_lang_fallback_mod="")
gets the text for a given topic if the topic is not in the list, the topic itself with "-" will be re...
static prepareFormOutput($a_str, bool $a_strip=false)
getPlaceholderDescriptions()
This method MUST return an array containing an array with the the description as array value.
global $DIC
Definition: shib_login.php:26

References ILIAS\Course\Certificate\CoursePlaceholderDescription\$customUserFieldsPlaceholderDescriptionObject, $DIC, ILIAS\Course\Certificate\CoursePlaceholderDescription\$language, ilObjectCustomUserFieldsPlaceholderDescription\getPlaceholderDescriptions(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilLanguage\loadLanguageModule(), ilLegacyFormElementsUtil\prepareFormOutput(), and ilLanguage\txt().

+ Here is the call graph for this function:

Member Function Documentation

◆ createPlaceholderHtmlDescription()

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

Definition at line 85 of file CoursePlaceholderDescription.php.

85 : string
86 {
87 if (null === $template) {
88 $template = new ilTemplate('tpl.default_description.html', true, true, 'components/ILIAS/Certificate');
89 }
90
91 $template->setVariable('PLACEHOLDER_INTRODUCTION', $this->language->txt('certificate_ph_introduction'));
92
93 $template->setCurrentBlock('items');
94 foreach ($this->placeholder as $id => $caption) {
95 $template->setVariable('ID', $id);
96 $template->setVariable('TXT', $caption);
97 $template->parseCurrentBlock();
98 }
99
100 return $template->get();
101 }
$id
plugin.php for ilComponentBuildPluginInfoObjectiveTest::testAddPlugins
Definition: plugin.php:23
special template class to simplify handling of ITX/PEAR

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

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

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

Field Documentation

◆ $customUserFieldsPlaceholderDescriptionObject

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

◆ $defaultPlaceHolderDescriptionObject

readonly ilDefaultPlaceholderDescription ILIAS\Course\Certificate\CoursePlaceholderDescription::$defaultPlaceHolderDescriptionObject
private

Definition at line 37 of file CoursePlaceholderDescription.php.

◆ $language

readonly ilLanguage ILIAS\Course\Certificate\CoursePlaceholderDescription::$language
private

◆ $placeholder

array ILIAS\Course\Certificate\CoursePlaceholderDescription::$placeholder
private

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