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)
	ilMailTemplateContext constructor. More...

	getLanguage ()

	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 (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null, bool $html_markup=false)

	resolvePlaceholder (string $placeholder_id, array $context_parameters, ilObjUser $recipient=null, bool $html_markup=false)

Data Fields
const	ID = 'prg_context_manual'

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_expiry_date"

const	VALIDITY = "prg_validity"

const	DATE_FORMAT = 'd-m-Y H:i:s'

Protected Member Functions
	getNewestProgressForUser (ilObjStudyProgramme $obj, int $user_id)

	statusToRepr (int $status, string $lang)

	date2String (DateTimeImmutable $date_time=null)

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

	initLanguageByIso2Code (string $isoCode)

Protected Attributes
	$lng

Protected Attributes inherited from ilMailTemplateContext
	$language

	$envHelper

	$languageHelper

	$userHelper

	$orgUnitUserService

Detailed Description

Definition at line 7 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 32 of file class.ilStudyProgrammeMailTemplateContext.php.

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

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

protected

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

Referenced by getSpecificPlaceholders().

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

Here is the caller graph for this function:

◆ getDescription()

ilStudyProgrammeMailTemplateContext::getDescription ( )

Returns: string

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

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

◆ getId()

ilStudyProgrammeMailTemplateContext::getId ( )

Returns: string

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

                             : string
     {
         return self::ID;
     }

◆ getNewestProgressForUser()

ilStudyProgrammeMailTemplateContext::getNewestProgressForUser	(	ilObjStudyProgramme	$obj,
		int	$user_id
	)

protected

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

References Vendor\Package\$a, Vendor\Package\$b, ilStudyProgrammeProgress\getCompletionDate(), ilObjStudyProgramme\getProgressesOf(), ilStudyProgrammeProgress\isAccredited(), ilStudyProgrammeProgress\isSuccessful(), and ilStudyProgrammeProgress\isSuccessfulExpired().

Referenced by getSpecificPlaceholders().

                                                                                         : ilStudyProgrammeProgress
     {
         $progress = $obj->getProgressesOf($user_id);
 
         $successfully_progress = array_filter($progress, function (ilStudyProgrammeProgress $a) {
             return $a->isSuccessful() || $a->isSuccessfulExpired() || $a->isAccredited();
         });
 
         if (count($successfully_progress) == 0) {
             return $progress[0];
         }
 
         usort($successfully_progress, function (ilStudyProgrammeProgress $a, ilStudyProgrammeProgress $b) {
             if ($a->getCompletionDate() > $b->getCompletionDate()) {
                 return -1;
             } elseif ($a->getCompletionDate() < $b->getCompletionDate()) {
                 return 1;
             } else {
                 return 0;
             }
         });
 
         return array_shift($successfully_progress);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSpecificPlaceholders()

ilStudyProgrammeMailTemplateContext::getSpecificPlaceholders ( )

Return an array of placeholders.

Returns: array

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

References ilObject\_exists(), ilLink\_getLink(), ilObject\_lookupDeletedDate(), ilObject\_lookupDescription(), ilObjUser\_lookupLogin(), ilObject\_lookupObjectId(), ilContainerReference\_lookupTargetRefId(), ilContainerReference\_lookupTitle(), ilObject\_lookupTitle(), date2String(), ilObjectFactory\getInstanceByObjId(), ilObjectFactory\getInstanceByRefId(), getNewestProgressForUser(), ilObjUser\lookupOrgUnitsRepresentation(), ilMailTemplateContext\resolveSpecificPlaceholder(), and statusToRepr().

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

Here is the call graph for this function:

◆ getTitle()

ilStudyProgrammeMailTemplateContext::getTitle ( )

Returns: string

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

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

◆ statusToRepr()

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

protected

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

References ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_FAILED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by getSpecificPlaceholders().

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