Inheritance diagram for ilMailTemplateContext:

Collaboration diagram for ilMailTemplateContext:

Public Member Functions
	__construct (OrgUnitUserService $orgUnitUserService=null, ilMailEnvironmentHelper $envHelper=null, ilMailUserHelper $usernameHelper=null, ilMailLanguageHelper $languageHelper=null)

	getLanguage ()

	getId ()

	getTitle ()

	getDescription ()

	getNestedPlaceholders ()

	getPlaceholders ()

	getSpecificPlaceholders ()

	resolveSpecificPlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null)

	resolvePlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null)

Protected Member Functions
	initLanguage (ilObjUser $user)

	initLanguageByIso2Code (string $isoCode)

Protected Attributes
ilLanguage	$language

ilMailEnvironmentHelper	$envHelper

ilMailLanguageHelper	$languageHelper

ilMailUserHelper	$userHelper

OrgUnitUserService	$orgUnitUserService

Private Member Functions
	getGenericPlaceholders ()

Detailed Description

Class ilMailTemplateContext.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilMailTemplateContext::__construct	(	OrgUnitUserService	$orgUnitUserService = `null`,
		ilMailEnvironmentHelper	$envHelper = `null`,
		ilMailUserHelper	$usernameHelper = `null`,
		ilMailLanguageHelper	$languageHelper = `null`
	)

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

       {
         $this->orgUnitUserService = $orgUnitUserService ?? new OrgUnitUserService();
         $this->envHelper = $envHelper ?? new ilMailEnvironmentHelper();
         $this->userHelper = $usernameHelper ?? new ilMailUserHelper();
         $this->languageHelper = $languageHelper ?? new ilMailLanguageHelper();
     }

Member Function Documentation

◆ getDescription()

ilMailTemplateContext::getDescription ( )

abstract

Referenced by getLanguage().

Here is the caller graph for this function:

◆ getGenericPlaceholders()

ilMailTemplateContext::getGenericPlaceholders ( )

private

Returns: array{mail_salutation: array{placeholder: string, label: string, supportsNestedPlaceholders?: true}, first_name: array{placeholder: string, label: string}, last_name: array{placeholder: string, label: string}, login: array{placeholder: string, label: string}, title: array{placeholder: string, label: string, supportsCondition: true}, firstname_lastname_superior: array{placeholder: string, label: string}, ilias_url: array{placeholder: string, label: string}, installation_name: array{placeholder: string, label: string}}

Definition at line 63 of file class.ilMailTemplateContext.php.

References getLanguage().

