class.ilBlockGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Stream\Streams;
use ILIAS\HTTP\Response\Sender\ResponseSendingException;
use ILIAS\UI\Component\Modal\Modal;
use ILIAS\UI\Component\Dropdown\Dropdown;
use ILIAS\UI\Component\ViewControl;
use ILIAS\UI\Component\Component;
use ILIAS\UI\Component\Modal\RoundTrip;
use ILIAS\UI\Factory;
use ILIAS\UI\Component\Panel\Listing\Standard as StandardListingPanel;
use ILIAS\UI\Component\Panel\Standard as StandardPanel;
use ILIAS\UI\Component\Panel\Secondary\Listing as SecondaryListingPanel;
use ILIAS\UI\Component\Panel\Secondary\Legacy as SecondaryLegacyPanel;

abstract class ilBlockGUI
{
    public const PRES_MAIN_LEG = 0;             // main legacy panel
    public const PRES_SEC_LEG = 1;                      // secondary legacy panel
    public const PRES_SEC_LIST = 2;             // secondary list panel
    public const PRES_MAIN_LIST = 3;            // main standard list panel
    public const PRES_MAIN_TILE = 4;            // main standard list panel
    private int $offset = 0;
    private int $limit;
    private bool $enableedit;
    private string $subtitle;
    private int $refid;
    private string $rowtemplatename;
    private string $rowtemplatedir;
    private array $modals = [];
    private array $sort_options = [];
    private array $presentations = [];
    private string $activePresentation = '';
    private string $activeSortOption = '';
    private string $sort_target = '';
    protected \ILIAS\UI\Renderer $renderer;
    protected Factory $factory;
    protected object $gui_object;
    protected \ILIAS\Block\StandardGUIRequest $request;
    protected \ILIAS\Block\BlockManager $block_manager;
    private \ILIAS\HTTP\GlobalHttpState $http;

    protected bool $repositorymode = false;
    protected \ILIAS\DI\UIServices $ui;
    protected array $data = array();
    protected bool $enablenuminfo = true;
    protected array $footer_links = array();
    protected string $block_id = "0";
    protected bool $allow_moving = true;
    protected array $move = array("left" => false, "right" => false, "up" => false, "down" => false);
    protected array $block_commands = array();
    protected int $max_count = 0;
    protected bool $close_command = false;
    protected bool $image = false;
    protected array $property = [];
    protected string $nav_value = "";
    protected string $css_row = "";
    protected string $title = "";
    protected bool $admincommands = false;
    protected array $dropdown;
    protected ?ilTemplate $tpl;
    protected ?ilGlobalTemplateInterface $main_tpl;
    protected ilObjUser $user;
    protected ilCtrl $ctrl;
    protected ilAccessHandler $access;
    protected ilLanguage $lng;
    protected ilObjectDefinition $obj_def;
    protected int $presentation;
    protected ?int $requested_ref_id;

    public function __construct()
    {
        global $DIC;
        $this->factory = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();

        $this->http = $DIC->http();
        $block_service = new ILIAS\Block\Service($DIC);
        $this->block_manager = $block_service->internal()
            ->domain()
            ->block();
        $this->request = $block_service->internal()
            ->gui()
            ->standardRequest();


        // default presentation
        $this->presentation = self::PRES_SEC_LEG;

        $this->user = $DIC->user();
        $this->ctrl = $DIC->ctrl();
        $this->access = $DIC->access();
        $this->lng = $DIC->language();
        $this->main_tpl = $DIC["tpl"];
        $this->obj_def = $DIC["objDefinition"];
        $this->ui = $DIC->ui();

        $this->main_tpl->addJavaScript("./assets/js/ilblockcallback.js");

        $this->setLimit(25);

        $this->requested_ref_id = $this->request->getRefId();
    }

    abstract public function getBlockType(): string;

    abstract protected function isRepositoryObject(): bool;

