class.ilStudyProgrammeMailTemplateContext.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use OrgUnit\PublicApi\OrgUnitUserService;

class ilStudyProgrammeMailTemplateContext extends ilMailTemplateContext
{
    public const ID = 'prg_context_manual';

    //placeholder(ids)
    private const TITLE = 'STUDY_PROGRAMME_TITLE';
    private const DESCRIPTION = 'STUDY_PROGRAMME_DESCRIPTION';
    private const TYPE = 'STUDY_PROGRAMME_TYPE';
    private const LINK = 'STUDY_PROGRAMME_LINK';
    private const ORG_UNIT = 'STUDY_PROGRAMME_ORG_UNITS';
    private const STATUS = 'STUDY_PROGRAMME_STATUS';
    private const COMPLETION_DATE = 'STUDY_PROGRAMME_COMPLETION_DATE';
    private const COMPLETED_BY = 'STUDY_PROGRAMME_COMPLETED_BY';
    private const POINTS_REQUIRED = 'STUDY_PROGRAMME_POINTS_REQUIRED';
    private const POINTS_CURRENT = 'STUDY_PROGRAMME_POINTS_CURRENT';
    private const DEADLINE = 'STUDY_PROGRAMME_DEADLINE';
    private const EXPIRE_DATE = 'STUDY_PROGRAMME_EXPIRE_DATE';
    private const VALIDITY = 'STUDY_PROGRAMME_VALIDITY';

    private const PLACEHOLDER_TRANSLATIONS = [
        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',
    ];

    private const DATE_FORMAT = 'd.m.Y';

    protected ilLanguage $lng;

    public function __construct(
        OrgUnitUserService $orgUnitUserService = null,
        ilMailEnvironmentHelper $envHelper = null,
        ilMailUserHelper $usernameHelper = null,
        ilMailLanguageHelper $languageHelper = null
    ) {
        parent::__construct(
            $orgUnitUserService,
            $envHelper,
            $usernameHelper,
            $languageHelper
        );

        global $DIC;

        $this->lng = $DIC['lng'];
        $this->lng->loadLanguageModule('prg');
    }

    public function getId(): string
    {
        return self::ID;
    }

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

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

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

    public function resolveSpecificPlaceholder(
        string $placeholder_id,
        array $context_parameters,
        ilObjUser $recipient = null
    ): string {

        if (is_null($recipient)) {
            return '';
        }

        $placeholder_id = strtoupper($placeholder_id);
        if (! array_key_exists($placeholder_id, self::PLACEHOLDER_TRANSLATIONS)) {
            return '';
        }

        $prg = ilObjectFactory::getInstanceByRefId((int) $context_parameters['ref_id']);
        $assignments = $prg->getAssignmentsOfSingleProgramForUser($recipient->getId());
        $latest = $this->getLatestAssignment($assignments);
        $latest_successful = $this->getLatestSuccessfulAssignment($assignments);

        switch ($placeholder_id) {
            case self::TITLE:
                $string = $prg->getTitle();
                break;
            case self::DESCRIPTION:
                $string = $prg->getDescription();
                break;
            case self::TYPE:
                $string = '';
                if (!is_null($prg->getSubType())) {
                    $string = $prg->getSubType()->getTitle();
                }
                break;
            case self::LINK:
                $string = ilLink::_getLink((int) $context_parameters['ref_id'], 'prg') . ' ';
                break;
            case self::ORG_UNIT:
                $string = ilObjUser::lookupOrgUnitsRepresentation($recipient->getId());
                break;
            case self::STATUS:
                $string = $this->statusToRepr($latest->getProgressTree()->getStatus(), $recipient->getLanguage());
                break;
            case self::COMPLETION_DATE:
                $string = $this->date2String($latest->getProgressTree()->getCompletionDate(), $recipient);
                break;
            case self::COMPLETED_BY:
                $string = '';
                $id = $latest->getProgressTree()->getCompletionBy();
                if (!is_null($id) && ilObject::_exists($id)) {
                    $obj = ilObjectFactory::getInstanceByObjId($id);
                    if ($obj->getType() === 'usr') {
                        $string = ilObjUser::_lookupLogin($id);
                    } elseif ($ref_id = ilContainerReference::_lookupTargetRefId($id)) {
                        if (
                            ilObject::_exists($ref_id, true) &&
                            is_null(ilObject::_lookupDeletedDate($ref_id))
                        ) {
                            $string = ilContainerReference::_lookupTitle($id);
                        }
                    }
                }
                break;
            case self::POINTS_REQUIRED:
                $string = (string) $latest->getProgressTree()->getAmountOfPoints();
                break;
            case self::POINTS_CURRENT:
                $string = (string) $latest->getProgressTree()->getCurrentAmountOfPoints();
                break;
            case self::DEADLINE:
                $string = $latest->getProgressTree()->isInProgress() ?
                    $this->date2String($latest->getProgressTree()->getDeadline(), $recipient) : '';

                break;
            case self::VALIDITY:
                $string = '-';
                if ($latest_successful) {
                    $langvar = $latest_successful->getProgressTree()->isInvalidated() ? 'prg_not_valid' : 'prg_still_valid';
                    $string = $this->lng->txtlng('prg', $langvar, $recipient->getLanguage());
                }
                break;

            case self::EXPIRE_DATE:
                $string = '-';
                if ($latest_successful) {
                    $string = $this->date2String($latest_successful->getProgressTree()->getValidityOfQualification(), $recipient);
                }
                break;
            default:
                throw new \Exception("cannot resolve placeholder: " . $placeholder_id);
                $string = '';
        }

        return $string;
    }

    protected function getLatestAssignment(array $assignments): 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);
    }

    protected function getLatestSuccessfulAssignment(array $assignments): ?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);
    }



    protected function statusToRepr(int $status, string $lang): 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'");
    }

    protected function date2String(
        DateTimeImmutable $date_time = null,
        ilObjUser $user = null
    ): string {
        if (is_null($date_time)) {
            return '';
        }
        if (is_null($user)) {
            return $date_time->format(self::DATE_FORMAT);
        }
        return $user->getDateFormat()->applyTo($date_time);
    }
}