Referenced by getPlaceholders(), and resolvePlaceholder().

                                              : array
     {
         return [
             'mail_salutation' => [
                 'placeholder' => 'MAIL_SALUTATION',
                 'label' => $this->getLanguage()->txt('mail_nacc_salutation'),
                 'supportsNestedPlaceholders' => true,
             ],
             'first_name' => [
                 'placeholder' => 'FIRST_NAME',
                 'label' => $this->getLanguage()->txt('firstname'),
             ],
             'last_name' => [
                 'placeholder' => 'LAST_NAME',
                 'label' => $this->getLanguage()->txt('lastname'),
             ],
             'login' => [
                 'placeholder' => 'LOGIN',
                 'label' => $this->getLanguage()->txt('mail_nacc_login'),
             ],
             'title' => [
                 'placeholder' => 'TITLE',
                 'label' => $this->getLanguage()->txt('mail_nacc_title'),
                 'supportsCondition' => true,
             ],
             'firstname_lastname_superior' => [
                 'placeholder' => 'FIRSTNAME_LASTNAME_SUPERIOR',
                 'label' => $this->getLanguage()->txt('mail_firstname_last_name_superior'),
             ],
             'ilias_url' => [
                 'placeholder' => 'ILIAS_URL',
                 'label' => $this->getLanguage()->txt('mail_nacc_ilias_url'),
             ],
             'installation_name' => [
                 'placeholder' => 'INSTALLATION_NAME',
                 'label' => $this->getLanguage()->txt('mail_nacc_installation_name'),
             ],
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilMailTemplateContext::getId ( )

abstract

Referenced by ilMailTemplateContextService\createEntry(), and getLanguage().

Here is the caller graph for this function:

◆ getLanguage()

ilMailTemplateContext::getLanguage ( )

Definition at line 49 of file class.ilMailTemplateContext.php.

References getDescription(), getId(), getTitle(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by ilCourseMailTemplateTutorContext\getCachedPeriodByObjId(), ilMailTemplateGenericContext\getDescription(), ilScormMailTemplateLPContext\getDescription(), getGenericPlaceholders(), ilMailTemplateGenericContext\getTitle(), and resolvePlaceholder().

                                  : ilLanguage
     {
         return $this->language ?? $this->languageHelper->getCurrentLanguage();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNestedPlaceholders()

ilMailTemplateContext::getNestedPlaceholders ( )

Returns: list<string>

Definition at line 106 of file class.ilMailTemplateContext.php.

References ILIAS\LTI\ToolProvider\$key, and getPlaceholders().

                                            : array
     {
         $nested_placeholders = [];
         foreach ($this->getPlaceholders() as $key => $ph) {
             if (isset($ph['supportsNestedPlaceholders']) && $ph['supportsNestedPlaceholders']) {
                 $nested_placeholders[] = $ph['placeholder'];
             }
         }
 
         return $nested_placeholders;
     }

Here is the call graph for this function:

◆ getPlaceholders()

ilMailTemplateContext::getPlaceholders ( )

final

Definition at line 118 of file class.ilMailTemplateContext.php.

References getGenericPlaceholders(), getSpecificPlaceholders(), and resolveSpecificPlaceholder().

Referenced by getNestedPlaceholders().

                                            : array
     {
         $placeholders = $this->getGenericPlaceholders();
         $specific = $this->getSpecificPlaceholders();
 
         return array_merge($placeholders, $specific);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificPlaceholders()

ilMailTemplateContext::getSpecificPlaceholders ( )

abstract

Referenced by ilScormMailTemplateLPContext\getDescription(), ilCourseMailTemplateTutorContext\getDescription(), ilCourseMailTemplateMemberContext\getDescription(), ilSurveyMailTemplateReminderContext\getDescription(), and getPlaceholders().

Here is the caller graph for this function:

◆ getTitle()

ilMailTemplateContext::getTitle ( )

abstract

Referenced by getLanguage().

Here is the caller graph for this function:

◆ initLanguage()

ilMailTemplateContext::initLanguage ( ilObjUser $user )

protected

Definition at line 220 of file class.ilMailTemplateContext.php.

References ilObjUser\getLanguage(), and initLanguageByIso2Code().

Referenced by resolvePlaceholder().

                                                     : void
     {
         $this->initLanguageByIso2Code($user->getLanguage());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLanguageByIso2Code()

ilMailTemplateContext::initLanguageByIso2Code ( string $isoCode )

protected

Definition at line 225 of file class.ilMailTemplateContext.php.

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

Referenced by initLanguage().

                                                               : void
     {
         $this->language = $this->languageHelper->getLanguageByIsoCode($isoCode);
         $this->language->loadLanguageModule('mail');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resolvePlaceholder()

ilMailTemplateContext::resolvePlaceholder	(	string	$placeholder_id,
		array	$context_parameters,
		ilObjUser	$recipient = `null`
	)

Definition at line 134 of file class.ilMailTemplateContext.php.

References getGenericPlaceholders(), getLanguage(), ilDatePresentation\getLanguage(), OrgUnit\User\ilOrgUnitUser\getUserId(), initLanguage(), resolveSpecificPlaceholder(), and ilDatePresentation\setLanguage().

      : string {
         if ($recipient !== null) {
             $this->initLanguage($recipient);
         }
 
         $placeholder_id = strtolower($placeholder_id);
         $resolved = '';
         switch (true) {
             case ('mail_salutation' === $placeholder_id && $recipient !== null):
                 $resolved = $this->getLanguage()->txt('mail_salutation_n');
                 switch ($recipient->getGender()) {
                     case 'f':
                         $resolved = $this->getLanguage()->txt('mail_salutation_f');
                         break;
 
                     case 'm':
                         $resolved = $this->getLanguage()->txt('mail_salutation_m');
                         break;
 
                     case 'n':
                         $resolved = $this->getLanguage()->txt('mail_salutation_n');
                         break;
                 }
                 break;
 
             case ('first_name' === $placeholder_id && $recipient !== null):
                 $resolved = $recipient->getFirstname();
                 break;
 
             case ('last_name' === $placeholder_id && $recipient !== null):
                 $resolved = $recipient->getLastname();
                 break;
 
             case ('login' === $placeholder_id && $recipient !== null):
                 $resolved = $recipient->getLogin();
                 break;
 
             case ('title' === $placeholder_id && $recipient !== null):
                 $resolved = $recipient->getUTitle();
                 break;
 
             case 'ilias_url' === $placeholder_id:
                 $resolved = $this->envHelper->getHttpPath() . ' ';
                 break;
 
             case 'installation_name' === $placeholder_id:
                 $resolved = $this->envHelper->getClientId();
                 break;
 
             case 'firstname_lastname_superior' === $placeholder_id && $recipient !== null:
                 $ouUsers = $this->orgUnitUserService->getUsers([$recipient->getId()], true);
                 foreach ($ouUsers as $ouUser) {
                     $superiors = $ouUser->getSuperiors();
 
                     $superiorUsrIds = array_map(static function (ilOrgUnitUser $ouUser): int {
                         return $ouUser->getUserId();
                     }, $superiors);
 
                     $usrIdByNameMap = $this->userHelper->getUsernameMapForIds($superiorUsrIds);
 
                     $resolved = implode(', ', $usrIdByNameMap);
                     break;
                 }
                 break;
 
             case !array_key_exists($placeholder_id, $this->getGenericPlaceholders()):
                 $datePresentationLanguage = ilDatePresentation::getLanguage();
                 ilDatePresentation::setLanguage($this->getLanguage());
 
                 $resolved = $this->resolveSpecificPlaceholder(
                     $placeholder_id,
                     $context_parameters,
                     $recipient
                 );
 
                 ilDatePresentation::setLanguage($datePresentationLanguage);
                 break;
         }
 
         return $resolved;
     }