Collection of basic placeholder values that can be used. More...

Inheritance diagram for ilDefaultPlaceholderDescription:

Collaboration diagram for ilDefaultPlaceholderDescription:

Public Member Functions
	__construct (ilLanguage $language, ilUserDefinedFieldsPlaceholderDescription $userDefinedFieldPlaceHolderDescriptionObject=null)

	createPlaceholderHtmlDescription (ilTemplate $template=null)
	This method is different then the 'getPlaceholderValues' method, this method is used to create a placeholder value array containing dummy values that is used to create a preview certificate. 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
	$placeholder

	$language

Detailed Description

Collection of basic placeholder values that can be used.

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

Definition at line 8 of file class.ilDefaultPlaceholderDescription.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

ilLanguage	$language
ilUserDefinedFieldsPlaceholderDescription \| null	$userDefinedFieldPlaceHolderDescriptionObject

Definition at line 24 of file class.ilDefaultPlaceholderDescription.php.

References $language, language(), ilLanguage\loadLanguageModule(), and ilLanguage\txt().

     {
         if (null === $userDefinedFieldPlaceHolderDescriptionObject) {
             $userDefinedFieldPlaceHolderDescriptionObject = new ilUserDefinedFieldsPlaceholderDescription();
         }
         $userDefinedPlaceholderHtmlDescription = $userDefinedFieldPlaceHolderDescriptionObject->getPlaceholderDescriptions();
 
         $language->loadLanguageModule('certificate');
         $this->language = $language;
 
         $this->placeholder = array(
             'USER_LOGIN' => $language->txt('certificate_ph_login'),
             'USER_FULLNAME' => $language->txt('certificate_ph_fullname'),
             'USER_FIRSTNAME' => $language->txt('certificate_ph_firstname'),
             'USER_LASTNAME' => $language->txt('certificate_ph_lastname'),
             'USER_TITLE' => $language->txt('certificate_ph_title'),
             'USER_SALUTATION' => $language->txt('certificate_ph_salutation'),
             'USER_BIRTHDAY' => $language->txt('certificate_ph_birthday'),
             'USER_INSTITUTION' => $language->txt('certificate_ph_institution'),
             'USER_DEPARTMENT' => $language->txt('certificate_ph_department'),
             'USER_STREET' => $language->txt('certificate_ph_street'),
             'USER_CITY' => $language->txt('certificate_ph_city'),
             'USER_ZIPCODE' => $language->txt('certificate_ph_zipcode'),
             'USER_COUNTRY' => $language->txt('certificate_ph_country'),
             'USER_MATRICULATION' => $language->txt('certificate_ph_matriculation'),
             'DATE' => $language->txt("certificate_ph_date"),
             'DATETIME' => $language->txt("certificate_ph_datetime"),
         );
 
         $this->placeholder = array_merge($this->placeholder, $userDefinedPlaceholderHtmlDescription);
     }

Here is the call graph for this function:

Member Function Documentation

◆ createPlaceholderHtmlDescription()

ilDefaultPlaceholderDescription::createPlaceholderHtmlDescription ( ilTemplate $template = null )

This method is different then the 'getPlaceholderValues' method, this method is used to create a placeholder value array containing dummy values that is used to create a preview certificate.

Parameters

null $template

Returns: array|mixed

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

ilDefaultPlaceholderDescription::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 89 of file class.ilDefaultPlaceholderDescription.php.

References $placeholder.

                                                  : array
     {
         return $this->placeholder;
     }

Field Documentation

◆ $language

ilDefaultPlaceholderDescription::$language

private

Definition at line 18 of file class.ilDefaultPlaceholderDescription.php.

Referenced by __construct().

◆ $placeholder

ilDefaultPlaceholderDescription::$placeholder

private

Definition at line 13 of file class.ilDefaultPlaceholderDescription.php.

Referenced by getPlaceholderDescriptions().

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

Services/Certificate/classes/Placeholder/Description/class.ilDefaultPlaceholderDescription.php

Public Member Functions

Private Attributes