class.ilLPListOfObjectsGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=0);

class ilLPListOfObjectsGUI extends ilLearningProgressBaseGUI
{
    protected int $details_id = 0;
    protected int $details_obj_id = 0;
    protected string $details_type = '';
    protected int $details_mode = 0;

    public function __construct(int $a_mode, int $a_ref_id)
    {
        parent::__construct($a_mode, $a_ref_id);
        $this->__initDetails(
            $this->initDetailsIdFromRequest($this->getRefId())
        );
    }

    protected function initUserDetailsIdFromQuery(): int
    {
        if ($this->http->wrapper()->query()->has('userdetails_id')) {
            return $this->http->wrapper()->query()->retrieve(
                'userdetails_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

    protected function initUserIdFromRequest(): int
    {
        if ($this->initUserIdFromQuery()) {
            return $this->initUserIdFromQuery();
        }
        if ($this->http->wrapper()->post()->has('user_id')) {
            return $this->http->wrapper()->post()->retrieve(
                'user_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return 0;
    }

    protected function initDetailsIdFromRequest(int $default_id): int
    {
        if ($this->http->wrapper()->query()->has('details_id')) {
            return $this->http->wrapper()->query()->retrieve(
                'details_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        if ($this->http->wrapper()->post()->has('details_id')) {
            return $this->http->wrapper()->post()->retrieve(
                'details_id',
                $this->refinery->kindlyTo()->int()
            );
        }
        return $default_id;
    }

    public function executeCommand(): void
    {
        $this->ctrl->setReturn($this, "");

        switch ($this->ctrl->getNextClass()) {
            case 'iltruserobjectspropstablegui':
                $user_id = $this->initUserIdFromQuery();
                $this->ctrl->setParameter($this, "user_id", $user_id);

                $this->ctrl->setParameter(
                    $this,
                    "details_id",
                    $this->details_id
                );

                $table_gui = new ilTrUserObjectsPropsTableGUI(
                    $this,
                    "userDetails",
                    $user_id,
                    $this->details_obj_id,
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;

            case 'iltrsummarytablegui':
                $cmd = "showObjectSummary";
                if (!$this->details_id) {
                    $this->details_id = ROOT_FOLDER_ID;
                    $cmd = "show";
                }
                $table_gui = new ilTrSummaryTableGUI(
                    $this,
                    $cmd,
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;

            case 'iltrmatrixtablegui':
                $table_gui = new ilTrMatrixTableGUI(
                    $this,
                    "showUserObjectMatrix",
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;

            case 'iltrobjectuserspropstablegui':
                $this->ctrl->setParameter(
                    $this,
                    "details_id",
                    $this->details_id
                );

                $table_gui = new ilTrObjectUsersPropsTableGUI(
                    $this,
                    "details",
                    $this->details_obj_id,
                    $this->details_id
                );
                $this->ctrl->forwardCommand($table_gui);
                break;

            default:
                $cmd = $this->__getDefaultCommand();
                $this->$cmd();
        }
    }

    public function updateUser()
    {
        $details_id = $this->initUserDetailsIdFromQuery();
        if ($details_id) {
            $parent = $this->details_id;
            $this->__initDetails($details_id);
        }

        if (!ilLearningProgressAccess::checkPermission(
            'edit_learning_progress',
            $this->details_id
        )) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt("permission_denied"),
                true
            );
            $this->ctrl->returnToParent($this);
        }

        $this->__updateUser(
            $this->initUserIdFromRequest(),
            $this->details_obj_id
        );
        $this->tpl->setOnScreenMessage(
            'success',
            $this->lng->txt('trac_update_edit_user'),
            true
        );

        $this->ctrl->setParameter(
            $this,
            "details_id",
            $this->details_id
        ); // #15043

        // #14993
        if (!$details_id) {
            $this->ctrl->redirect($this, "details");
        } else {
            $this->ctrl->setParameter($this, "userdetails_id", $details_id);
            $this->ctrl->redirect($this, "userdetails");
        }
    }

    public function editUser(): void
    {
        $cancel = '';
        $parent_id = $this->details_id;
        $details_id = $this->initUserDetailsIdFromQuery();
        if ($details_id) {
            $this->__initDetails($details_id);
            $sub_id = $this->details_id;
            $cancel = "userdetails";
        } else {
            $sub_id = null;
            $cancel = "details";
        }

        if (!ilLearningProgressAccess::checkPermission(
            'edit_learning_progress',
            $this->details_id
        )) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt("permission_denied"),
                true
            );
            $this->ctrl->returnToParent($this);
        }

        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        $this->__showObjectDetails($info, $this->details_obj_id);

        $user_id = $this->initUserIdFromQuery();
        $this->tpl->setVariable(
            "ADM_CONTENT",
            $this->__showEditUser(
                $user_id,
                $parent_id,
                strlen($cancel) > 0 ? $cancel : null,
                $sub_id ?? 0
            ) . "<br />" . $info->getHTML()
        );
    }

    public function details(): void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_loo.html',
            'Services/Tracking'
        );

        // Show back button
        if ($this->getMode() == self::LP_CONTEXT_PERSONAL_DESKTOP or
            $this->getMode() == self::LP_CONTEXT_ADMINISTRATION) {
            $this->toolbar->addButton(
                $this->lng->txt('trac_view_list'),
                $this->ctrl->getLinkTarget($this, 'show')
            );
        }

        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        if ($this->__showObjectDetails($info, $this->details_obj_id)) {
            $this->tpl->setCurrentBlock("info");
            $this->tpl->setVariable("INFO_TABLE", $info->getHTML());
            $this->tpl->parseCurrentBlock();
        }
        $this->__showUsersList();
    }

    public function __showUsersList($a_print_view = false): void
    {
        if ($this->isAnonymized()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            return;
        }
        $this->ctrl->setParameter($this, "details_id", $this->details_id);
        $gui = new ilTrObjectUsersPropsTableGUI(
            $this,
            "details",
            $this->details_obj_id,
            $this->details_id,
            $a_print_view
        );

        $this->tpl->setVariable("LP_OBJECTS", $gui->getHTML());
        $this->tpl->setVariable("LEGEND", $this->__getLegendHTML());
    }

    public function userDetails(): void
    {
        if ($this->isAnonymized()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            return;
        }

        $this->ctrl->setParameter($this, "details_id", $this->details_id);

        $print_view = false;
        if ($this->http->wrapper()->query()->has('prt')) {
            $print_view = $this->http->wrapper()->query()->retrieve(
                'prt',
                $this->refinery->kindlyTo()->bool()
            );
        }
        if (!$print_view) {
            // Show back button
            $this->toolbar->addButton(
                $this->lng->txt('trac_view_list'),
                $this->ctrl->getLinkTarget(
                    $this,
                    'details'
                )
            );
        }

        $user_id = $this->initUserIdFromQuery();
        $this->ctrl->setParameter($this, "user_id", $user_id);
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_loo.html',
            'Services/Tracking'
        );

        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        $this->__showObjectDetails($info, $this->details_obj_id);
        // $this->__appendLPDetails($info,$this->details_obj_id,$user_id);
        $this->tpl->setVariable("INFO_TABLE", $info->getHTML());

        $table = new ilTrUserObjectsPropsTableGUI(
            $this,
            "userDetails",
            $user_id,
            $this->details_obj_id,
            $this->details_id,
            $print_view
        );
        $this->tpl->setVariable('LP_OBJECTS', $table->getHTML());
        $this->tpl->setVariable('LEGEND', $this->__getLegendHTML());
    }

    public function show(): void
    {
        $this->ctrl->setParameter($this, 'offset', 0);

        // Show only detail of current repository item if called from repository
        switch ($this->getMode()) {
            case self::LP_CONTEXT_REPOSITORY:
                $this->__initDetails($this->getRefId());
                $this->details();
                return;
        }
        $this->__listObjects();
    }

    public function __listObjects(): void
    {
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_list_objects.html',
            'Services/Tracking'
        );

        $lp_table = new ilTrSummaryTableGUI($this, "", ROOT_FOLDER_ID);

        $this->tpl->setVariable("LP_OBJECTS", $lp_table->getHTML());
        if ($lp_table->isStatusShown()) {
            $this->tpl->setVariable('LEGEND', $this->__getLegendHTML(ilLPStatusIcons::ICON_VARIANT_SHORT));
        }
    }

    public function __initDetails(int $a_details_id): void
    {
        if (!$a_details_id) {
            $a_details_id = $this->getRefId();
        }
        if ($a_details_id) {
            $this->details_id = $a_details_id;
            $this->details_obj_id = $this->ilObjectDataCache->lookupObjId(
                $this->details_id
            );
            $this->details_type = $this->ilObjectDataCache->lookupType(
                $this->details_obj_id
            );

            $olp = ilObjectLP::getInstance($this->details_obj_id);
            $this->details_mode = $olp->getCurrentMode();
        }
    }

    public function showObjectSummary(): void
    {
        $table = new ilTrSummaryTableGUI(
            $this,
            "showObjectSummary",
            $this->getRefId(),
            false
        );
        $content = $table->getHTML();
        if ($table->isStatusShown()) {
            $content .= $this->__getLegendHTML(ilLPStatusIcons::ICON_VARIANT_SHORT);
        }
        $this->tpl->setContent($content);
    }

    public function showUserObjectMatrix(): void
    {
        if ($this->isAnonymized()) {
            $this->tpl->setOnScreenMessage(
                'failure',
                $this->lng->txt('permission_denied')
            );
            return;
        }
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.lp_loo.html',
            'Services/Tracking'
        );
        $info = new ilInfoScreenGUI($this);
        $info->setFormAction($this->ctrl->getFormAction($this));
        if ($this->__showObjectDetails($info, $this->details_obj_id)) {
            $this->tpl->setCurrentBlock("info");
            $this->tpl->setVariable("INFO_TABLE", $info->getHTML());
            $this->tpl->parseCurrentBlock();
        }

        $table = new ilTrMatrixTableGUI(
            $this,
            "showUserObjectMatrix",
            $this->getRefId()
        );
        $this->tpl->setVariable('LP_OBJECTS', $table->getHTML());
        $this->tpl->setVariable('LEGEND', $this->__getLegendHTML());
    }
}