Inheritance diagram for ilStudyProgrammeMailTemplateContext:

Collaboration diagram for ilStudyProgrammeMailTemplateContext:

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

	getId ()

	getTitle ()

	getDescription ()

	getSpecificPlaceholders ()
	Return an array of placeholders. 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 = 'prg_context_manual'

Protected Member Functions
	getLatestAssignment (array $assignments)

	getLatestSuccessfulAssignment (array $assignments)

	statusToRepr (int $status, string $lang)

	date2String (?DateTimeImmutable $date_time=null, ?ilObjUser $user=null)

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

	initLanguageByIso2Code (string $iso_code)

Protected Attributes
ilLanguage	$lng

Protected Attributes inherited from ilMailTemplateContext
ilLanguage	$language

ilMailEnvironmentHelper	$env_helper

ilMailLanguageHelper	$language_helper

ilMailUserHelper	$user_helper

OrgUnitUserService	$org_unit_user_service

Private Attributes
const	TITLE = 'STUDY_PROGRAMME_TITLE'

const	DESCRIPTION = 'STUDY_PROGRAMME_DESCRIPTION'

const	TYPE = 'STUDY_PROGRAMME_TYPE'

const	LINK = 'STUDY_PROGRAMME_LINK'

const	ORG_UNIT = 'STUDY_PROGRAMME_ORG_UNITS'

const	STATUS = 'STUDY_PROGRAMME_STATUS'

const	COMPLETION_DATE = 'STUDY_PROGRAMME_COMPLETION_DATE'

const	COMPLETED_BY = 'STUDY_PROGRAMME_COMPLETED_BY'

const	POINTS_REQUIRED = 'STUDY_PROGRAMME_POINTS_REQUIRED'

const	POINTS_CURRENT = 'STUDY_PROGRAMME_POINTS_CURRENT'

const	DEADLINE = 'STUDY_PROGRAMME_DEADLINE'

const	EXPIRE_DATE = 'STUDY_PROGRAMME_EXPIRE_DATE'

const	VALIDITY = 'STUDY_PROGRAMME_VALIDITY'

const	PLACEHOLDER_TRANSLATIONS

const	DATE_FORMAT = 'd.m.Y'

Detailed Description

Definition at line 23 of file class.ilStudyProgrammeMailTemplateContext.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from ilMailTemplateContext.

