Inheritance diagram for ilMailTemplateContext:

Collaboration diagram for ilMailTemplateContext:

Public Member Functions
	__construct (?OrgUnitUserService $org_unit_user_service=null, ?ilMailEnvironmentHelper $environment_helper=null, ?ilMailUserHelper $user_helper=null, ?ilMailLanguageHelper $language_helper=null)

	getLanguage ()

	getId ()

	getTitle ()

	getDescription ()

	getNestedPlaceholders ()

	getPlaceholders ()

	getSpecificPlaceholders ()

	requiresRecipientByPlaceholderName (string $placeholder_name)

	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 $iso_code)

Protected Attributes
ilLanguage	$language

ilMailEnvironmentHelper	$env_helper

ilMailLanguageHelper	$language_helper

ilMailUserHelper	$user_helper

OrgUnitUserService	$org_unit_user_service

Private Member Functions
	getGenericPlaceholders ()

	findPlaceholderByMustacheName (string $placeholder_name)

	placeholderDefinitionRequiresRecipient (array $placeholder_definition)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilMailTemplateContext::__construct	(	?OrgUnitUserService	$org_unit_user_service = `null`,
		?ilMailEnvironmentHelper	$environment_helper = `null`,
		?ilMailUserHelper	$user_helper = `null`,
		?ilMailLanguageHelper	$language_helper = `null`
	)

Reimplemented in ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilStudyProgrammeMailTemplateContext, ilSurveyMailTemplateRaterInvitationContext, and ilSurveyMailTemplateReminderContext.

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

      {
        $this->org_unit_user_service = $org_unit_user_service ?? new OrgUnitUserService();
        $this->env_helper = $environment_helper ?? new ilMailEnvironmentHelper();
        $this->user_helper = $user_helper ?? new ilMailUserHelper();
        $this->language_helper = $language_helper ?? new ilMailLanguageHelper();
    }

References $language_helper, $org_unit_user_service, and $user_helper.

Member Function Documentation

◆ findPlaceholderByMustacheName()

ilMailTemplateContext::findPlaceholderByMustacheName ( string $placeholder_name )

private

Returns: array{key: string, definition: array{ placeholder: string, label: string, requiresRecipient?: bool, supportsNestedPlaceholders?: bool }}|null

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

                                                                            : ?array
    {
        foreach ($this->getPlaceholders() as $key => $placeholder_definition) {
            if (strtoupper($placeholder_definition['placeholder']) !== strtoupper($placeholder_name)) {
                continue;
            }
 
            return [
                'key' => (string) $key,
                'definition' => $placeholder_definition,
            ];
        }
 
        return null;
    }

References getPlaceholders().

Referenced by requiresRecipientByPlaceholderName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescription()

ilMailTemplateContext::getDescription ( )

abstract

Reimplemented in ilCourseMailTemplateMemberContext, ilCourseMailTemplateTutorContext, ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilExcMailTemplateSubmitReminderContext, ilMailTemplateGenericContext, ilScormMailTemplateLPContext, ilSessionMailTemplateParticipantContext, ilStudyProgrammeMailTemplateContext, ilSurveyMailTemplateRaterInvitationContext, and ilSurveyMailTemplateReminderContext.

◆ getGenericPlaceholders()

ilMailTemplateContext::getGenericPlaceholders ( )

private

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

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

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

References getLanguage().

Referenced by getPlaceholders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilMailTemplateContext::getId ( )

abstract

Reimplemented in ilCourseMailTemplateMemberContext, ilCourseMailTemplateTutorContext, ilCourseMailTemplateTutorContextPreview, ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilExcMailTemplateSubmitReminderContext, ilMailTemplateGenericContext, ilScormMailTemplateLPContext, ilSessionMailTemplateParticipantContext, ilStudyProgrammeMailTemplateContext, ilStudyProgrammeMailTemplateContextPreview, ilSurveyMailTemplateRaterInvitationContext, and ilSurveyMailTemplateReminderContext.

Referenced by ilMailTemplateContextService\createEntry().

Here is the caller graph for this function:

◆ getLanguage()

ilMailTemplateContext::getLanguage ( )

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

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

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

Referenced by ilMailTemplateGenericContext\getDescription(), getGenericPlaceholders(), and ilMailTemplateGenericContext\getTitle().

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 117 of file class.ilMailTemplateContext.php.

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

References getPlaceholders().

Here is the call graph for this function:

◆ getPlaceholders()

ilMailTemplateContext::getPlaceholders ( )

final

Returns: array<string, array{ placeholder: string, label: string, requiresRecipient?: bool, supportsNestedPlaceholders?: bool }>

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

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

References getGenericPlaceholders(), and getSpecificPlaceholders().

Referenced by findPlaceholderByMustacheName(), and getNestedPlaceholders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificPlaceholders()

ilMailTemplateContext::getSpecificPlaceholders ( )

abstract

Returns: array<string, array{ placeholder: string, label: string, requiresRecipient?: bool, supportsNestedPlaceholders?: bool }>

Reimplemented in ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilExcMailTemplateSubmitReminderContext, ilMailTemplateGenericContext, ilSessionMailTemplateParticipantContext, ilStudyProgrammeMailTemplateContext, and ilSurveyMailTemplateRaterInvitationContext.

Referenced by getPlaceholders().

Here is the caller graph for this function:

◆ getTitle()

ilMailTemplateContext::getTitle ( )

abstract

