Handles exercise Peer reminder mail placeholders If all contexts are using the same placeholders,constructor etc. More...

Inheritance diagram for ilExcMailTemplatePeerReminderContext:

Collaboration diagram for ilExcMailTemplatePeerReminderContext:

Public Member Functions

__construct (?OrgUnitUserService $orgUnitUserService=null, ?ilMailEnvironmentHelper $envHelper=null, ?ilMailUserHelper $usernameHelper=null, ?ilMailLanguageHelper $languageHelper=null)

getId ()

getTitle ()

getDescription ()

getSpecificPlaceholders ()

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

{

Parameters

array<string,mixed> $context_parameters

} More...

Public Member Functions inherited from ilMailTemplateContext

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

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

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

Data Fields
const	ID = 'exc_context_peer_rmd'

Protected Attributes
ilLanguage	$lng

ilObjectDataCache	$obj_data_cache

Protected Attributes inherited from ilMailTemplateContext
ilLanguage	$language

ilMailEnvironmentHelper	$env_helper

ilMailLanguageHelper	$language_helper

ilMailUserHelper	$user_helper

OrgUnitUserService	$org_unit_user_service

Additional Inherited Members
Protected Member Functions inherited from ilMailTemplateContext
	initLanguage (ilObjUser $user)

	initLanguageByIso2Code (string $iso_code)

Detailed Description

Handles exercise Peer reminder mail placeholders If all contexts are using the same placeholders,constructor etc.

todo: create base class.

Author: Jesús López lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilMailTemplateContext.

Definition at line 35 of file class.ilExcMailTemplatePeerReminderContext.php.

      {
        global $DIC;
 
        parent::__construct(
            $orgUnitUserService,
            $envHelper,
            $usernameHelper,
            $languageHelper
        );
 
        $this->lng = $DIC->language();
        if (isset($DIC["ilObjDataCache"])) {
            $this->obj_data_cache = $DIC["ilObjDataCache"];
        }
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ getDescription()

ilExcMailTemplatePeerReminderContext::getDescription ( )

Reimplemented from ilMailTemplateContext.

Definition at line 70 of file class.ilExcMailTemplatePeerReminderContext.php.

                                    : string
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule('exc');
 
        return $lng->txt('exc_mail_context_peer_reminder_info');
    }

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getId()

ilExcMailTemplatePeerReminderContext::getId ( )

Reimplemented from ilMailTemplateContext.

Definition at line 56 of file class.ilExcMailTemplatePeerReminderContext.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getSpecificPlaceholders()

ilExcMailTemplatePeerReminderContext::getSpecificPlaceholders ( )

Returns: array<string, array{placeholder: string, crs_period_end_mail_placeholder: string}>

Reimplemented from ilMailTemplateContext.

Definition at line 79 of file class.ilExcMailTemplatePeerReminderContext.php.

                                             : array
    {
        $lng = $this->lng;
        $lng->loadLanguageModule('exc');
 
        $placeholders = array();
 
        $placeholders['assignment_title'] = array(
            'placeholder' => 'ASSIGNMENT_TITLE',
            'label' => $lng->txt('exc_mail_context_reminder_assignment_title')
        );
        $placeholders['exercise_title'] = array(
            'placeholder' => 'EXERCISE_TITLE',
            'label' => $lng->txt('exc_mail_context_reminder_exercise_title')
        );
 
        $placeholders['assignment_link'] = array(
            'placeholder' => 'ASSIGNMENT_LINK',
            'label' => $lng->txt('perma_link')
        );
 
        return $placeholders;
    }

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getTitle()

ilExcMailTemplatePeerReminderContext::getTitle ( )

Reimplemented from ilMailTemplateContext.

Definition at line 61 of file class.ilExcMailTemplatePeerReminderContext.php.

                              : string
    {
        $lng = $this->lng;
 
        $lng->loadLanguageModule('exc');
 
        return $lng->txt('exc_mail_context_peer_reminder_title');
    }

References $lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Here is the call graph for this function:

◆ resolveSpecificPlaceholder()

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

{

Parameters

array<string,mixed> $context_parameters

}

Reimplemented from ilMailTemplateContext.

Definition at line 106 of file class.ilExcMailTemplatePeerReminderContext.php.

     : string {
        $ilObjDataCache = $this->obj_data_cache;
 
        if ($placeholder_id == 'assignment_title') {
            return ilExAssignment::lookupTitle($context_parameters["ass_id"]);
        } else {
            if ($placeholder_id == 'exercise_title') {
                return $ilObjDataCache->lookupTitle((int) $context_parameters["exc_id"]);
            } else {
                if ($placeholder_id == 'assignment_link') {
                    return ilLink::_getLink(
                        $context_parameters["exc_ref"],
                        "exc",
                        array(),
                        "_" . $context_parameters["ass_id"]
                    );
                }
            }
        }
 
        return '';
    }