class.ilStudyProgrammeDashboardViewGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\UI\Component\Item\Item;
use ILIAS\UI\Component\Button\Shy;
use ILIAS\components\Dashboard\Block\BlockDTO;

class ilStudyProgrammeDashboardViewGUI extends ilDashboardBlockGUI
{
    protected ?string $visible_on_pd_mode = null;

    public function initViewSettings(): void
    {
        $this->viewSettings = new ilPDSelectedItemsBlockViewSettings(
            $this->user,
            ilPDSelectedItemsBlockConstants::VIEW_MY_STUDYPROGRAMME
        );

        $this->ctrl->setParameter($this, 'view', $this->viewSettings->getCurrentView());
    }

    public function emptyHandling(): string
    {
        return '';
    }

    public function initData(): void
    {
        $user_table = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserTable'];
        $user_table->disablePermissionCheck(true);
        $rows = $user_table->fetchSingleUserRootAssignments($this->user->getId());

        $items = [];
        foreach ($rows as $row) {
            $prg = ilObjStudyProgramme::getInstanceByObjId($row->getNodeId());
            if (!$this->isReadable($prg) || !$prg->isActive()) {
                continue;
            }

            $properties = [
                $this->lng->txt('prg_dash_label_minimum') => $row->getPointsRequired(),
                $this->lng->txt('prg_dash_label_gain') => $row->getPointsCurrent(),
                $this->lng->txt('prg_dash_label_status') => $row->getStatus(),
            ];

            if ($row->getStatusRaw() === ilPRGProgress::STATUS_ACCREDITED ||
                $row->getStatusRaw() === ilPRGProgress::STATUS_COMPLETED
            ) {
                $properties[$this->lng->txt('prg_dash_label_valid')] = $row->getExpiryDate() ?: $row->getValidity();

                if ($cert_link = $this->maybeGetCertificateLink($this->user->getId(), $prg->getId(), $prg->getRefId())) {
                    $properties[$this->lng->txt('certificate')] = $cert_link;
                }
            } else {
                $properties[$this->lng->txt('prg_dash_label_finish_until')] = $row->getDeadline();
            }

            $items[] = new BlockDTO(
                $prg->getType(),
                $prg->getRefId(),
                $prg->getId(),
                $prg->getTitle(),
                $prg->getDescription(),
                null,
                null,
                $properties
            );
        }

        $this->setData(['' => $items]);
    }

    protected function isReadable(ilObjStudyProgramme $prg): bool
    {
        if ($this->getVisibleOnPDMode() === ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS) {
            return true;
        }
        return $this->access->checkAccess('read', "", $prg->getRefId(), "prg", $prg->getId());
    }

    protected function getVisibleOnPDMode(): string
    {
        if (is_null($this->visible_on_pd_mode)) {
            $this->visible_on_pd_mode =
                $this->settings->get(
                    ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD,
                    ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_READ
                );
        }
        return $this->visible_on_pd_mode;
    }

    public function getBlockType(): string
    {
        return 'pdprg';
    }

    public function removeMultipleEnabled(): bool
    {
        return false;
    }

    public function getRemoveMultipleActionText(): string
    {
        return '';
    }

    protected function maybeGetCertificateLink(int $usr_id, int $prg_obj_id, int $prg_ref_id): ?string
    {
        $cert_validator = new ilCertificateDownloadValidator();
        if ($cert_validator->isCertificateDownloadable($usr_id, $prg_obj_id)) {
            $this->ctrl->setParameterByClass('ilObjStudyProgrammeGUI', 'ref_id', $prg_ref_id);
            $target = $this->ctrl->getLinkTargetByClass("ilObjStudyProgrammeGUI", "deliverCertificate");
            $this->ctrl->setParameterByClass('ilObjStudyProgrammeGUI', 'ref_id', null);
            $this->lng->loadLanguageModule('certificate');
            return $this->renderer->render($this->factory->link()->standard($this->lng->txt('download_certificate'), $target));
        }
        return null;
    }
}