Reimplemented in ilCourseMailTemplateMemberContext, ilCourseMailTemplateTutorContext, ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilExcMailTemplateSubmitReminderContext, ilMailTemplateGenericContext, ilScormMailTemplateLPContext, ilSessionMailTemplateParticipantContext, ilStudyProgrammeMailTemplateContext, ilSurveyMailTemplateRaterInvitationContext, and ilSurveyMailTemplateReminderContext.

◆ initLanguage()

ilMailTemplateContext::initLanguage ( ilObjUser $user )

protected

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

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

References ilObjUser\getLanguage().

Referenced by resolvePlaceholder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLanguageByIso2Code()

ilMailTemplateContext::initLanguageByIso2Code ( string $iso_code )

protected

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

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

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

Here is the call graph for this function:

◆ placeholderDefinitionRequiresRecipient()

ilMailTemplateContext::placeholderDefinitionRequiresRecipient ( array $placeholder_definition )

private

Parameters

array{ placeholder: string, label: string, requiresRecipient?: bool, supportsNestedPlaceholders?: bool } $placeholder_definition

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

                                                                                          : bool
    {
        return $placeholder_definition['requiresRecipient'] ?? false;
    }

Referenced by requiresRecipientByPlaceholderName().

Here is the caller graph for this function:

◆ requiresRecipientByPlaceholderName()

ilMailTemplateContext::requiresRecipientByPlaceholderName ( string $placeholder_name )

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

                                                                                : bool
    {
        $found = $this->findPlaceholderByMustacheName($placeholder_name);
        if ($found === null) {
            return false;
        }
 
        return $this->placeholderDefinitionRequiresRecipient($found['definition']);
    }

References findPlaceholderByMustacheName(), and placeholderDefinitionRequiresRecipient().

Here is the call graph for this function:

◆ resolvePlaceholder()

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

Parameters

array<string,mixed> $context_parameters

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

     : string {
        if ($recipient !== null) {
            $this->initLanguage($recipient);
        }
 
        $placeholder_id = strtolower($placeholder_id);
        $resolved = '';
        switch (true) {
            case ($placeholder_id === 'mail_salutation' && $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 ($placeholder_id === 'first_name' && $recipient !== null):
                $resolved = $recipient->getFirstname();
                break;
 
            case ($placeholder_id === 'last_name' && $recipient !== null):
                $resolved = $recipient->getLastname();
                break;
 
            case ($placeholder_id === 'login' && $recipient !== null):
                $resolved = $recipient->getLogin();
                break;
 
            case ($placeholder_id === 'title' && $recipient !== null):
                $resolved = $recipient->getUTitle();
                break;
 
            case $placeholder_id === 'ilias_url':
                $resolved = $this->env_helper->getHttpPath() . ' ';
                break;
 
            case $placeholder_id === 'installation_name':
                $resolved = $this->env_helper->getClientId();
                break;
 
            case $placeholder_id === 'firstname_lastname_superior' && $recipient !== null:
                $ou_users = $this->org_unit_user_service->getUsers([$recipient->getId()], true);
                foreach ($ou_users as $ou_user) {
                    $superiors = $ou_user->getSuperiors();
 
                    $superior_usr_ids = array_map(static fn(ilOrgUnitUser $ou_user): int => $ou_user->getUserId(), $superiors);
 
                    $usr_id_by_name_map = $this->user_helper->getUsernameMapForIds($superior_usr_ids);
 
                    $resolved = implode(', ', $usr_id_by_name_map);
                    break;
                }
                break;
 
            case !array_key_exists($placeholder_id, $this->getGenericPlaceholders()):
                $date_presentation_language = ilDatePresentation::getLanguage();
                ilDatePresentation::setLanguage($this->getLanguage());
 
                $resolved = $this->resolveSpecificPlaceholder(
                    $placeholder_id,
                    $context_parameters,
                    $recipient
                );
 
                ilDatePresentation::setLanguage($date_presentation_language);
                break;
        }
 
        return $resolved;
    }

References initLanguage().

Here is the call graph for this function:

◆ resolveSpecificPlaceholder()

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

abstract

Parameters

array<string,mixed> $context_parameters

Reimplemented in ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilExcMailTemplateSubmitReminderContext, ilMailTemplateGenericContext, ilSessionMailTemplateParticipantContext, and ilStudyProgrammeMailTemplateContextPreview.

Field Documentation

◆ $env_helper

ilMailEnvironmentHelper ilMailTemplateContext::$env_helper

protected

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

◆ $language

ilLanguage ilMailTemplateContext::$language

protected

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

◆ $language_helper

ilMailLanguageHelper ilMailTemplateContext::$language_helper

protected

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

Referenced by __construct().

◆ $org_unit_user_service

OrgUnitUserService ilMailTemplateContext::$org_unit_user_service

protected

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

Referenced by __construct().

◆ $user_helper

ilMailUserHelper ilMailTemplateContext::$user_helper

protected

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

Referenced by __construct().

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

components/ILIAS/Mail/classes/class.ilMailTemplateContext.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ findPlaceholderByMustacheName()

◆ getDescription()

◆ getGenericPlaceholders()

◆ getId()

◆ getLanguage()

◆ getNestedPlaceholders()

◆ getPlaceholders()

◆ getSpecificPlaceholders()

◆ getTitle()

◆ initLanguage()

◆ initLanguageByIso2Code()

◆ placeholderDefinitionRequiresRecipient()

◆ requiresRecipientByPlaceholderName()

◆ resolvePlaceholder()

◆ resolveSpecificPlaceholder()

Field Documentation

◆ $env_helper

◆ $language

◆ $language_helper

◆ $org_unit_user_service

◆ $user_helper