ExercisePlaceholderValues.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Exercise\Certificate;

use ilLanguage;
use ilException;
use ilDatabaseException;
use ilDateTimeException;
use ilCertificateDateHelper;
use ilCertificateUtilHelper;
use ilCertificateObjectHelper;
use ilObjectNotFoundException;
use ilCertificateLPMarksHelper;
use ilDefaultPlaceholderValues;
use ilCertificateLPStatusHelper;
use ilCertificatePlaceholderValues;
use ilObjUser;

class ExercisePlaceholderValues implements ilCertificatePlaceholderValues
{
    private readonly ilLanguage $language;
    private readonly ilDefaultPlaceholderValues $defaultPlaceholderValuesObject;
    private readonly ilCertificateLPMarksHelper $lpMarksHelper;
    private readonly ilCertificateObjectHelper $objectHelper;
    private readonly CertificateExerciseMembersHelper $exerciseMembersHelper;
    private readonly ilCertificateLPStatusHelper $lpStatusHelper;
    private readonly ilCertificateUtilHelper $utilHelper;
    private readonly ilCertificateDateHelper $dateHelper;

    public function __construct(
        ?ilDefaultPlaceholderValues $defaultPlaceholderValues = null,
        ?ilLanguage $language = null,
        ?ilCertificateObjectHelper $objectHelper = null,
        ?ilCertificateLPMarksHelper $lpMarksHelper = null,
        ?CertificateExerciseMembersHelper $exerciseMembersHelper = null,
        ?ilCertificateLPStatusHelper $lpStatusHelper = null,
        ?ilCertificateUtilHelper $utilHelper = null,
        ?ilCertificateDateHelper $dateHelper = null
    ) {
        if (null === $language) {
            global $DIC;
            $language = $DIC->language();
            $language->loadLanguageModule('certificate');
        }
        $language->loadLanguageModule('exercise');
        $language->loadLanguageModule('exc');

        $this->language = $language;

        if (null === $defaultPlaceholderValues) {
            $defaultPlaceholderValues = new ilDefaultPlaceholderValues();
        }
        $this->defaultPlaceholderValuesObject = $defaultPlaceholderValues;

        if (null === $objectHelper) {
            $objectHelper = new ilCertificateObjectHelper();
        }
        $this->objectHelper = $objectHelper;

        if (null === $lpMarksHelper) {
            $lpMarksHelper = new ilCertificateLPMarksHelper();
        }
        $this->lpMarksHelper = $lpMarksHelper;

        if (null === $exerciseMembersHelper) {
            $exerciseMembersHelper = new CertificateExerciseMembersHelper();
        }
        $this->exerciseMembersHelper = $exerciseMembersHelper;

        if (null === $lpStatusHelper) {
            $lpStatusHelper = new ilCertificateLPStatusHelper();
        }
        $this->lpStatusHelper = $lpStatusHelper;

        if (null === $utilHelper) {
            $utilHelper = new ilCertificateUtilHelper();
        }
        $this->utilHelper = $utilHelper;

        if (null === $dateHelper) {
            $dateHelper = new ilCertificateDateHelper();
        }
        $this->dateHelper = $dateHelper;
    }

    public function getPlaceholderValues(int $userId, int $objId): array
    {
        $exerciseObject = $this->objectHelper->getInstanceByObjId($objId);

        $mark = $this->lpMarksHelper->lookUpMark($userId, $objId);
        $status = $this->exerciseMembersHelper->lookUpStatus($objId, $userId);

        $completionDate = $this->lpStatusHelper->lookupStatusChanged($objId, $userId);

        $placeHolders = $this->defaultPlaceholderValuesObject->getPlaceholderValues($userId, $objId);

        if ($status !== null) {
            $placeHolders['RESULT_PASSED'] = $this->utilHelper->prepareFormOutput(
                $this->language->txt('exc_' . $status)
            );
        }

        $placeHolders['RESULT_MARK'] = $this->utilHelper->prepareFormOutput($mark);
        $placeHolders['EXERCISE_TITLE'] = $this->utilHelper->prepareFormOutput($exerciseObject->getTitle());
        $placeHolders['DATE_COMPLETED'] = '';
        $placeHolders['DATETIME_COMPLETED'] = '';

        if ($completionDate !== '') {
            $user = $this->objectHelper->getInstanceByObjId($userId);
            $placeHolders['DATE_COMPLETED'] = $this->dateHelper->formatDate($completionDate, $user);
            $placeHolders['DATETIME_COMPLETED'] = $this->dateHelper->formatDateTime($completionDate, $user);
        }

        return $placeHolders;
    }

    public function getPlaceholderValuesForPreview(int $userId, int $objId): array
    {
        $placeholders = $this->defaultPlaceholderValuesObject->getPlaceholderValuesForPreview($userId, $objId);

        $object = $this->objectHelper->getInstanceByObjId($objId);

        $placeholders['RESULT_PASSED'] = $this->utilHelper->prepareFormOutput(
            $this->language->txt('certificate_var_result_passed')
        );
        $placeholders['RESULT_MARK'] = $this->utilHelper->prepareFormOutput(
            $this->language->txt('certificate_var_result_mark_short')
        );
        $placeholders['EXERCISE_TITLE'] = $this->utilHelper->prepareFormOutput($object->getTitle());

        return $placeholders;
    }
}