class.ilMailTemplateContext.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use OrgUnit\User\ilOrgUnitUser;
use OrgUnit\PublicApi\OrgUnitUserService;
 
abstract class ilMailTemplateContext
{
    protected ilLanguage $language;
    protected ilMailEnvironmentHelper $env_helper;
    protected ilMailLanguageHelper $language_helper;
    protected ilMailUserHelper $user_helper;
    protected OrgUnitUserService $org_unit_user_service;
 
    public function __construct(
        ?OrgUnitUserService $org_unit_user_service = null,
        ?ilMailEnvironmentHelper $environment_helper = null,
        ?ilMailUserHelper $user_helper = null,
        ?ilMailLanguageHelper $language_helper = null
    ) {
        $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();
    }
 
    public function getLanguage(): ilLanguage
    {
        return $this->language ?? $this->language_helper->getCurrentLanguage();
    }
 
    abstract public function getId(): string;
 
    abstract public function getTitle(): string;
 
    abstract public function getDescription(): string;
 
    private function getGenericPlaceholders(): 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,
            ],
        ];
    }
 
    public function getNestedPlaceholders(): array
    {
        $nested_placeholders = [];
        foreach ($this->getPlaceholders() as $key => $ph) {
            if (isset($ph['supportsNestedPlaceholders']) && $ph['supportsNestedPlaceholders']) {
                $nested_placeholders[] = $ph['placeholder'];
            }
        }
 
        return $nested_placeholders;
    }
 
    final public function getPlaceholders(): array
    {
        $placeholders = $this->getGenericPlaceholders();
        $specific = $this->getSpecificPlaceholders();
 
        return array_merge($placeholders, $specific);
    }
 
    abstract public function getSpecificPlaceholders(): array;
 
    public function requiresRecipientByPlaceholderName(string $placeholder_name): bool
    {
        $found = $this->findPlaceholderByMustacheName($placeholder_name);
        if ($found === null) {
            return false;
        }
 
        return $this->placeholderDefinitionRequiresRecipient($found['definition']);
    }
 
    private function findPlaceholderByMustacheName(string $placeholder_name): ?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;
    }
 
    private function placeholderDefinitionRequiresRecipient(array $placeholder_definition): bool
    {
        return $placeholder_definition['requiresRecipient'] ?? false;
    }
 
    abstract public function resolveSpecificPlaceholder(
        string $placeholder_id,
        array $context_parameters,
        ?ilObjUser $recipient = null
    ): string;
 
    public function resolvePlaceholder(
        string $placeholder_id,
        array $context_parameters,
        ?ilObjUser $recipient = null
    ): 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;
    }
 
    protected function initLanguage(ilObjUser $user): void
    {
        $this->initLanguageByIso2Code($user->getLanguage());
    }
 
    protected function initLanguageByIso2Code(string $iso_code): void
    {
        $this->language = $this->language_helper->getLanguageByIsoCode($iso_code);
        $this->language->loadLanguageModule('mail');
    }
}