class.ilRemoteObjectBaseGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

abstract class ilRemoteObjectBaseGUI extends ilObject2GUI
{
    private ilLogger $logger;

    public const TAB_ID_PERMISSIONS = "id_permissions";

    public function __construct($a_id = 0, $a_id_type = self::REPOSITORY_NODE_ID, $a_parent_node_id = 0)
    {
        global $DIC;

        parent::__construct($a_id, $a_id_type, $a_parent_node_id);

        $this->logger = $DIC->logger()->wsrv();

        $this->lng->loadLanguageModule('ecs');
    }

    public function executeCommand(): void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        $this->prepareOutput();
        $this->logger->info("Can write:" . print_r($this->checkPermissionBool('write'), true));

        switch ($next_class) {
            case 'ilinfoscreengui':
                // forwards command
                $this->infoScreen();
                break;

            case 'ilpermissiongui':
                $this->tabs_gui->activateTab('id_permissions');
                $this->ctrl->forwardCommand(new ilPermissionGUI($this));
                break;

            case "ilcommonactiondispatchergui":
                $gui = ilCommonActionDispatcherGUI::getInstanceFromAjaxCall();
                $this->ctrl->forwardCommand($gui);
                break;

            case strtolower(ilECSUserConsentModalGUI::class):
                $consent_gui = new ilECSUserConsentModalGUI(
                    $this->user->getId(),
                    $this->ref_id,
                    $this
                );
                $this->ctrl->setReturn($this, 'call');
                $this->ctrl->forwardCommand($consent_gui);
                break;

            default:
                if (!$cmd || $cmd === 'view') {
                    $cmd = "infoScreen";
                }
                $cmd .= "Object";
                $this->logger->info("cmd before call:" . print_r($cmd, true));
                $this->$cmd();
                break;
        }
        $this->logger->info("cmd:" . print_r($cmd, true));
    }

    public function showObject(): void
    {
        if ($this->user->getId() === ANONYMOUS_USER_ID ||
            $this->object->isLocalObject()) {
            $this->ctrl->redirectToURL($this->object->getRemoteLink());
        } else {
            $link = $this->object->getFullRemoteLink();
            $this->ctrl->redirectToURL($link);
        }
    }

    protected function setTabs(): void
    {
        if ($this->checkPermissionBool('visible')) {
            $this->tabs_gui->addTab(
                "info",
                $this->lng->txt("info_short"),
                $this->ctrl->getLinkTarget($this, "infoScreen")
            );
        }

        if ($this->checkPermissionBool('write')) {
            $this->tabs_gui->addTab(
                "edit",
                $this->lng->txt("edit"),
                $this->ctrl->getLinkTarget($this, "edit")
            );
        }
        if ($this->checkPermissionBool("edit_permission")) {
            $this->tabs_gui->addTab(
                self::TAB_ID_PERMISSIONS,
                $this->lng->txt("perm_settings"),
                $this->ctrl->getLinkTargetByClass("ilpermissiongui", "perm")
            );
        }
    }

    public function callObject(): bool
    {
        ilChangeEvent::_recordReadEvent(
            $this->getType(),
            $this->object->getRefId(),
            $this->object->getId(),
            $this->user->getId()
        );


        // check if the assigned object is hosted on the same installation
        $link = $this->object->getFullRemoteLink();
        if ($link) {
            $this->ctrl->redirectToURL($link);
            return true;
        }

        $this->tpl->setOnScreenMessage('failure', 'Cannot call remote object.');
        $this->infoScreenObject();
        return false;
    }

    public function infoScreenObject(): void
    {
        // @todo: removed deprecated ilCtrl methods, this needs inspection by a maintainer.
        // $this->ctrl->setCmd("showSummary");
        // $this->ctrl->setCmdClass("ilinfoscreengui");
        $this->infoScreen();
    }

    public function infoScreen(): void
    {
        if (!$this->access->checkAccess("visible", "", $this->object->getRefId())) {
            $this->error->raiseError(
                $this->lng->txt('msg_no_perm_read'),
                $this->error->MESSAGE
            );
        }

        $this->ctrl->setReturn($this, 'call');
        $consent_gui = new ilECSUserConsentModalGUI(
            $this->user->getId(),
            $this->ref_id,
            $this
        );
        $consent_gui->addLinkToToolbar($this->toolbar);

        $this->tabs_gui->activateTab('info');

        $info = new ilInfoScreenGUI($this);

        $info->addSection($this->lng->txt('ecs_general_info'));
        $info->addProperty($this->lng->txt('title'), $this->object->getTitle());
        if ($this->object->getOrganization()) {
            $info->addProperty($this->lng->txt('organization'), $this->object->getOrganization());
        }
        if ($this->object->getDescription()) {
            $info->addProperty($this->lng->txt('description'), $this->object->getDescription());
        }
        if ($this->object->getLocalInformation()) {
            $info->addProperty($this->lng->txt('ecs_local_information'), $this->object->getLocalInformation());
        }

        $this->addCustomInfoFields($info);

        $record_gui = new ilAdvancedMDRecordGUI(
            ilAdvancedMDRecordGUI::MODE_INFO,
            $this->getType(),
            $this->object->getId()
        );
        $record_gui->setInfoObject($info);
        $record_gui->parse();

        $this->ctrl->forwardCommand($info);
    }

    protected function addCustomInfoFields(ilInfoScreenGUI $a_info): void
    {
        // can be overwritten by subclasses
    }

    public function editObject(?ilPropertyFormGUI $form = null): void
    {
        if (!$this->access->checkAccess("write", "", $this->object->getRefId())) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }
        $this->logger->info("Can write:" . print_r($this->checkPermissionBool('write'), true));
        $this->tabs_gui->activateTab('edit');

        if (!$form) {
            $form = $this->initEditForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

    protected function initEditForm(): ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->lng->txt('ecs_general_info'));
        $form->addCommandButton('update', $this->lng->txt('save'));
        $form->addCommandButton('edit', $this->lng->txt('cancel'));

        $text = new ilTextInputGUI($this->lng->txt('title'), 'title');
        $text->setValue($this->object->getTitle());
        $text->setSize(min(40, ilObject::TITLE_LENGTH));
        $text->setMaxLength(ilObject::TITLE_LENGTH);
        $text->setDisabled(true);
        $form->addItem($text);

        $area = new ilTextAreaInputGUI($this->lng->txt('description'), 'description');
        $area->setValue($this->object->getDescription());
        $area->setRows(3);
        $area->setCols(80);
        $area->setDisabled(true);
        $form->addItem($area);

        $area = new ilTextAreaInputGUI($this->lng->txt('ecs_local_information'), 'local_info');
        $area->setValue($this->object->getLocalInformation());
        $area->setRows(3);
        $area->setCols(80);
        $form->addItem($area);

        $this->addCustomEditForm($form);

        $record_gui = new ilAdvancedMDRecordGUI(
            ilAdvancedMDRecordGUI::MODE_EDITOR,
            $this->getType(),
            $this->object->getId()
        );
        $record_gui->setPropertyForm($form);
        $record_gui->parse();

        return $form;
    }

    protected function addCustomEditForm(ilPropertyFormGUI $a_form): void
    {
    }

    public function updateObject(): void
    {
        if (!$this->checkPermissionBool('write')) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->MESSAGE);
        }

        $form = $this->initEditForm();
        if ($form->checkInput()) {
            $this->object->setLocalInformation($form->getInput('local_info'));

            $this->updateCustomValues($form);

            $this->object->update();

            // Save advanced meta data
            $record_gui = new ilAdvancedMDRecordGUI(
                ilAdvancedMDRecordGUI::MODE_EDITOR,
                $this->getType(),
                $this->object->getId()
            );
            $record_gui->importEditFormPostValues();
            $record_gui->writeEditForm();

            $this->tpl->setOnScreenMessage('success', $this->lng->txt("settings_saved"));
            $this->editObject();
        }

        $form->setValuesByPost();
        $this->editObject($form);
    }

    protected function updateCustomValues(ilPropertyFormGUI $a_form): void
    {
    }

    public static function _goto(string $a_target): void
    {
        global $DIC;

        $ilAccess = $DIC->access();
        $ilErr = $DIC["ilErr"];
        $lng = $DIC->language();
        if ($ilAccess->checkAccess("read", "", (int) $a_target)) {
            ilObjectGUI::_gotoRepositoryNode((int) $a_target);
        }

        if ($ilAccess->checkAccess("visible", "", (int) $a_target)) {
            ilObjectGUI::_gotoRepositoryNode((int) $a_target, "infoScreen");
        }
        $ilErr->raiseError($lng->txt("msg_no_perm_read"), $ilErr->FATAL);
    }
}