class.ilPDStudyProgrammeSimpleListGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Wrapper\RequestWrapper;
use ILIAS\Refinery\Factory;

class ilPDStudyProgrammeSimpleListGUI extends ilBlockGUI
{
    public const BLOCK_TYPE = "prgsimplelist";

    protected ilSetting $setting;
    protected $logger;
    protected ilStudyProgrammeAssignmentDBRepository $sp_user_assignment_db;
    protected RequestWrapper $request_wrapper;
    protected Factory $refinery;

    protected array $users_assignments;
    protected ?string $visible_on_pd_mode;
    protected bool $show_info_message;

    public function __construct()
    {
        global $DIC;

        parent::__construct();

        $this->setting = $DIC['ilSetting'];
        $this->logger = ilLoggerFactory::getLogger('prg');
        $this->sp_user_assignment_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB'];
        $this->request_wrapper = $DIC->http()->wrapper()->query();
        $this->refinery = $DIC->refinery();

        // No need to load data, as we won't display this.
        if (!$this->shouldShowThisList()) {
            return;
        }

        $this->getUsersAssignments();
        //check which kind of option is selected in settings
        $this->getVisibleOnPDMode();
        //check to display info message if option "read" is selected
        $viewSettings = new ilPDSelectedItemsBlockViewSettings(
            $DIC->user(),
            $this->request_wrapper->retrieve("view", $this->refinery->kindlyTo()->int())
        );
        $this->show_info_message = $viewSettings->isStudyProgrammeViewActive();

        // As this won't be visible we don't have to initialize this.
        if (!$this->userHasReadableStudyProgrammes()) {
            return;
        }

        $this->setTitle($this->lng->txt("objs_prg"));
    }

    public function getHTML(): string
    {
        // TODO: This should be determined from somewhere up in the hierarchy, as
        // this will lead to problems, when e.g. a command changes. But i don't see
        // how atm...
        if (!$this->shouldShowThisList()) {
            return "";
        }

        if (!$this->userHasReadableStudyProgrammes()) {
            return "";
        }
        return parent::getHTML();
    }

    public function getDataSectionContent(): string
    {
        $content = "";
        foreach ($this->users_assignments as $assignment) {
            if (!$this->isReadable($assignment)) {
                continue;
            }

            try {
                $list_item = $this->new_ilStudyProgrammeAssignmentListGUI($assignment);
                $list_item->setShowInfoMessage($this->show_info_message);
                $list_item->setVisibleOnPDMode($this->visible_on_pd_mode);
                $content .= $list_item->getHTML();
            } catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                $this->logger->alert((string) $e);
            } catch (ilStudyProgrammeTreeException $e) {
                $this->logger->alert((string) $e);
            }
        }
        return $content;
    }

    public function getBlockType(): string
    {
        return self::BLOCK_TYPE;
    }

    protected function isRepositoryObject(): bool
    {
        return false;
    }

    public function fillDataSection(): void
    {
        assert($this->userHasReadableStudyProgrammes()); // We should not get here.
        $this->tpl->setVariable("BLOCK_ROW", $this->getDataSectionContent());
    }

    protected function userHasVisibleStudyProgrammes(): bool
    {
        if (count($this->users_assignments) === 0) {
            return false;
        }
        foreach ($this->users_assignments as $assignment) {
            if ($this->isVisible($assignment)) {
                return true;
            }
        }
        return false;
    }

    protected function userHasReadableStudyProgrammes(): bool
    {
        if (count($this->users_assignments) === 0) {
            return false;
        }
        foreach ($this->users_assignments as $assignment) {
            if ($this->isReadable($assignment)) {
                return true;
            }
        }
        return false;
    }

    protected function getVisibleOnPDMode(): void
    {
        $this->visible_on_pd_mode = $this->setting->get(ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD);
    }

    protected function hasPermission(ilStudyProgrammeAssignment $assignment, string $permission): bool
    {
        $prg = ilObjStudyProgramme::getInstanceByObjId($assignment->getRootId());
        return $this->access->checkAccess($permission, "", $prg->getRefId(), "prg", $prg->getId());
    }

    protected function isVisible(ilStudyProgrammeAssignment $assignment): bool
    {
        return $this->hasPermission($assignment, "visible");
    }

    protected function isReadable(ilStudyProgrammeAssignment $assignment): bool
    {
        if ($this->visible_on_pd_mode === ilObjStudyProgrammeAdmin::SETTING_VISIBLE_ON_PD_ALLWAYS) {
            return true;
        }

        return $this->hasPermission($assignment, "read");
    }

    protected function shouldShowThisList(): bool
    {
        $cmd = $this->request_wrapper->retrieve("cmd", $this->refinery->kindlyTo()->string());
        $expand = $this->request_wrapper->retrieve("expand", $this->refinery->kindlyTo()->bool());
        $jump_to_selected_list = $cmd === "jumpToSelectedItems";
        $is_ilDashboardGUI = $this->ctrl->getCmdClass() === "ildashboardgui";
        $is_cmd_show = $this->ctrl->getCmd() === "show";

        return ($jump_to_selected_list || ($is_ilDashboardGUI && $is_cmd_show)) && !$expand;
    }

    protected function getUsersAssignments(): void
    {
        $this->users_assignments = $this->sp_user_assignment_db->getInstancesOfUser($this->user->getId());
    }

    protected function new_ilStudyProgrammeAssignmentListGUI(
        ilStudyProgrammeAssignment $assignment
    ): ilStudyProgrammeProgressListGUI {
        $progress = $assignment->getProgressTree();
        $progress_gui = new ilStudyProgrammeProgressListGUI($progress);
        $progress_gui->setOnlyRelevant(true);
        return $progress_gui;
    }
}