Definition at line 62 of file class.ilStudyProgrammeMailTemplateContext.php.

      {
        parent::__construct(
            $orgUnitUserService,
            $envHelper,
            $usernameHelper,
            $languageHelper
        );
 
        global $DIC;
 
        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('prg');
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ date2String()

ilStudyProgrammeMailTemplateContext::date2String	(	?DateTimeImmutable	$date_time = `null`,
		?ilObjUser	$user = `null`
	)

protected

Definition at line 273 of file class.ilStudyProgrammeMailTemplateContext.php.

     : string {
        if (is_null($date_time)) {
            return '';
        }
        if (is_null($user)) {
            return $date_time->format(self::DATE_FORMAT);
        }
        return $user->getDateFormat()->applyTo($date_time);
    }

◆ getDescription()

ilStudyProgrammeMailTemplateContext::getDescription ( )

Reimplemented from ilMailTemplateContext.

Definition at line 91 of file class.ilStudyProgrammeMailTemplateContext.php.

                                    : string
    {
        return $this->lng->txt('prg_mail_context_info');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getId()

ilStudyProgrammeMailTemplateContext::getId ( )

Reimplemented from ilMailTemplateContext.

Definition at line 81 of file class.ilStudyProgrammeMailTemplateContext.php.

                           : string
    {
        return self::ID;
    }

References ID.

◆ getLatestAssignment()

ilStudyProgrammeMailTemplateContext::getLatestAssignment ( array $assignments )

protected

Definition at line 210 of file class.ilStudyProgrammeMailTemplateContext.php.

                                                              : ilPRGAssignment
    {
        usort($assignments, static function (ilPRGAssignment $a, ilPRGAssignment $b): int {
            $a_dat = $a->getProgressTree()->getAssignmentDate();
            $b_dat = $b->getProgressTree()->getAssignmentDate();
            if ($a_dat > $b_dat) {
                return -1;
            } elseif ($a_dat < $b_dat) {
                return 1;
            } else {
                return 0;
            }
        });
        return array_shift($assignments);
    }

References Vendor\Package\$a, and Vendor\Package\$b.

◆ getLatestSuccessfulAssignment()

ilStudyProgrammeMailTemplateContext::getLatestSuccessfulAssignment ( array $assignments )

protected

Definition at line 226 of file class.ilStudyProgrammeMailTemplateContext.php.

                                                                        : ?ilPRGAssignment
    {
        $successful = array_filter(
            $assignments,
            fn($ass) => $ass->getProgressTree()->isSuccessful()
        );
        if (count($successful) === 0) {
            return null;
        }
 
        usort($successful, static function (ilPRGAssignment $a, ilPRGAssignment $b): int {
            $a_dat = $a->getProgressTree()->getCompletionDate();
            $b_dat = $b->getProgressTree()->getCompletionDate();
            if ($a_dat > $b_dat) {
                return -1;
            } elseif ($a_dat < $b_dat) {
                return 1;
            } else {
                return 0;
            }
        });
        return array_shift($successful);
    }

References Vendor\Package\$a, and Vendor\Package\$b.

◆ getSpecificPlaceholders()

ilStudyProgrammeMailTemplateContext::getSpecificPlaceholders ( )

Return an array of placeholders.

Reimplemented from ilMailTemplateContext.

Definition at line 99 of file class.ilStudyProgrammeMailTemplateContext.php.

                                             : array
    {
        $placeholders = [];
        foreach (self::PLACEHOLDER_TRANSLATIONS as $id => $label) {
            $placeholders[$id] = [
                'placeholder' => $id,
                'label' => $this->lng->txt($label)
            ];
        }
        return $placeholders;
    }

References $id, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getTitle()

ilStudyProgrammeMailTemplateContext::getTitle ( )

Reimplemented from ilMailTemplateContext.

Definition at line 86 of file class.ilStudyProgrammeMailTemplateContext.php.

                              : string
    {
        return $this->lng->txt('prg_mail_context_title');
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

◆ statusToRepr()

ilStudyProgrammeMailTemplateContext::statusToRepr	(	int	$status,
		string	$lang
	)

protected

Definition at line 252 of file class.ilStudyProgrammeMailTemplateContext.php.

                                                              : string
    {
        if ($status === ilPRGProgress::STATUS_IN_PROGRESS) {
            return $this->lng->txtlng('prg', 'prg_status_in_progress', $lang);
        }
        if ($status === ilPRGProgress::STATUS_COMPLETED) {
            return $this->lng->txtlng('prg', 'prg_status_completed', $lang);
        }
        if ($status === ilPRGProgress::STATUS_ACCREDITED) {
            return $this->lng->txtlng('prg', 'prg_status_accredited', $lang);
        }
        if ($status === ilPRGProgress::STATUS_NOT_RELEVANT) {
            return $this->lng->txtlng('prg', 'prg_status_not_relevant', $lang);
        }
        if ($status === ilPRGProgress::STATUS_FAILED) {
            return $this->lng->txtlng('prg', 'prg_status_failed', $lang);
        }
 
        throw new ilException("Unknown status: '$status'");
    }

References ILIAS\Repository\lng(), ilPRGProgress\STATUS_ACCREDITED, ilPRGProgress\STATUS_COMPLETED, ilPRGProgress\STATUS_FAILED, ilPRGProgress\STATUS_IN_PROGRESS, and ilPRGProgress\STATUS_NOT_RELEVANT.

Here is the call graph for this function:

Field Documentation

◆ $lng

ilLanguage ilStudyProgrammeMailTemplateContext::$lng

protected

Definition at line 60 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ COMPLETED_BY

const ilStudyProgrammeMailTemplateContext::COMPLETED_BY = 'STUDY_PROGRAMME_COMPLETED_BY'

private

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

◆ COMPLETION_DATE

const ilStudyProgrammeMailTemplateContext::COMPLETION_DATE = 'STUDY_PROGRAMME_COMPLETION_DATE'

private

Definition at line 34 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ DATE_FORMAT

const ilStudyProgrammeMailTemplateContext::DATE_FORMAT = 'd.m.Y'

private

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

◆ DEADLINE

const ilStudyProgrammeMailTemplateContext::DEADLINE = 'STUDY_PROGRAMME_DEADLINE'

private

Definition at line 38 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ DESCRIPTION

const ilStudyProgrammeMailTemplateContext::DESCRIPTION = 'STUDY_PROGRAMME_DESCRIPTION'

private

Definition at line 29 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ EXPIRE_DATE

const ilStudyProgrammeMailTemplateContext::EXPIRE_DATE = 'STUDY_PROGRAMME_EXPIRE_DATE'

private

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

◆ ID

const ilStudyProgrammeMailTemplateContext::ID = 'prg_context_manual'

Definition at line 25 of file class.ilStudyProgrammeMailTemplateContext.php.

Referenced by ilStudyProgrammeMailMemberSearchGUI\generateContextArray(), and getId().

◆ LINK

const ilStudyProgrammeMailTemplateContext::LINK = 'STUDY_PROGRAMME_LINK'

private

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

◆ ORG_UNIT

const ilStudyProgrammeMailTemplateContext::ORG_UNIT = 'STUDY_PROGRAMME_ORG_UNITS'

private

Definition at line 32 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ PLACEHOLDER_TRANSLATIONS

const ilStudyProgrammeMailTemplateContext::PLACEHOLDER_TRANSLATIONS

private

Initial value:

= [
        self::TITLE => 'prg_title',
        self::DESCRIPTION => 'prg_description',
        self::TYPE => 'prg_type',
        self::LINK => 'prg_link',
        self::ORG_UNIT => 'prg_orgus',
        self::STATUS => 'prg_status',
        self::COMPLETION_DATE => 'prg_completion_date',
        self::COMPLETED_BY => 'prg_completion_by',
        self::POINTS_REQUIRED => 'prg_points_required',
        self::POINTS_CURRENT => 'prg_points_current',
        self::DEADLINE => 'prg_deadline',
        self::EXPIRE_DATE => 'prg_expiry_date',
        self::VALIDITY => 'prg_validity',
    ]

Definition at line 42 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ POINTS_CURRENT

const ilStudyProgrammeMailTemplateContext::POINTS_CURRENT = 'STUDY_PROGRAMME_POINTS_CURRENT'

private

Definition at line 37 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ POINTS_REQUIRED

const ilStudyProgrammeMailTemplateContext::POINTS_REQUIRED = 'STUDY_PROGRAMME_POINTS_REQUIRED'

private

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

◆ STATUS

const ilStudyProgrammeMailTemplateContext::STATUS = 'STUDY_PROGRAMME_STATUS'

private

Definition at line 33 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ TITLE

const ilStudyProgrammeMailTemplateContext::TITLE = 'STUDY_PROGRAMME_TITLE'

private

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

◆ TYPE

const ilStudyProgrammeMailTemplateContext::TYPE = 'STUDY_PROGRAMME_TYPE'

private

Definition at line 30 of file class.ilStudyProgrammeMailTemplateContext.php.

◆ VALIDITY

const ilStudyProgrammeMailTemplateContext::VALIDITY = 'STUDY_PROGRAMME_VALIDITY'

private

Definition at line 40 of file class.ilStudyProgrammeMailTemplateContext.php.

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

components/ILIAS/StudyProgramme/classes/class.ilStudyProgrammeMailTemplateContext.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ date2String()

◆ getDescription()

◆ getId()

◆ getLatestAssignment()

◆ getLatestSuccessfulAssignment()

◆ getSpecificPlaceholders()

◆ getTitle()

◆ statusToRepr()

Field Documentation

◆ $lng

◆ COMPLETED_BY

◆ COMPLETION_DATE

◆ DATE_FORMAT

◆ DEADLINE

◆ DESCRIPTION

◆ EXPIRE_DATE

◆ ID

◆ LINK

◆ ORG_UNIT

◆ PLACEHOLDER_TRANSLATIONS

◆ POINTS_CURRENT

◆ POINTS_REQUIRED

◆ STATUS

◆ TITLE

◆ TYPE

◆ VALIDITY