CertificateCourseLearningProgressEvaluation.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Course\Certificate;

use ilSetting;
use ilLPStatus;
use ilCertificateTemplate;
use ilCertificateObjectHelper;
use ilCertificateLPStatusHelper;
use ilCertificateTemplateRepository;
use ilCertificateObjUserTrackingHelper;

class CertificateCourseLearningProgressEvaluation
{
    private readonly ilSetting $setting;
    private readonly ilCertificateObjectHelper $objectHelper;
    private readonly ilCertificateLPStatusHelper $statusHelper;
    private readonly ilCertificateObjUserTrackingHelper $trackingHelper;

    public function __construct(
        private readonly ilCertificateTemplateRepository $templateRepository,
        ?ilSetting $setting = null,
        ?ilCertificateObjectHelper $objectHelper = null,
        ?ilCertificateLPStatusHelper $statusHelper = null,
        ?ilCertificateObjUserTrackingHelper $trackingHelper = null
    ) {
        if (null === $setting) {
            $setting = new ilSetting('crs');
        }
        $this->setting = $setting;

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

        if (null === $statusHelper) {
            $statusHelper = new ilCertificateLPStatusHelper();
        }
        $this->statusHelper = $statusHelper;
        if (null === $trackingHelper) {
            $trackingHelper = new ilCertificateObjUserTrackingHelper();
        }
        $this->trackingHelper = $trackingHelper;
    }

    public function evaluate(int $refId, int $userId): array
    {
        $courseTemplates = $this->templateRepository
            ->fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress(
                $this->trackingHelper->enabledLearningProgress(),
                $refId
            );

        $templatesOfCompletedCourses = [];
        foreach ($courseTemplates as $courseTemplate) {
            $courseObjectId = $courseTemplate->getObjId();

            $subItems = $this->setting->get('cert_subitems_' . $courseObjectId);
            if ($subItems === null) {
                continue;
            }
            $subItems = json_decode($subItems, true, 512, JSON_THROW_ON_ERROR);
            if (!is_array($subItems)) {
                continue;
            }

            $subitem_obj_ids = [];
            foreach ($subItems as $subItemRefId) {
                $subitem_obj_ids[$subItemRefId] = $this->objectHelper->lookupObjId((int) $subItemRefId);
            }

            if (in_array($refId, $subItems)) {
                $completed = true;

                // check if all subitems are completed now
                foreach ($subitem_obj_ids as $subitem_id) {
                    $status = $this->statusHelper->lookUpStatus($subitem_id, $userId);

                    if ($status !== ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                        $completed = false;

                        break;
                    }
                }

                if ($completed) {
                    $templatesOfCompletedCourses[] = $courseTemplate;
                }
            }
        }

        return $templatesOfCompletedCourses;
    }
}