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

Inheritance diagram for ilExcMailTemplateGradeReminderContext:

Collaboration diagram for ilExcMailTemplateGradeReminderContext:

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)

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_grade_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 Grade 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 29 of file class.ilExcMailTemplateGradeReminderContext.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilMailTemplateContext.

Definition at line 36 of file class.ilExcMailTemplateGradeReminderContext.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getDescription()

ilExcMailTemplateGradeReminderContext::getDescription ( )

Reimplemented from ilMailTemplateContext.

Definition at line 72 of file class.ilExcMailTemplateGradeReminderContext.php.

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

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

Here is the call graph for this function:

◆ getId()

ilExcMailTemplateGradeReminderContext::getId ( )

Reimplemented from ilMailTemplateContext.

Definition at line 58 of file class.ilExcMailTemplateGradeReminderContext.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getSpecificPlaceholders()

ilExcMailTemplateGradeReminderContext::getSpecificPlaceholders ( )

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

Reimplemented from ilMailTemplateContext.

Definition at line 81 of file class.ilExcMailTemplateGradeReminderContext.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()

ilExcMailTemplateGradeReminderContext::getTitle ( )

Reimplemented from ilMailTemplateContext.

Definition at line 63 of file class.ilExcMailTemplateGradeReminderContext.php.

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

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

Here is the call graph for this function:

◆ resolveSpecificPlaceholder()

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

Parameters

array<string,mixed> $context_parameters

Reimplemented from ilMailTemplateContext.

Definition at line 105 of file class.ilExcMailTemplateGradeReminderContext.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 '';
    }