class.ilObjectAddNewItemGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilObjectAddNewItemGUI
{
    protected ilLanguage $lng;
    protected ilObjectDefinition $obj_definition;
    protected ilSetting $settings;
    protected ilAccessHandler $access;
    protected ilCtrl $ctrl;
    protected ilToolbarGUI $toolbar;
    protected ilGlobalTemplateInterface $tpl;

    protected int $parent_ref_id;
    protected int $mode;
    protected array $disabled_object_types = [];
    protected array $sub_objects = [];
    protected int $url_creation_callback = 0;
    protected string $url_creation;
    protected ?ilGroupedListGUI $gl = null;

    public function __construct(int $parent_ref_id)
    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->obj_definition = $DIC["objDefinition"];
        $this->settings = $DIC->settings();
        $this->access = $DIC->access();
        $this->ctrl = $DIC->ctrl();
        $this->toolbar = $DIC->toolbar();
        $this->tpl = $DIC["tpl"];

        $this->parent_ref_id = $parent_ref_id;
        $this->mode = ilObjectDefinition::MODE_REPOSITORY;

        $this->lng->loadLanguageModule("rep");
        $this->lng->loadLanguageModule("cntr");
    }

    public function setMode(int $mode): void
    {
        $this->mode = $mode;
    }

    public function setDisabledObjectTypes(array $types): void
    {
        $this->disabled_object_types = $types;
    }

    public function setAfterCreationCallback(int $ref_id): void
    {
        $this->url_creation_callback = $ref_id;
    }

    public function setCreationUrl(string $url): void
    {
        $this->url_creation = $url;
    }

    protected function parsePersonalWorkspace(): bool
    {
        $objDefinition = $this->obj_definition;
        $lng = $this->lng;
        $ilSetting = $this->settings;

        $this->sub_objects = array();

        $settings_map = [
            'blog' => 'blogs',
            'file' => 'files',
            'webr' => 'links',
        ];

        $subtypes = $objDefinition->getCreatableSubObjects("wfld", ilObjectDefinition::MODE_WORKSPACE);
        if (count($subtypes) > 0) {
            foreach (array_keys($subtypes) as $type) {
                if (isset($settings_map[$type]) &&
                    $ilSetting->get("disable_wsp_" . $settings_map[$type])) {
                    continue;
                }

                $this->sub_objects[] = array("type" => "object",
                    "value" => $type,
                    "title" => $lng->txt("wsp_type_" . $type));
            }
        }

        $this->sub_objects = ilArrayUtil::sortArray($this->sub_objects, "title");

        return (bool) sizeof($this->sub_objects);
    }

    protected function parseRepository(): bool
    {
        $objDefinition = $this->obj_definition;
        $lng = $this->lng;
        $ilAccess = $this->access;

        $this->sub_objects = array();

        if (!is_array($this->disabled_object_types)) {
            $this->disabled_object_types = array();
        }
        $this->disabled_object_types[] = "rolf";

        $parent_type = ilObject::_lookupType($this->parent_ref_id, true);
        $subtypes = $objDefinition->getCreatableSubObjects($parent_type, $this->mode, $this->parent_ref_id);
        if (count($subtypes) > 0) {
            // grouping of object types

            $grp_map = $pos_group_map = array();

            $groups = ilObjRepositorySettings::getNewItemGroups();

            // no groups => use default
            if (!$groups) {
                $default = ilObjRepositorySettings::getDefaultNewItemGrouping();
                $groups = $default["groups"];
                $grp_map = $default["items"];

                // reset positions (9999 = "other"/unassigned)
                $pos = 0;
                foreach ($subtypes as $item_type => $item) {
                    // see ilObjectDefinition
                    if (substr($item_type, 0, 1) == "x") {
                        $subtypes[$item_type]["pos"] = "99992000";
                    } else {
                        $subtypes[$item_type]["pos"] = "9999" . str_pad((string) ++$pos, 4, "0", STR_PAD_LEFT);
                    }
                }

                // assign default positions
                foreach ($default["sort"] as $item_type => $pos) {
                    if (array_key_exists($item_type, $subtypes)) {
                        $subtypes[$item_type]["pos"] = $pos;
                    }
                }

                // sort by default positions
                $subtypes = ilArrayUtil::sortArray($subtypes, "pos", "asc", true, true);
            }
            // use group assignment
            else {
                foreach (ilObjRepositorySettings::getNewItemGroupSubItems() as $grp_id => $subitems) {
                    foreach ($subitems as $subitem) {
                        $grp_map[$subitem] = $grp_id;
                    }
                }
            }

            $group_separators = array();
            $pos_group_map[0] = $lng->txt("rep_new_item_group_other");
            $old_grp_ids = array();
            foreach ($groups as $item) {
                if ($item["type"] == ilObjRepositorySettings::NEW_ITEM_GROUP_TYPE_GROUP) {
                    $pos_group_map[$item["id"]] = $item["title"];
                } elseif (sizeof($old_grp_ids)) {
                    $group_separators[$item["id"]] = $old_grp_ids;
                }
                $old_grp_ids[] = $item["id"];
            }

            $current_grp = null;
            foreach ($subtypes as $type => $subitem) {
                if (!in_array($type, $this->disabled_object_types)) {
                    // #9950
                    if ($ilAccess->checkAccess("create_" . $type, "", $this->parent_ref_id, $parent_type)) {
                        // if only assigned - do not add groups
                        if (sizeof($pos_group_map) > 1) {
                            $obj_grp_id = 0;
                            if (array_key_exists($type, $grp_map)) {
                                $obj_grp_id = (int) $grp_map[$type];
                            }
                            if ($obj_grp_id !== $current_grp) {
                                // add seperator after last group?
                                $sdone = false;
                                foreach ($group_separators as $idx => $spath) {
                                    // #11986 - all separators up to next group
                                    if ($current_grp && !in_array($obj_grp_id, $spath)) {
                                        // 1 only separator between groups
                                        if (!$sdone) {
                                            $this->sub_objects[] = array("type" => "column_separator");
                                            $sdone = true;
                                        }
                                        unset($group_separators[$idx]);
                                    }
                                }

                                $title = $pos_group_map[$obj_grp_id];

                                $this->sub_objects[] = array("type" => "group",
                                    "title" => $title);

                                $current_grp = $obj_grp_id;
                            }
                        }

                        if (isset($subitem["plugin"]) && $subitem["plugin"]) {
                            $title = ilObjectPlugin::lookupTxtById($type, "obj_" . $type);
                        } else {
                            // #13088
                            $title = $lng->txt("obj_" . $type);
                        }

                        $this->sub_objects[] = array("type" => "object",
                            "value" => $type,
                            "title" => $title);
                    }
                }
            }
        }

        return (bool) sizeof($this->sub_objects);
    }

    protected function getHTML(): string
    {
        if ($this->mode != ilObjectDefinition::MODE_WORKSPACE && !isset($this->url_creation)) {
            $base_url = "ilias.php?baseClass=ilRepositoryGUI&ref_id=" . $this->parent_ref_id . "&cmd=create";
        } else {
            $base_url = $this->url_creation;
        }
        // I removed the token statement because you can now
        // generate links with ilCtrl::getLinkTargetByClass()
        // which automatically appends one.

        if ($this->url_creation_callback) {
            $base_url .= "&crtcb=" . $this->url_creation_callback;
        }

        $gl = new ilGroupedListGUI("il-add-new-item-gl");
        $gl->setAsDropDown(true);

        foreach ($this->sub_objects as $item) {
            switch ($item["type"]) {
                case "column_separator":
                    $gl->nextColumn();
                    break;
                case "group":
                    $gl->addGroupHeader($item["title"]);
                    break;
                case "object":
                    $type = $item["value"];
                    $path = ilObject::_getIcon(0, 'tiny', $type);
                    $icon = ($path != "") ? ilUtil::img($path, "") . " " : "";
                    $url = $base_url . "&new_type=" . $type;
                    $ttip = ilHelp::getObjCreationTooltipText($type);
                    $gl->addEntry(
                        $icon . $item["title"],
                        $url,
                        "_top",
                        "",
                        "",
                        $type,
                        $ttip,
                        "bottom center",
                        "top center",
                        false
                    );

                    break;
            }
        }
        $this->gl = $gl;

        return $gl->getHTML();
    }

    public function render(): void
    {
        if ($this->mode == ilObjectDefinition::MODE_WORKSPACE) {
            if (!$this->parsePersonalWorkspace()) {
                return;
            }
        } elseif (!$this->parseRepository()) {
            return;
        }

        $adv = new ilAdvancedSelectionListGUI();
        $adv->setPullRight(false);
        $adv->setListTitle($this->lng->txt("cntr_add_new_item"));
        $this->getHTML();
        $adv->setGroupedList($this->gl);
        $adv->setStyle(ilAdvancedSelectionListGUI::STYLE_EMPH);
        $this->toolbar->addStickyItem($adv);
    }
}