class.ilObjTestListGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

require_once './Modules/Test/classes/inc.AssessmentConstants.php';

class ilObjTestListGUI extends ilObjectListGUI
{
    protected $command_link_params = [];

    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();
    }

    public function initItem(
        int $ref_id,
        int $obj_id,
        string $type,
        string $title = '',
        string $description = ''
    ): void {
        try {
            if (ilTestDIC::dic()['main_settings_repository']->getForObjFi($obj_id)
                ->getAdditionalSettings()->getHideInfoTab()) {
                $this->enableInfoScreen(false);
            }
        } catch (Exception $e) {

        }
        parent::initItem($ref_id, $obj_id, $type, $title, $description);
    }

    public function getCommandFrame(string $cmd): string
    {
        $frame = '';
        switch ($cmd) {
            case "":
            case "infoScreen":
            case "eval_a":
            case "eval_stat":
                $frame = ilFrameTargetInfo::_getFrame("MainContent");
                break;

            default:
        }

        return $frame;
    }



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

        // we cannot use ilObjTestAccess::_isOffline() because of text messages
        $onlineaccess = ilObjTestAccess::_lookupOnlineTestAccess($this->obj_id, $this->user->getId());
        if ($onlineaccess !== true) {
            $props[] = ["alert" => true, "property" => $this->lng->txt("status"),
                "value" => $onlineaccess];
        }

        return $props;
    }

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

        if (count($cmd) == 2) {
            $cmd_link = $this->ctrl->getLinkTargetByClass(['ilRepositoryGUI', 'ilObjTestGUI', $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
    {
        $commands = parent::getCommands();
        if ($this->access->checkAccess('read', '', $this->ref_id)) {
            $this->insertCommand($this->getCommandLink('ilTestScreenGUI::testScreen'), $this->lng->txt('tst_start_test'));
        }
        return $this->handleUserResultsCommand($commands);
    }

    private function handleUserResultsCommand($commands)
    {
        if (!ilLOSettings::isObjectiveTest($this->ref_id)) {
            return $this->removeUserResultsCommand($commands);
        }

        if (!ilObjTestAccess::visibleUserResultExists($this->obj_id, $this->user->getId())) {
            return $this->removeUserResultsCommand($commands);
        }

        return $commands;
    }

    private function removeUserResultsCommand($commands)
    {
        foreach ($commands as $key => $command) {
            if ($command['cmd'] == 'userResultsGateway') {
                unset($commands[$key]);
                break;
            }
        }

        return $commands;
    }

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


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

    // begin-patch lok
    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("ilrepositorygui", 'ref_id', $parent_crs_ref_id);
        $this->ctrl->setParameterByClass("ilrepositorygui", 'tid', $this->ref_id);
        $cmd_link = $this->ctrl->getLinkTargetByClass("ilrepositorygui", 'redirectLocToTest');
        $this->ctrl->setParameterByClass("ilrepositorygui", "ref_id", $this->ref_id);
        $this->ctrl->clearParametersByClass('ilrepositorygui');

        return parent::modifyTitleLink($cmd_link);
    }

    // end-patch lok
} // END class.ilObjTestListGUI