class.ilPathGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilPathGUI
{
    private int $startnode;
    private int $endnode;

    private bool $textOnly = true;
    private bool $useImages = false;
    private bool $hide_leaf = true;
    private bool $display_cut = false;

    protected ilLanguage $lng;
    protected ilTree $tree;
    protected ilCtrlInterface $ctrl;
    protected ilObjectDefinition $objectDefinition;
    protected \ILIAS\Refinery\Factory $refinery;

    public function __construct()
    {
        global $DIC;

        $this->startnode = (int) ROOT_FOLDER_ID;
        $this->endnode = (int) ROOT_FOLDER_ID;
        $this->tree = $DIC->repositoryTree();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC['ilCtrl'];
        $this->objectDefinition = $DIC['objDefinition'];
        $this->refinery = $DIC->refinery();
    }

    public function getPath(int $a_startnode, int $a_endnode): string
    {
        $this->startnode = $a_startnode;
        $this->endnode = $a_endnode;

        return $this->getHTML();
    }

    public function enableTextOnly(bool $a_status): void
    {
        $this->textOnly = $a_status;
    }

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

    public function enableHideLeaf(bool $a_status): void
    {
        $this->hide_leaf = $a_status;
    }

    public function hideLeaf(): bool
    {
        return $this->hide_leaf;
    }

    public function setUseImages(bool $a_status): void
    {
        $this->useImages = $a_status;
    }

    public function getUseImages(): bool
    {
        return $this->useImages;
    }

    public function enableDisplayCut(bool $a_status): void
    {
        $this->display_cut = $a_status;
    }

    public function displayCut(): bool
    {
        return $this->display_cut;
    }

    protected function getHTML(): string
    {
        if ($this->textOnly()) {
            $tpl = new ilTemplate('tpl.locator_text_only.html', true, true, "components/ILIAS/Locator");

            $first = true;

            // Display cut
            if ($this->displayCut() && $this->startnode != ROOT_FOLDER_ID) {
                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('ITEM', "...");
                $tpl->parseCurrentBlock();

                $first = false;
            }

            foreach ($this->getPathIds() as $ref_id) {
                $obj_id = ilObject::_lookupObjId($ref_id);
                $title = $this->buildTitle($obj_id);

                if ($first) {
                    if ($ref_id == ROOT_FOLDER_ID) {
                        $title = $this->lng->txt('repository');
                    }
                } else {
                    $tpl->touchBlock('locator_separator_prefix');
                }

                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('ITEM', $title);
                $tpl->parseCurrentBlock();
                $first = false;
            }
            return $tpl->get();
        } else {
            // With images and links

            $tpl = new ilTemplate('tpl.locator.html', true, true, 'components/ILIAS/Locator');

            $first = true;

            // Display cut
            if ($this->displayCut() && $this->startnode != ROOT_FOLDER_ID) {
                $tpl->setCurrentBlock('locator_item');
                $tpl->setVariable('ITEM', "...");
                $tpl->parseCurrentBlock();

                $first = false;
            }

            foreach ($this->getPathIds() as $ref_id) {
                $obj_id = ilObject::_lookupObjId($ref_id);
                $title = $this->buildTitle($obj_id);
                $type = ilObject::_lookupType($obj_id);

                if ($first) {
                    if ($ref_id == ROOT_FOLDER_ID) {
                        $title = $this->lng->txt('repository');
                    }
                } else {
                    $tpl->touchBlock('locator_separator_prefix');
                }
                if ($this->getUseImages()) {
                    $tpl->setCurrentBlock('locator_img');
                    $tpl->setVariable('IMG_SRC', ilObject::_getIcon($obj_id, "small", $type));
                    $tpl->setVariable('IMG_ALT', $this->lng->txt('obj_' . $type));
                    $tpl->parseCurrentBlock();
                }

                if (!$this->tree->isDeleted($ref_id)) {
                    $tpl->setCurrentBlock('locator_item');
                    $tpl->setVariable('LINK_ITEM', $this->buildLink($ref_id, $type));
                    $tpl->setVariable('ITEM', $title);
                    $tpl->parseCurrentBlock();
                } else {
                    $tpl->setCurrentBlock('locator_item');
                    $tpl->setVariable('ITEM_READ_ONLY', $title);
                    $tpl->parseCurrentBlock();
                }

                $first = false;
            }
            $tpl->setVariable("TXT_BREADCRUMBS", $this->lng->txt("breadcrumb_navigation"));
            return $tpl->get();
        }
    }

    protected function buildTitle(int $a_obj_id): string
    {
        $type = ilObject::_lookupType($a_obj_id);
        if ($this->objectDefinition->isAdministrationObject($type)) {
            return $this->lng->txt('obj_' . $type);
        }
        return ilObject::_lookupTitle($a_obj_id);
    }

    protected function buildLink(int $ref_id, string $type): string
    {
        if ($this->objectDefinition->isAdministrationObject($type)) {
            $current_parameters = $this->ctrl->getParameterArrayByClass(ilAdministrationGUI::class);
            $this->ctrl->setParameterByClass(ilAdministrationGUI::class, 'ref_id', $ref_id);
            $link = $this->ctrl->getLinkTargetByClass(ilAdministrationGUI::class, 'jump');
            $this->ctrl->clearParameterByClass(ilAdministrationGUI::class, 'ref_id');
            if (isset($current_parameters['ref_id'])) {
                $this->ctrl->setParameterByClass(ilAdministrationGUI::class, 'ref_id', $current_parameters['ref_id']);
            }
            return $link;
        }
        return $this->refinery->encode()->htmlAttributeValue()->transform(
            ilLink::_getLink($ref_id, $type)
        );
    }

    protected function getPathIds(): array
    {
        $path = $this->tree->getPathId($this->endnode, $this->startnode);
        if ($this->hideLeaf() && count($path)) {
            unset($path[count($path) - 1]);
        }
        return $path;
    }
}