    protected function specialCharsAsEntities(string $string): string
    {
        // Should be replaced by a proper refinery transformation once https://github.com/ILIAS-eLearning/ILIAS/pull/6314 is merged
        return  htmlspecialchars(
            $string,
            ENT_QUOTES | ENT_SUBSTITUTE,
            'utf-8'
        );
    }

    public function setData(array $a_data): void
    {
        $this->data = $a_data;
    }

    public function getData(): array
    {
        return $this->data;
    }

    public function setPresentation(int $type): void
    {
        $this->presentation = $type;
    }

    public function getPresentation(): int
    {
        return $this->presentation;
    }

    public function setBlockId(string $a_block_id = "0"): void
    {
        $this->block_id = $a_block_id;
    }

    public function getBlockId(): string
    {
        return $this->block_id;
    }

    public function setGuiObject(object $a_gui_object): void
    {
        $this->gui_object = $a_gui_object;
    }

    public function getGuiObject(): object
    {
        return $this->gui_object;
    }

    public function setTitle(string $a_title): void
    {
        $this->title = $a_title;
    }

    public function getTitle(): string
    {
        return $this->title;
    }

    public function setOffset(int $a_offset): void
    {
        // see https://github.com/ILIAS-eLearning/ILIAS/pull/6551/files
        $this->max_count = count($this->getData());
        if ($this->checkOffset($a_offset)) {
            $this->offset = $a_offset;
        } else {
            throw new ilException("ilBlockGUI::setOffset(): Offset out of range.");
        }
    }

    public function getOffset(): int
    {
        return $this->offset;
    }

    public function checkOffset(int $offset): bool
    {
        return $offset <= $this->max_count && $offset >= 0;
    }

    public function setLimit(int $a_limit): void
    {
        $this->limit = $a_limit;
    }

    public function getLimit(): int
    {
        return $this->limit;
    }

    public function setEnableEdit(bool $a_enableedit): void
    {
        $this->enableedit = $a_enableedit;
    }

    public function getEnableEdit(): bool
    {
        return $this->enableedit;
    }

    public function setRepositoryMode(bool $a_repositorymode): void
    {
        $this->repositorymode = $a_repositorymode;
    }

    public function getRepositoryMode(): bool
    {
        return $this->repositorymode;
    }

    public function setSubtitle(string $a_subtitle): void
    {
        $this->subtitle = $a_subtitle;
    }

    public function getSubtitle(): string
    {
        return $this->subtitle;
    }

    public function setRefId(int $a_refid): void
    {
        $this->refid = $a_refid;
    }

    public function getRefId(): int
    {
        return $this->refid;
    }

    public function setAdminCommands(bool $a_admincommands): void
    {
        $this->admincommands = $a_admincommands;
    }

    public function getAdminCommands(): bool
    {
        return $this->admincommands;
    }

    public function setEnableNumInfo(bool $a_enablenuminfo): void
    {
        $this->enablenuminfo = $a_enablenuminfo;
    }

    public function getEnableNumInfo(): bool
    {
        return $this->enablenuminfo;
    }

    public function setProperties(array $a_properties): void
    {
        $this->property = $a_properties;
    }

    public function getProperty(string $a_property): ?string
    {
        return $this->property[$a_property] ?? null;
    }

    public function setProperty(string $a_property, string $a_value): void
    {
        $this->property[$a_property] = $a_value;
    }

    public function setRowTemplate(
        string $a_rowtemplatename,
        string $a_rowtemplatedir = ""
    ): void {
        $this->rowtemplatename = $a_rowtemplatename;
        $this->rowtemplatedir = $a_rowtemplatedir;
    }

    final public function getNavParameter(): string
    {
        return $this->getBlockType() . "_" . $this->getBlockId() . "_blnav";
    }

    final public function getConfigParameter(): string
    {
        return $this->getBlockType() . "_" . $this->getBlockId() . "_blconf";
    }

