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 $orgUnitUserService=null, ?ilMailEnvironmentHelper $envHelper=null, ?ilMailUserHelper $usernameHelper=null, ?ilMailLanguageHelper $languageHelper=null)

	getLanguage ()

	getId ()

	getTitle ()

	getDescription ()

	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 $isoCode)

Protected Attributes
ilLanguage	$lng

Protected Attributes inherited from ilMailTemplateContext
ilLanguage	$language

ilMailEnvironmentHelper	$envHelper

ilMailLanguageHelper	$languageHelper

ilMailUserHelper	$userHelper

OrgUnitUserService	$orgUnitUserService

Private Attributes
const	TITLE = "prg_title"

const	DESCRIPTION = "prg_description"

const	TYPE = "prg_type"

const	LINK = "prg_link"

const	ORG_UNIT = "prg_orgus"

const	STATUS = "prg_status"

const	COMPLETION_DATE = "prg_completion_date"

const	COMPLETED_BY = "prg_completion_by"

const	POINTS_REQUIRED = "prg_points_required"

const	POINTS_CURRENT = "prg_points_current"

const	DEADLINE = "prg_deadline"

const	EXPIRE_DATE = "prg_expire_date"

const	VALIDITY = "prg_validity"

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`
	)

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

References $DIC, ilMailTemplateContext\$envHelper, ilMailTemplateContext\$languageHelper, ilMailTemplateContext\$orgUnitUserService, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\lng().

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

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 328 of file class.ilStudyProgrammeMailTemplateContext.php.

Referenced by getSpecificPlaceholders().

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

Here is the caller graph for this function:

◆ getDescription()

ilStudyProgrammeMailTemplateContext::getDescription ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getId()

ilStudyProgrammeMailTemplateContext::getId ( )

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

                            : string
     {
         return self::ID;
     }

◆ getLatestAssignment()

ilStudyProgrammeMailTemplateContext::getLatestAssignment ( array $assignments )

protected

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

References Vendor\Package\$a, Vendor\Package\$b, and ilPRGAssignment\getProgressTree().

Referenced by getSpecificPlaceholders().

                                                               : 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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLatestSuccessfulAssignment()

ilStudyProgrammeMailTemplateContext::getLatestSuccessfulAssignment ( array $assignments )

protected

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

References Vendor\Package\$a, Vendor\Package\$b, ilPRGAssignment\getProgressTree(), and null.

Referenced by getSpecificPlaceholders().

                                                                         : ?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);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificPlaceholders()

ilStudyProgrammeMailTemplateContext::getSpecificPlaceholders ( )

Return an array of placeholders.

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

References $id, $ref_id, ilObject\_exists(), ilObject\_lookupDeletedDate(), ilObjUser\_lookupLogin(), ilContainerReference\_lookupTargetRefId(), ilContainerReference\_lookupTitle(), date2String(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), getLatestAssignment(), getLatestSuccessfulAssignment(), ILIAS\Repository\lng(), ilObjUser\lookupOrgUnitsRepresentation(), null, ilMailTemplateContext\resolveSpecificPlaceholder(), and statusToRepr().

                                              : array
     {
         $placeholders = [];
 
         $placeholders[self::TITLE] = [
             'placeholder' => 'STUDY_PROGRAMME_TITLE',
             'label' => $this->lng->txt(self::TITLE)
         ];
 
         $placeholders[self::DESCRIPTION] = [
             'placeholder' => 'STUDY_PROGRAMME_DESCRIPTION',
             'label' => $this->lng->txt(self::DESCRIPTION)
         ];
 
         $placeholders[self::TYPE] = [
             'placeholder' => 'STUDY_PROGRAMME_TYPE',
             'label' => $this->lng->txt(self::TYPE)
         ];
 
         $placeholders[self::LINK] = [
             'placeholder' => 'STUDY_PROGRAMME_LINK',
             'label' => $this->lng->txt(self::LINK)
         ];
 
         $placeholders[self::ORG_UNIT] = [
             'placeholder' => 'STUDY_PROGRAMME_ORG_UNITS',
             'label' => $this->lng->txt(self::ORG_UNIT)
         ];
 
         $placeholders[self::STATUS] = [
             'placeholder' => 'STUDY_PROGRAMME_STATUS',
             'label' => $this->lng->txt(self::STATUS)
         ];
 
         $placeholders[self::COMPLETION_DATE] = [
             'placeholder' => 'STUDY_PROGRAMME_COMPLETION_DATE',
             'label' => $this->lng->txt(self::COMPLETION_DATE)
         ];
 
         $placeholders[self::COMPLETED_BY] = [
             'placeholder' => 'STUDY_PROGRAMME_COMPLETED_BY',
             'label' => $this->lng->txt(self::COMPLETED_BY)
         ];
 
         $placeholders[self::POINTS_REQUIRED] = [
             'placeholder' => 'STUDY_PROGRAMME_POINTS_REQUIRED',
             'label' => $this->lng->txt(self::POINTS_REQUIRED)
         ];
 
         $placeholders[self::POINTS_CURRENT] = [
             'placeholder' => 'STUDY_PROGRAMME_POINTS_CURRENT',
             'label' => $this->lng->txt(self::POINTS_CURRENT)
         ];
 
         $placeholders[self::DEADLINE] = [
             'placeholder' => 'STUDY_PROGRAMME_DEADLINE',
             'label' => $this->lng->txt(self::DEADLINE)
         ];
 
         $placeholders[self::EXPIRE_DATE] = [
             'placeholder' => 'STUDY_PROGRAMME_EXPIRE_DATE',
             'label' => $this->lng->txt(self::EXPIRE_DATE)
         ];
 
         $placeholders[self::VALIDITY] = [
             'placeholder' => 'STUDY_PROGRAMME_VALIDITY',
             'label' => $this->lng->txt(self::VALIDITY)
         ];
 
         return $placeholders;
     }

Here is the call graph for this function:

◆ getTitle()

ilStudyProgrammeMailTemplateContext::getTitle ( )

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ statusToRepr()

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

protected

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

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

Referenced by getSpecificPlaceholders().

                                                               : 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'");
     }