class.ilObjTestListGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Test\Access\ParticipantAccess;
use ILIAS\Test\TestDIC;
use ILIAS\UI\Component\Card\RepositoryObject as RepositoryObjectCard;

class ilObjTestListGUI extends ilObjectListGUI
{
    protected $command_link_params = [];
    private ilTestAccess $test_access;
    private ilObjTestAccess $obj_test_access;

    public function init(): void
    {
        $this->static_link_enabled = true;
        $this->delete_enabled = true;
        $this->cut_enabled = true;
        $this->copy_enabled = true;
        $this->subscribe_enabled = true;
        $this->link_enabled = true;
        $this->info_screen_enabled = true;
        $this->type = "tst";
        $this->gui_class_name = "ilobjtestgui";

        // general commands array
        $this->commands = ilObjTestAccess::_getCommands();
        $this->obj_test_access = new ilObjTestAccess();
    }

    public function initItem(
        int $ref_id,
        int $obj_id,
        string $type,
        string $title = '',
        string $description = ''
    ): void {
        try {
            if (TestDIC::dic()['settings.main.repository']->getForObjFi($obj_id)
                ->getAdditionalSettings()->getHideInfoTab()) {
                $this->enableInfoScreen(false);
            }
        } catch (Exception $e) {
            $this->disableTitleLink(true);
            $this->enableInfoScreen(false);
            $this->enableLearningProgress(false);
            $this->enableLPSettingsCommand(false);
            $this->enableTimings(false);
            $this->enableLink(false);
            $this->enableCut(false);
            $this->enableCopy(false);
            $this->enableComments(false);
            $this->enableNotes(false);
            $this->enableTags(false);
            $this->enableSubscribe(false);
            $this->enableMultiDownload(false);
        }
        $this->test_access = new ilTestAccess($ref_id);
        parent::initItem($ref_id, $obj_id, $type, $title, $description);
    }

    public function getProperties(): array
    {
        $props = parent::getProperties();

        $participant_access = $this->test_access->isParticipantAllowed(
            $this->obj_id,
            $this->user->getId()
        );

        if ($participant_access !== ParticipantAccess::ALLOWED) {
            $props[] = ['alert' => true, 'property' => $this->lng->txt('status'),
                'value' => $participant_access->getAccessForbiddenMessage($this->lng)];
            return $props;
        }

        if ($this->obj_test_access->showCertificateFor($this->user->getId(), $this->obj_id)) {
            $this->lng->loadLanguageModule('certificate');
            $this->ctrl->setParameterByClass(ilTestEvaluationGUI::class, 'ref_id', $this->ref_id);
            $props[] = [
                'alert' => false,
                'property' => $this->lng->txt('certificate'),
                'value' => $this->ui->renderer()->render(
                    $this->ui->factory()->link()->standard(
                        $this->lng->txt('download_certificate'),
                        $this->ctrl->getLinkTargetByClass(
                            [
                                ilObjTestGUI::class,
                                ilTestEvaluationGUI::class
                            ],
                            'outCertificate'
                        )
                    )
                )
            ];
            $this->ctrl->setParameterByClass(ilTestEvaluationGUI::class, 'ref_id', null);
        }

        return $props;
    }

    public function getCommandLink(string $cmd): string
    {
        $cmd = explode('::', $cmd);

        if (count($cmd) === 2) {
            $cmd_link = $this->ctrl->getLinkTargetByClass([ilRepositoryGUI::class, ilObjTestGUI::class, $cmd[0]], $cmd[1]);
        } else {
            $cmd_link = $this->ctrl->getLinkTargetByClass('ilObjTestGUI', $cmd[0]);
        }

        $params = array_merge(['ref_id' => $this->ref_id], $this->command_link_params);

        foreach ($params as $param => $value) {
            $cmd_link = ilUtil::appendUrlParameterString($cmd_link, "$param=$value", true);
        }

        return $cmd_link;
    }

    public function getCommands(): array
    {
        if ($this->test_access->isParticipantAllowed($this->obj_id, $this->user->getId())
            === ParticipantAccess::BROKEN_TEST) {
            return [];
        }
        $commands = parent::getCommands();
        if ($this->access->checkAccess('read', '', $this->ref_id)) {
            $this->insertCommand($this->getCommandLink('ILIAS\Test\Presentation\TestScreenGUI::testScreen'), $this->lng->txt('tst_start_test'));
        }
        return $commands;
    }

    public function createDefaultCommand(array $command): array
    {
        return $command;
    }


    public function addCommandLinkParameter($a_param)
    {
        $this->command_link_params = $a_param;
    }

    public function getAsCard(
        int $ref_id,
        int $obj_id,
        string $type,
        string $title,
        string $description
    ): ?RepositoryObjectCard {
        $card = parent::getAsCard($ref_id, $obj_id, $type, $title, $description);
        if ($this->obj_test_access->showCertificateFor($this->user->getId(), $obj_id)) {
            $card = $card->withCertificateIcon(true);
        }

        return $card;
    }

    protected function modifyTitleLink(string $default_link): string
    {
        if (!ilLOSettings::isObjectiveTest($this->ref_id)) {
            return parent::modifyTitleLink($default_link);
        }

        $path = $this->tree->getPathFull($this->ref_id);

        while ($parent = array_pop($path)) {
            if ($parent['type'] === 'crs') {
                $parent_crs_ref_id = $parent['ref_id'];
                break;
            }
        }

        $this->ctrl->setParameterByClass(ilObjCourseGUI::class, 'ref_id', $parent_crs_ref_id);
        $this->ctrl->setParameterByClass(ilObjCourseGUI::class, 'tid', $this->ref_id);
        $cmd_link = $this->ctrl->getLinkTargetByClass([ilRepositoryGUI::class, ilObjCourseGUI::class], 'redirectLocToTest');
        $this->ctrl->clearParametersByClass('ilrepositorygui');

        return parent::modifyTitleLink($cmd_link);
    }
}