ilMailTemplateContext Class Reference

Class ilMailTemplateContext. More...

Inheritance diagram for ilMailTemplateContext:

Collaboration diagram for ilMailTemplateContext:

Public Member Functions
	getLanguage ()
	setLanguage ($language)
	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 ($placeholder_id, array $context_parameters, ilObjUser $recipient=null, $html_markup=false)
	resolvePlaceholder ($placeholder_id, array $context_parameters, ilObjUser $recipient=null, $html_markup=false)

Protected Member Functions
	initLanguage (ilObjUser $user)
	initLanguageByIso2Code ($a_code)
	Init language by ISO2 code. More...

Protected Attributes
	$language

Static Private Member Functions
static	getGenericPlaceholders ()

Detailed Description

Class ilMailTemplateContext.

Author

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

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

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

Here is the caller graph for this function:

getGenericPlaceholders()

static ilMailTemplateContext::getGenericPlaceholders ( )

staticfinalprivate

Returns

array

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

References $DIC.

    {
        global $DIC;

        return array(
            'mail_salutation' => array(
                'placeholder' => 'MAIL_SALUTATION',
                'label' => $DIC->language()->txt('mail_nacc_salutation')
            ),
            'first_name' => array(
                'placeholder' => 'FIRST_NAME',
                'label' => $DIC->language()->txt('firstname')
            ),
            'last_name' => array(
                'placeholder' => 'LAST_NAME',
                'label' => $DIC->language()->txt('lastname')
            ),
            'login' => array(
                'placeholder' => 'LOGIN',
                'label' => $DIC->language()->txt('mail_nacc_login')
            ),
            'title' => array(
                'placeholder' => 'TITLE',
                'label' => $DIC->language()->txt('mail_nacc_title'),
                'supportsCondition' => true
            ),
            'ilias_url' => array(
                'placeholder' => 'ILIAS_URL',
                'label' => $DIC->language()->txt('mail_nacc_ilias_url')
            ),
            'client_name' => array(
                'placeholder' => 'CLIENT_NAME',
                'label' => $DIC->language()->txt('mail_nacc_client_name')
            )
        );
    }

getId()

ilMailTemplateContext::getId ( )

abstract

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

Returns

string

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

Here is the caller graph for this function:

getLanguage()

ilMailTemplateContext::getLanguage

(

)

Returns

ilLanguage|null

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

References $DIC.

Referenced by ilScormMailTemplateLPContext\getDescription(), ilCourseMailTemplateTutorContext\getDescription(), and resolvePlaceholder().

    {
        global $DIC;

        return $this->language ? $this->language : $DIC->language();
    }

Here is the caller graph for this function:

getPlaceholders()

ilMailTemplateContext::getPlaceholders ( )

final

Return an array of placeholders.

Returns

array

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

References getSpecificPlaceholders(), and resolveSpecificPlaceholder().

    {
        $placeholders = self::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 setLanguage().

Here is the caller graph for this function:

initLanguage()

ilMailTemplateContext::initLanguage ( ilObjUser  $user )

protected

Parameters

ilObjUser

$user

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

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

Referenced by resolvePlaceholder().

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

Here is the call graph for this function:

Here is the caller graph for this function:

initLanguageByIso2Code()

ilMailTemplateContext::initLanguageByIso2Code (   $a_code )

protected

Init language by ISO2 code.

Parameters

string

$a_code

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

References ilLanguageFactory\_getLanguage().

Referenced by initLanguage().

    {
        $this->language = ilLanguageFactory::_getLanguage($a_code);
        $this->language->loadLanguageModule('mail');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resolvePlaceholder()

ilMailTemplateContext::resolvePlaceholder	(		$placeholder_id,
		array	$context_parameters,
		ilObjUser	$recipient = null,
			$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 128 of file class.ilMailTemplateContext.php.

References getLanguage(), ilDatePresentation\getLanguage(), initLanguage(), resolveSpecificPlaceholder(), and ilDatePresentation\setLanguage().

    {
        if ($recipient !== null) {
            $this->initLanguage($recipient);
        }

        $old_lang = ilDatePresentation::getLanguage();
        ilDatePresentation::setLanguage($this->getLanguage());

        $resolved = '';

        switch (true) {
            case ('mail_salutation' == $placeholder_id && $recipient !== null):
                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;

                    default:
                        $resolved = $this->getLanguage()->txt('mail_salutation_n');
                }
                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 = ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID;
                break;

            case 'client_name' == $placeholder_id:
                $resolved = CLIENT_NAME;
                break;

            case !in_array($placeholder_id, array_keys(self::getGenericPlaceholders())):
                $resolved = $this->resolveSpecificPlaceholder($placeholder_id, $context_parameters, $recipient, $html_markup);
                break;
        }

        ilDatePresentation::setLanguage($old_lang);

        return $resolved;
    }

Here is the call graph for this function:

resolveSpecificPlaceholder()

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

abstract

Parameters

string	$placeholder_id
array	$context_parameters
ilObjUser | null	$recipient
bool	$html_markup

Returns

string

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

Here is the caller graph for this function:

setLanguage()

ilMailTemplateContext::setLanguage

(

$language

)

Parameters

ilLanguage | null

$language

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

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

    {
        $this->language = $language;
    }

Here is the call graph for this function:

Field Documentation

$language

ilMailTemplateContext::$language

protected

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

Referenced by setLanguage().

---

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

• Services/Mail/classes/class.ilMailTemplateContext.php