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

Inheritance diagram for ilDefaultPlaceholderValues:

Collaboration diagram for ilDefaultPlaceholderValues:

Public Member Functions
	__construct (?ilCertificateObjectHelper $objectHelper=null, ?ilCertificateDateHelper $dateHelper=null, ?int $dateFormat=null, ?ilLanguage $language=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilUserDefinedFieldsPlaceholderValues $userDefinedFieldsPlaceholderValues=null, int $birthdayDateFormat=IL_CAL_DATE)

	getPlaceholderValuesForPreview (int $userId, int $objId)
	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...

Public Member Functions inherited from ilCertificatePlaceholderValues
	getPlaceholderValues (int $userId, int $objId)
	This method MUST return an array that contains the actual data for the given user of the given object. More...

Private Attributes
array	$placeholder

ilCertificateObjectHelper	$objectHelper

ilCertificateDateHelper	$dateHelper

int	$dateFormat

ilLanguage	$language

ilCertificateUtilHelper	$utilHelper

ilUserDefinedFieldsPlaceholderValues	$userDefinedFieldsPlaceholderValues

int	$birthdayDateFormat

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 27 of file class.ilDefaultPlaceholderValues.php.

Constructor & Destructor Documentation

◆ __construct()

ilDefaultPlaceholderValues::__construct	(	?ilCertificateObjectHelper	$objectHelper = `null`,
		?ilCertificateDateHelper	$dateHelper = `null`,
		?int	$dateFormat = `null`,
		?ilLanguage	$language = `null`,
		?ilCertificateUtilHelper	$utilHelper = `null`,
		?ilUserDefinedFieldsPlaceholderValues	$userDefinedFieldsPlaceholderValues = `null`,
		int	$birthdayDateFormat = `IL_CAL_DATE`
	)

Definition at line 38 of file class.ilDefaultPlaceholderValues.php.

References $birthdayDateFormat, $dateFormat, $dateHelper, $DIC, $language, $objectHelper, $objId, $placeholder, $userDefinedFieldsPlaceholderValues, $utilHelper, ilCertificatePlaceholderValues\getPlaceholderValues(), IL_CAL_UNIX, ILIAS\UI\examples\Symbol\Glyph\Language\language(), and ilLanguage\loadLanguageModule().

       {
         if (null === $objectHelper) {
             $objectHelper = new ilCertificateObjectHelper();
         }
         $this->objectHelper = $objectHelper;
 
         if (null === $dateHelper) {
             $dateHelper = new ilCertificateDateHelper();
         }
         $this->dateHelper = $dateHelper;
 
         if (null === $dateFormat) {
             $dateFormat = IL_CAL_UNIX;
         }
         $this->dateFormat = $dateFormat;
 
         if (null === $language) {
             global $DIC;
             $language = $DIC->language();
             $language->loadLanguageModule('certificate');
         }
         $this->language = $language;
 
         if (null === $utilHelper) {
             $utilHelper = new ilCertificateUtilHelper();
         }
         $this->utilHelper = $utilHelper;
 
         if (null === $userDefinedFieldsPlaceholderValues) {
             $userDefinedFieldsPlaceholderValues = new ilUserDefinedFieldsPlaceholderValues();
         }
         $this->userDefinedFieldsPlaceholderValues = $userDefinedFieldsPlaceholderValues;
 
         $this->birthdayDateFormat = $birthdayDateFormat;
 
         $this->placeholder = [
             'USER_LOGIN' => '',
             'USER_FULLNAME' => '',
             'USER_FIRSTNAME' => '',
             'USER_LASTNAME' => '',
             'USER_TITLE' => '',
             'USER_SALUTATION' => '',
             'USER_BIRTHDAY' => '',
             'USER_INSTITUTION' => '',
             'USER_DEPARTMENT' => '',
             'USER_STREET' => '',
             'USER_CITY' => '',
             'USER_ZIPCODE' => '',
             'USER_COUNTRY' => '',
             'USER_MATRICULATION' => '',
             'DATE' => '',
             'DATETIME' => '',
             'DATE_COMPLETED' => '',
             'DATETIME_COMPLETED' => '',
         ];
     }

