ilDefaultPlaceholderValues Class Reference

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 $unix_ts_format_id=null, ?ilLanguage $language=null, ?ilCertificateUtilHelper $utilHelper=null, ?ilUserDefinedFieldsPlaceholderValues $userDefinedFieldsPlaceholderValues=null, ?ILIAS\Data\UUID\Factory $uuid_factory=null, ?int $birthdayDateFormat=null)
	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...
	setUserLanguage (ilLanguage $language)
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 Member Functions
	getUserLanguage (ilObjUser $user)

Private Attributes
readonly array	$placeholder
readonly ilCertificateObjectHelper	$objectHelper
readonly ilCertificateDateHelper	$dateHelper
readonly int	$unix_ts_format_id
readonly int	$birthdayDateFormat
readonly ilLanguage	$language
readonly ilCertificateUtilHelper	$utilHelper
readonly ilUserDefinedFieldsPlaceholderValues	$userDefinedFieldsPlaceholderValues
readonly Factory	$uuid_factory
ilLanguage	$user_language = null

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	$unix_ts_format_id = null,
		?ilLanguage	$language = null,
		?ilCertificateUtilHelper	$utilHelper = null,
		?ilUserDefinedFieldsPlaceholderValues	$userDefinedFieldsPlaceholderValues = null,
		?ILIAS\Data\UUID\Factory	$uuid_factory = null,
		?int	$birthdayDateFormat = null
	)

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

References $DIC, $language, $objId, $placeholder, ilCertificatePlaceholderValues\getPlaceholderValues(), getUserLanguage(), IL_CAL_DATE, IL_CAL_UNIX, and ILIAS\UI\examples\Symbol\Glyph\Language\language().

      {
        $this->objectHelper = $objectHelper ?? new ilCertificateObjectHelper();
        $this->dateHelper = $dateHelper ?? new ilCertificateDateHelper();

        require_once __DIR__ . '/../../../../Calendar/classes/class.ilDateTime.php'; // Required because of global contant IL_CAL_DATE

        $this->unix_ts_format_id = $unix_ts_format_id ?? IL_CAL_UNIX;
        $this->birthdayDateFormat = $birthdayDateFormat ?? IL_CAL_DATE;

        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $this->language = $language;

        $this->utilHelper = $utilHelper ?? new ilCertificateUtilHelper();
        $this->userDefinedFieldsPlaceholderValues =
            $userDefinedFieldsPlaceholderValues ?? new ilUserDefinedFieldsPlaceholderValues();
        $this->uuid_factory = $uuid_factory ?? new ILIAS\Data\UUID\Factory();

        $this->placeholder = [
            'CERTIFICATE_ID' => '',
            '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

Exceptions

ilDateTimeException
ilException

Implements ilCertificatePlaceholderValues.

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

                                                                           : array
    {
        $previewPlacholderValues = [
            'CERTIFICATE_ID' => $this->utilHelper->prepareFormOutput($this->uuid_factory->uuid4AsString()),
            "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(),
                null,
                $this->unix_ts_format_id
            )))),
            "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(),
                null,
                $this->unix_ts_format_id
            )))),
            'DATETIME' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDateTime(
                time(),
                null,
                $this->unix_ts_format_id
            )))),
            'DATE_COMPLETED' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDate(
                time(),
                null,
                $this->unix_ts_format_id
            )))),
            'DATETIME_COMPLETED' => $this->utilHelper->prepareFormOutput((trim($this->dateHelper->formatDateTime(
                time(),
                null,
                $this->unix_ts_format_id
            ))))
        ];

        return array_merge(
            $previewPlacholderValues,
            $this->userDefinedFieldsPlaceholderValues->getPlaceholderValuesForPreview($userId, $objId)
        );
    }

getUserLanguage()

ilDefaultPlaceholderValues::getUserLanguage ( ilObjUser  $user )

private

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

References $language, $user_language, ilObjUser\getLanguage(), and ilLanguage\loadLanguageModule().

Referenced by __construct().

                                                     : ilLanguage
    {
        if ($this->user_language instanceof ilLanguage) {
            return $this->user_language;
        }
        $language = new ilLanguage($user->getLanguage());
        $language->loadLanguageModule('certificate');
        $this->user_language = $language;
        return $language;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setUserLanguage()

ilDefaultPlaceholderValues::setUserLanguage

(

ilLanguage

$language

)

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

References $language.

                                                         : void
    {
        $this->user_language = $language;
    }

Field Documentation

$birthdayDateFormat

readonly int ilDefaultPlaceholderValues::$birthdayDateFormat

private

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

$dateHelper

readonly ilCertificateDateHelper ilDefaultPlaceholderValues::$dateHelper

private

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

$language

readonly ilLanguage ilDefaultPlaceholderValues::$language

private

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

Referenced by __construct(), getUserLanguage(), and setUserLanguage().

$objectHelper

readonly ilCertificateObjectHelper ilDefaultPlaceholderValues::$objectHelper

private

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

$placeholder

readonly array ilDefaultPlaceholderValues::$placeholder

private

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

Referenced by __construct().

$unix_ts_format_id

readonly int ilDefaultPlaceholderValues::$unix_ts_format_id

private

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

$user_language

ilLanguage ilDefaultPlaceholderValues::$user_language = null

private

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

Referenced by getUserLanguage().

$userDefinedFieldsPlaceholderValues

readonly ilUserDefinedFieldsPlaceholderValues ilDefaultPlaceholderValues::$userDefinedFieldsPlaceholderValues

private

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

$utilHelper

readonly ilCertificateUtilHelper ilDefaultPlaceholderValues::$utilHelper

private

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

$uuid_factory

readonly Factory ilDefaultPlaceholderValues::$uuid_factory

private

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

---

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

• components/ILIAS/Certificate/classes/Placeholder/Values/class.ilDefaultPlaceholderValues.php