Inheritance diagram for ilMailTemplateContext:

Collaboration diagram for ilMailTemplateContext:

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

	getLanguage ()

	getId ()
	Returns a unique (in the context of mail template contexts) id. More...

	getTitle ()
	Returns a translated title (depending on the current language) which is displayed in the user interface. More...

	getDescription ()
	Returns a translated description (depending on the current language) which is displayed in the user interface. More...

	getPlaceholders ()
	Return an array of placeholders. More...

	getSpecificPlaceholders ()
	Return an array of placeholders. More...

	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
	$language

	$envHelper

	$languageHelper

	$userHelper

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

Constructor & Destructor Documentation

◆ __construct()

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

ilMailTemplateContext constructor.

Parameters

OrgUnitUserService \| null	$orgUnitUserService
ilMailEnvironmentHelper \| null	$envHelper
ilMailUserHelper \| null	$usernameHelper
ilMailLanguageHelper \| null	$languageHelper

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

References $envHelper, $languageHelper, and $orgUnitUserService.

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

Member Function Documentation

◆ getDescription()

ilMailTemplateContext::getDescription ( )

abstract

Returns a translated description (depending on the current language) which is displayed in the user interface.

Returns: string

Referenced by getLanguage().

Here is the caller graph for this function:

◆ getGenericPlaceholders()

ilMailTemplateContext::getGenericPlaceholders ( )

private

Returns: array

Definition at line 95 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')
             ],
             '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')
             ],
             'client_name' => [
                 'placeholder' => 'CLIENT_NAME',
                 'label' => $this->getLanguage()->txt('mail_nacc_client_name')
             ],
         ];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilMailTemplateContext::getId ( )

abstract

Returns a unique (in the context of mail template contexts) id.

Returns: string

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

Here is the caller graph for this function:

◆ getLanguage()

ilMailTemplateContext::getLanguage ( )

Returns: ilLanguage

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

References getDescription(), getId(), getTitle(), and language().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPlaceholders()

ilMailTemplateContext::getPlaceholders ( )

final

Return an array of placeholders.

Returns: array

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

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

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

Here is the call graph for this function:

◆ getSpecificPlaceholders()

ilMailTemplateContext::getSpecificPlaceholders ( )

abstract

Return an array of placeholders.

Returns: array

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

Here is the caller graph for this function:

◆ getTitle()

ilMailTemplateContext::getTitle ( )

abstract

Returns a translated title (depending on the current language) which is displayed in the user interface.

Returns: string

Referenced by getLanguage().

Here is the caller graph for this function:

◆ initLanguage()

ilMailTemplateContext::initLanguage ( ilObjUser $user )

protected

Parameters

ilObjUser $user

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

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

Referenced by resolvePlaceholder().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initLanguageByIso2Code()

ilMailTemplateContext::initLanguageByIso2Code ( string $isoCode )

protected

Parameters

string $isoCode

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

References 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`,
		bool	$html_markup = `false`
	)

Parameters

string	$placeholder_id	The unique (in the context of your class) placeholder id
array	$context_parameters	The context parameters given by the mail system (array of key/value pairs)
ilObjUser \| null	$recipient	The recipient for this mail
bool	$html_markup	A flag whether or not the return value may contain HTML markup

Returns: string

Definition at line 173 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);
         }
 
         $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() . '/login.php?client_id=' . $this->envHelper->getClientId();
                 break;
 
             case 'client_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(function (ilOrgUnitUser $ouUser) {
                         return $ouUser->getUserId();
                     }, $superiors);
 
                     $usrIdByNameMap = $this->userHelper->getUsernameMapForIds($superiorUsrIds);
 
                     $resolved = implode(', ', $usrIdByNameMap);
                     break;
                 }
                 break;
 
             case !in_array($placeholder_id, array_keys($this->getGenericPlaceholders())):
                 $datePresentationLanguage = ilDatePresentation::getLanguage();
                 ilDatePresentation::setLanguage($this->getLanguage());
 
                 $resolved = $this->resolveSpecificPlaceholder(
                     $placeholder_id,
                     $context_parameters,
                     $recipient,
                     $html_markup
                 );
 
                 ilDatePresentation::setLanguage($datePresentationLanguage);
                 break;
         }
 
         return (string) $resolved;
     }

Here is the call graph for this function:

◆ resolveSpecificPlaceholder()

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