Here is the call graph for this function:

Member Function Documentation

◆ getPlaceholderValuesForPreview()

ilDefaultPlaceholderValues::getPlaceholderValuesForPreview	(	int	$userId,
		int	$objId
	)

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.

Due the fact that this is a class to create default values the placeholder values will be identical to the description

Parameters

int	$userId
int	$objId

Returns: array

Exceptions

ilDateTimeException
ilException

Implements ilCertificatePlaceholderValues.

Definition at line 178 of file class.ilDefaultPlaceholderValues.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                                            : array
     {
         $previewPlacholderValues = [
             "USER_LOGIN" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_login")),
             "USER_FULLNAME" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_fullname")),
             "USER_FIRSTNAME" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_firstname")),
             "USER_LASTNAME" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_lastname")),
             "USER_TITLE" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_title")),
             "USER_SALUTATION" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_salutation")),
             "USER_BIRTHDAY" => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDate(
                 time(),
                 $this->dateFormat
             )))),
             "USER_INSTITUTION" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_institution")),
             "USER_DEPARTMENT" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_department")),
             "USER_STREET" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_street")),
             "USER_CITY" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_city")),
             "USER_ZIPCODE" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_zipcode")),
             "USER_COUNTRY" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_country")),
             "USER_MATRICULATION" => $this->utilHelper->prepareFormOutput($this->language->txt("certificate_var_user_matriculation")),
             'DATE' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDate(
                 time(),
                 $this->dateFormat
             )))),
             'DATETIME' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDateTime(
                 time(),
                 $this->dateFormat
             )))),
             'DATE_COMPLETED' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDate(
                 time(),
                 $this->dateFormat
             )))),
             'DATETIME_COMPLETED' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDateTime(
                 time(),
                 $this->dateFormat
             ))))
         ];
 
         return array_merge(
             $previewPlacholderValues,
             $this->userDefinedFieldsPlaceholderValues->getPlaceholderValuesForPreview($userId, $objId)
         );
     }

Here is the call graph for this function:

Field Documentation

◆ $birthdayDateFormat

int ilDefaultPlaceholderValues::$birthdayDateFormat

private

Definition at line 36 of file class.ilDefaultPlaceholderValues.php.

Referenced by __construct().

◆ $dateFormat

int ilDefaultPlaceholderValues::$dateFormat

private

Definition at line 32 of file class.ilDefaultPlaceholderValues.php.

Referenced by __construct().

◆ $dateHelper

ilCertificateDateHelper ilDefaultPlaceholderValues::$dateHelper

private

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

Referenced by __construct().

◆ $language

ilLanguage ilDefaultPlaceholderValues::$language

private

Definition at line 33 of file class.ilDefaultPlaceholderValues.php.

Referenced by __construct().

◆ $objectHelper

ilCertificateObjectHelper ilDefaultPlaceholderValues::$objectHelper

private

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

Referenced by __construct().

◆ $placeholder

array ilDefaultPlaceholderValues::$placeholder

private

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

Referenced by __construct().

◆ $userDefinedFieldsPlaceholderValues

ilUserDefinedFieldsPlaceholderValues ilDefaultPlaceholderValues::$userDefinedFieldsPlaceholderValues

private

Definition at line 35 of file class.ilDefaultPlaceholderValues.php.

Referenced by __construct().

◆ $utilHelper

ilCertificateUtilHelper ilDefaultPlaceholderValues::$utilHelper

private

Definition at line 34 of file class.ilDefaultPlaceholderValues.php.

Referenced by __construct().

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

Services/Certificate/classes/Placeholder/Values/class.ilDefaultPlaceholderValues.php

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getPlaceholderValuesForPreview()

Field Documentation

◆ $birthdayDateFormat

◆ $dateFormat

◆ $dateHelper

◆ $language

◆ $objectHelper

◆ $placeholder

◆ $userDefinedFieldsPlaceholderValues

◆ $utilHelper