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 ()

	getPlaceholders ()

	getSpecificPlaceholders ()

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

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

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`
	)

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

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();
    }

References $envHelper, $languageHelper, and $orgUnitUserService.

Member Function Documentation

◆ getDescription()

ilMailTemplateContext::getDescription ( )

abstract

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

◆ getGenericPlaceholders()

ilMailTemplateContext::getGenericPlaceholders ( )

private

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

                                             : array
    {
        return [
            'mail_salutation' => [
                'placeholder' => 'MAIL_SALUTATION',
                'label' => $this->getLanguage()->txt('mail_nacc_salutation'),
            ],
            '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_last_name_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'),
            ],
        ];
    }

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, ilExcMailTemplateGradeReminderContext, ilExcMailTemplatePeerReminderContext, ilExcMailTemplateSubmitReminderContext, ilScormMailTemplateLPContext, ilSessionMailTemplateParticipantContext, ilStudyProgrammeMailTemplateContext, ilSurveyMailTemplateRaterInvitationContext, ilSurveyMailTemplateReminderContext, and ilMailTemplateGenericContext.

Referenced by ilMailTemplateContextService\createEntry().

Here is the caller graph for this function:

◆ getLanguage()

ilMailTemplateContext::getLanguage ( )

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

                                 : ilLanguage
    {
        return $this->language ?? $this->languageHelper->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:

◆ getPlaceholders()

ilMailTemplateContext::getPlaceholders ( )

final

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

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

References getGenericPlaceholders(), and getSpecificPlaceholders().

Here is the call graph for this function:

◆ getSpecificPlaceholders()

ilMailTemplateContext::getSpecificPlaceholders ( )

abstract

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

Referenced by getPlaceholders().

Here is the caller graph for this function:

◆ getTitle()

ilMailTemplateContext::getTitle ( )

abstract

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

◆ initLanguage()

ilMailTemplateContext::initLanguage ( ilObjUser $user )

protected

Definition at line 204 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 $isoCode )

protected

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

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

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

Here is the call graph for this function:

◆ resolvePlaceholder()

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

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

     : string {
        if ($recipient !== null) {
            $this->initLanguage($recipient);
        }
 
        $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_last_name_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,
                    $html_markup
                );
 
                ilDatePresentation::setLanguage($datePresentationLanguage);
                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`,
		bool	$html_markup = `false`
	)