    final public function getMoveParameter(): string
    {
        return $this->getBlockType() . "_" . $this->getBlockId() . "_blmove";
    }

    public function getRowTemplateName(): string
    {
        return $this->rowtemplatename;
    }

    public function getRowTemplateDir(): string
    {
        return $this->rowtemplatedir;
    }

    public function addBlockCommand(string $a_href, string $a_text, string $a_onclick = "", ?RoundTrip $modal = null): void
    {
        $this->block_commands[] = [
            "href" => $a_href,
            "text" => $a_text,
            "onclick" => $a_onclick,
            "modal" => $modal
        ];
    }

    public function getBlockCommands(): array
    {
        return $this->block_commands;
    }

    public static function getScreenMode(): string
    {
        return IL_SCREEN_SIDE;
    }

    protected function initCommands(): void
    {
    }

    public function getHTML(): string
    {
        $this->initCommands();

        $access = $this->access;
        $panel = null;

        $ctrl = $this->ctrl;

        if ($this->isRepositoryObject()) {
            if (!$access->checkAccess("read", "", $this->getRefId())) {
                return "";
            }
        }

        $this->addRepoCommands();

        switch ($this->getPresentation()) {
            case self::PRES_SEC_LEG:
                $panel = $this->factory->panel()->secondary()->legacy(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getLegacyContent())
                );
                break;

            case self::PRES_MAIN_LEG:
                $panel = $this->factory->panel()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getLegacyContent())
                );
                break;

            case self::PRES_SEC_LIST:
                $this->handleNavigation();
                $panel = $this->factory->panel()->secondary()->listing(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->getListItemGroups()
                );
                break;

            case self::PRES_MAIN_TILE:
            case self::PRES_MAIN_LIST:
                $this->handleNavigation();
                $panel = $this->factory->panel()->listing()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->getListItemGroups()
                );
                break;
        }

        // check for empty list panel
        if (in_array($this->getPresentation(), [self::PRES_SEC_LIST, self::PRES_MAIN_LIST], true) &&
            ($panel->getItemGroups() === [] || (count($panel->getItemGroups()) === 1 && $panel->getItemGroups()[0]->getItems() === []))) {
            if ($this->getPresentation() === self::PRES_SEC_LIST) {
                $panel = $this->factory->panel()->secondary()->legacy(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getNoItemFoundContent())
                );
            } else {
                $panel = $this->factory->panel()->standard(
                    $this->specialCharsAsEntities($this->getTitle()),
                    $this->factory->legacy()->content($this->getNoItemFoundContent())
                );
            }
        }

        $actions = $this->getActionsForPanel();
        if ($actions !== null) {
            $panel = $panel->withActions($actions);
        }
        $viewControls = $this->getViewControlsForPanel();
        if ($viewControls !== [] &&
            (
                $panel instanceof StandardPanel ||
                $panel instanceof SecondaryListingPanel ||
                $panel instanceof SecondaryLegacyPanel ||
                $panel instanceof StandardListingPanel
            )
        ) {
            $panel = $panel->withViewControls($viewControls);
        }

        if ($ctrl->isAsynch()) {
            $html = $this->renderer->renderAsync([$panel, ...$this->modals]);
        } else {
            $html = $this->renderer->render([$panel, ...$this->modals]);
        }


        if ($ctrl->isAsynch()) {
            $this->send($html);
        } else {
            // return incl. wrapping div with id
            $html = '<div id="' . 'block_' . $this->getBlockType() . '_' . $this->block_id . '">' .
                $html . '</div>';
        }

        return $html;
    }

    protected function preloadData(array $data): void
    {
    }

    public function getAsynch(): string
    {
        header("Content-type: text/html; charset=UTF-8");
        return $this->tpl->get();
    }


    protected function getLegacyContent(): string
    {
        return "";
    }

    protected function getListItemForData(array $data): ?\ILIAS\UI\Component\Item\Item
    {
        return null;
    }


    protected function handleNavigation(): void
    {
        $reg_page = $this->request->getNavPage($this->getNavParameter());
        if ($reg_page !== "") {
            $this->nav_value = "::" . ($reg_page * $this->getLimit());
        }

        if ($this->nav_value == "") {
            $this->nav_value = $this->block_manager->getNavPar($this->getNavParameter());
        }

        $this->block_manager->setNavPar(
            $this->getNavParameter(),
            $this->nav_value
        );

        $nav = explode(":", $this->nav_value);
        if (isset($nav[2])) {
            $this->setOffset((int) $nav[2]);
        } else {
            $this->setOffset(0);
        }
    }

    protected function loadData(): array
    {
        $data = $this->getData();
        $this->max_count = count($data);
        $data = array_slice($data, $this->getOffset(), $this->getLimit(), true);
        $this->preloadData($data);
        return $data;
    }


    protected function getListItemGroups(): array
    {
        global $DIC;
        $factory = $DIC->ui()->factory();

        $data = $this->loadData();

        $items = [];

        foreach ($data as $record) {
            $item = $this->getListItemForData($record);
            if ($item !== null) {
                $items[] = $item;
            }
        }

        $item_group = $factory->item()->group("", $items);

        return [$item_group];
    }

    public function getPaginationViewControl(): ?\ILIAS\UI\Component\ViewControl\Pagination
    {
        global $DIC;
        $factory = $DIC->ui()->factory();

        $ilCtrl = $this->ctrl;

        if ($this->max_count <= $this->getLimit()) {
            return null;
        }


        //              $ilCtrl->setParameterByClass("ilcolumngui",
        //                      $this->getNavParameter(), "::" . $prevoffset);

        // ajax link
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            "block_" . $this->getBlockType() . "_" . $this->block_id
        );
        $block_id = "block_" . $this->getBlockType() . "_" . $this->block_id;
        $onclick = $ilCtrl->getLinkTargetByClass(
            "ilcolumngui",
            "updateBlock",
            "",
            true
        );
        $ilCtrl->setParameterByClass(
            "ilcolumngui",
            "block_id",
            ""
        );

        // normal link
        $href = $ilCtrl->getLinkTargetByClass("ilcolumngui", "", "", false, false);

        //$ilCtrl->setParameterByClass("ilcolumngui",
        //      $this->getNavParameter(), "");

        return $factory->viewControl()->pagination()
            ->withTargetURL($href, $this->getNavParameter() . "page")
            ->withTotalEntries($this->max_count)
            ->withPageSize($this->getLimit())
            ->withMaxPaginationButtons(1)
            ->withCurrentPage($this->getOffset() / $this->getLimit());
    }

    protected function addRepoCommands(): void
    {
        $access = $this->access;
        $lng = $this->lng;
        $ctrl = $this->ctrl;
        $obj_def = $this->obj_def;

        if ($this->getRepositoryMode() && $this->isRepositoryObject()) {
            // #10993
            // @todo: fix this in new presentation somehow
            /*
            if ($this->getAdminCommands()) {
                $this->tpl->setCurrentBlock("block_check");
                $this->tpl->setVariable("BL_REF_ID", $this->getRefId());
                $this->tpl->parseCurrentBlock();
            }*/

            $parent_type = ilObject::_lookupType($this->requested_ref_id, true);
            $parent_gui = "ilObj" . $obj_def->getClassName($parent_type) . "GUI";

            if ($access->checkAccess("delete", "", $this->getRefId())) {
                $this->ctrl->setParameterByClass($parent_gui, 'ref_id', $this->requested_ref_id);
                $this->ctrl->setParameterByClass($parent_gui, 'item_ref_id', $this->getRefId());

                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass($parent_gui, 'delete'),
                    $lng->txt("delete")
                );

                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass($parent_gui, 'link'),
                    $lng->txt("link")
                );

                // see ilObjectListGUI::insertCutCommand();
                $this->addBlockCommand(
                    $this->ctrl->getLinkTargetByClass($parent_gui, 'cut'),
                    $lng->txt("move")
                );

                $this->ctrl->clearParameterByClass($parent_gui, 'ref_id');
                $this->ctrl->clearParameterByClass($parent_gui, 'item_ref_id');
            }

            // #14595 - see ilObjectListGUI::insertCopyCommand()
            if ($access->checkAccess("copy", "", $this->getRefId())) {
                $ctrl->setParameterByClass("ilobjectcopygui", "source_id", $this->getRefId());
                $copy_cmd = $ctrl->getLinkTargetByClass(
                    array("ilrepositorygui", $parent_gui, "ilobjectcopygui"),
                    "initTargetSelection"
                );

                // see ilObjectListGUI::insertCopyCommand();
                $this->addBlockCommand(
                    $copy_cmd,
                    $lng->txt("copy")
                );
            }
        }
    }

    protected function getActionsForPanel(): ?Dropdown
    {
        // actions
        $actions = [];
        $modals = [];

        foreach ($this->getBlockCommands() as $command) {
            $href = ($command['onclick'] !== '')
                ? ''
                : $command['href'];
            $button = $this->factory->button()->shy($command['text'], $href);
            if ($command['onclick']) {
                $button = $button->withOnLoadCode(function ($id) use ($command) {
                    return
                        "$(\"#$id\").click(function() { ilBlockJSHandler('" . "block_" . $this->getBlockType() . "_" . $this->block_id .
                        "','" . $command["onclick"] . "');});";
                });
            }

            if (isset($command['modal']) && $command['modal'] instanceof Modal) {
                $button = $button->withOnClick($command['modal']->getShowSignal());
                $this->modals[] = $command['modal'];
            }
            $actions[] = $button;
        }

        if (count($actions) > 0) {
            $actions = $this->factory->dropdown()->standard($actions)
                               ->withAriaLabel(sprintf(
                                   $this->lng->txt('actions_for'),
                                   $this->specialCharsAsEntities($this->getTitle())
                               ));
            return $actions;
        }
        return null;
    }

    public function getViewControlsForPanel(): array
    {
        $viewControls = [];
        if (count($this->presentations) > 1) {
            $presentation = $this->factory->viewControl()->mode(
                $this->presentations,
                'label'
            )->withActive($this->activePresentation);
            $viewControls[] = $presentation;
        }

        if ($this->sort_options !== []) {
            if (! array_key_exists($this->activeSortOption, $this->sort_options)) {
                $this->activeSortOption = current(array_keys($this->sort_options));
            }
            $sortation = $this->factory->viewControl()->sortation(
                $this->sort_options,
                $this->activeSortOption
            )->withTargetURL(
                $this->sort_target,
                'sorting'
            );
            $viewControls[] = $sortation;
        }

        if ($this->getPresentation() === self::PRES_SEC_LIST) {
            $pg_view_control = $this->getPaginationViewControl();
            if ($pg_view_control !== null) {
                $viewControls[] = $pg_view_control;
            }
        }
        return $viewControls;
    }

    public function sortObject(): string
    {
        return $this->getHTML();
    }

    public function addSortOption(string $option, string $label, bool $active): void
    {
        if ($active) {
            $this->activeSortOption = $option;
        }
        $this->sort_options[$option] = $label;
    }

    public function setSortTarget(string $target): void
    {
        $this->sort_target = $target;
    }

    public function addPresentation(string $label, string $target, bool $active): void
    {
        $this->presentations[$label] = $target;
        if ($active) {
            $this->activePresentation = $label;
        }
    }

    protected function send(string $output): void
    {
        $this->http->saveResponse($this->http->response()->withBody(
            Streams::ofString($output)
        ));
        $this->http->sendResponse();
        $this->http->close();
    }

    public function getNoItemFoundContent(): string
    {
        return $this->lng->txt("no_items");
    }
}