ilDefaultPlaceholderDescription Class Reference

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
array	$placeholder
readonly ilLanguage	$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 25 of file class.ilDefaultPlaceholderDescription.php.

Constructor & Destructor Documentation

__construct()

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

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

References $language, ILIAS\UI\examples\Symbol\Glyph\Language\language(), ilLanguage\loadLanguageModule(), null, and ilLanguage\txt().

      {
        if (null === $userDefinedFieldPlaceHolderDescriptionObject) {
            $userDefinedFieldPlaceHolderDescriptionObject = new ilUserDefinedFieldsPlaceholderDescription();
        }
        $userDefinedPlaceholderHtmlDescription = $userDefinedFieldPlaceHolderDescriptionObject->getPlaceholderDescriptions();

        $language->loadLanguageModule('certificate');
        $this->language = $language;

        $this->placeholder = [
            'CERTIFICATE_ID' => $language->txt('certificate_ph_cert_id'),
            '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.

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

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

References $placeholder.

                                                : array
    {
        return $this->placeholder;
    }

Field Documentation

$language

readonly ilLanguage ilDefaultPlaceholderDescription::$language

private

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

Referenced by __construct().

$placeholder

array ilDefaultPlaceholderDescription::$placeholder

private

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

Referenced by getPlaceholderDescriptions().

---

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

• components/ILIAS/Certificate/classes/Placeholder/Description/class.ilDefaultPlaceholderDescription.php