ilObjectAddNewItemGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilObjectAddNewItemGUI:

Public Member Functions
	__construct (int $parent_ref_id)
	setMode (int $mode)
	setDisabledObjectTypes (array $types)
	Set object types which may not be created. More...
	setAfterCreationCallback (int $ref_id)
	Set after creation callback. More...
	setCreationUrl (string $url)
	Set (custom) url for object creation. More...
	render ()
	Add new item selection to current page incl. More...

Protected Member Functions
	parsePersonalWorkspace ()
	Parse creatable sub objects for personal workspace. More...
	parseRepository ()
	Parse creatable sub objects for repository incl. More...
	getHTML ()
	Get rendered html of sub object list. More...

Protected Attributes
ilLanguage	$lng
ilObjectDefinition	$obj_definition
ilSetting	$settings
ilAccessHandler	$access
ilCtrl	$ctrl
ilToolbarGUI	$toolbar
ilGlobalTemplateInterface	$tpl
int	$parent_ref_id
int	$mode
array	$disabled_object_types = []
array	$sub_objects = []
int	$url_creation_callback = 0
string	$url_creation
ilGroupedListGUI	$gl = null

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Render add new item selector

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 26 of file class.ilObjectAddNewItemGUI.php.

Constructor & Destructor Documentation

__construct()

ilObjectAddNewItemGUI::__construct

(

int

$parent_ref_id

)

Definition at line 44 of file class.ilObjectAddNewItemGUI.php.

References $DIC, $parent_ref_id, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilObjectDefinition\MODE_REPOSITORY, ILIAS\Repository\settings(), and ILIAS\Repository\toolbar().

    {
        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");
    }

Here is the call graph for this function:

Member Function Documentation

getHTML()

ilObjectAddNewItemGUI::getHTML ( )

protected

Get rendered html of sub object list.

Definition at line 259 of file class.ilObjectAddNewItemGUI.php.

References $gl, $path, $type, $url, $url_creation, $url_creation_callback, ilObject\_getIcon(), ilGroupedListGUI\addEntry(), ilGroupedListGUI\addGroupHeader(), ilGroupedListGUI\getHTML(), ilHelp\getObjCreationTooltipText(), ilUtil\img(), ilObjectDefinition\MODE_WORKSPACE, ilGroupedListGUI\nextColumn(), and ilGroupedListGUI\setAsDropDown().

Referenced by render().

                                : 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();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parsePersonalWorkspace()

ilObjectAddNewItemGUI::parsePersonalWorkspace ( )

protected

Parse creatable sub objects for personal workspace.

Grouping is not supported here, order is alphabetical (!)

Definition at line 97 of file class.ilObjectAddNewItemGUI.php.

References $ilSetting, $lng, $obj_definition, $settings, $sub_objects, $type, ilObjectDefinition\MODE_WORKSPACE, ilArrayUtil\sortArray(), and ilLanguage\txt().

Referenced by render().

                                               : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

parseRepository()

ilObjectAddNewItemGUI::parseRepository ( )

protected

Parse creatable sub objects for repository incl.

grouping

Definition at line 133 of file class.ilObjectAddNewItemGUI.php.

References $access, $lng, $obj_definition, $sub_objects, $type, ilObject\_lookupType(), ilObjRepositorySettings\getDefaultNewItemGrouping(), ilObjRepositorySettings\getNewItemGroups(), ilObjRepositorySettings\getNewItemGroupSubItems(), ILIAS\Repository\int(), ilObjectPlugin\lookupTxtById(), ilObjRepositorySettings\NEW_ITEM_GROUP_TYPE_GROUP, ilArrayUtil\sortArray(), and ilLanguage\txt().

Referenced by render().

                                        : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

render()

ilObjectAddNewItemGUI::render

(

)

Add new item selection to current page incl.

toolbar (trigger) and overlay

Definition at line 315 of file class.ilObjectAddNewItemGUI.php.

References getHTML(), ILIAS\Repository\lng(), ilObjectDefinition\MODE_WORKSPACE, parsePersonalWorkspace(), parseRepository(), ilAdvancedSelectionListGUI\STYLE_EMPH, and ILIAS\Repository\toolbar().

Referenced by ilContainerGUI\showPossibleSubObjects(), ilObjFolderGUI\showPossibleSubObjects(), ilObjLearningSequenceGUI\showPossibleSubObjects(), and ilObjCourseGUI\showPossibleSubObjects().

                            : 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);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAfterCreationCallback()

ilObjectAddNewItemGUI::setAfterCreationCallback

(

int

$ref_id

)

Set after creation callback.

Definition at line 79 of file class.ilObjectAddNewItemGUI.php.

References $ref_id.

                                                         : void
    {
        $this->url_creation_callback = $ref_id;
    }

setCreationUrl()

ilObjectAddNewItemGUI::setCreationUrl

(

string

$url

)

Set (custom) url for object creation.

Definition at line 87 of file class.ilObjectAddNewItemGUI.php.

References $url.

                                               : void
    {
        $this->url_creation = $url;
    }

setDisabledObjectTypes()

ilObjectAddNewItemGUI::setDisabledObjectTypes

(

array

$types

)

Set object types which may not be created.

Definition at line 71 of file class.ilObjectAddNewItemGUI.php.

                                                        : void
    {
        $this->disabled_object_types = $types;
    }

setMode()

ilObjectAddNewItemGUI::setMode

(

int

$mode

)

Definition at line 63 of file class.ilObjectAddNewItemGUI.php.

References $mode.

Referenced by ilObjTalkTemplateAdministrationGUI\showPossibleSubObjects(), and ilObjOrgUnitGUI\showPossibleSubObjects().

                                      : void
    {
        $this->mode = $mode;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilObjectAddNewItemGUI::$access

protected

Definition at line 31 of file class.ilObjectAddNewItemGUI.php.

Referenced by parseRepository().

$ctrl

ilCtrl ilObjectAddNewItemGUI::$ctrl

protected

Definition at line 32 of file class.ilObjectAddNewItemGUI.php.

$disabled_object_types

array ilObjectAddNewItemGUI::$disabled_object_types = []

protected

Definition at line 38 of file class.ilObjectAddNewItemGUI.php.

$gl

ilGroupedListGUI ilObjectAddNewItemGUI::$gl = null

protected

Definition at line 42 of file class.ilObjectAddNewItemGUI.php.

Referenced by getHTML().

$lng

ilLanguage ilObjectAddNewItemGUI::$lng

protected

Definition at line 28 of file class.ilObjectAddNewItemGUI.php.

Referenced by parsePersonalWorkspace(), and parseRepository().

$mode

int ilObjectAddNewItemGUI::$mode

protected

Definition at line 37 of file class.ilObjectAddNewItemGUI.php.

Referenced by setMode().

$obj_definition

ilObjectDefinition ilObjectAddNewItemGUI::$obj_definition

protected

Definition at line 29 of file class.ilObjectAddNewItemGUI.php.

Referenced by parsePersonalWorkspace(), and parseRepository().

$parent_ref_id

int ilObjectAddNewItemGUI::$parent_ref_id

protected

Definition at line 36 of file class.ilObjectAddNewItemGUI.php.

Referenced by __construct().

$settings

ilSetting ilObjectAddNewItemGUI::$settings

protected

Definition at line 30 of file class.ilObjectAddNewItemGUI.php.

Referenced by parsePersonalWorkspace().

$sub_objects

array ilObjectAddNewItemGUI::$sub_objects = []

protected

Definition at line 39 of file class.ilObjectAddNewItemGUI.php.

Referenced by parsePersonalWorkspace(), and parseRepository().

$toolbar

ilToolbarGUI ilObjectAddNewItemGUI::$toolbar

protected

Definition at line 33 of file class.ilObjectAddNewItemGUI.php.

$tpl

ilGlobalTemplateInterface ilObjectAddNewItemGUI::$tpl

protected

Definition at line 34 of file class.ilObjectAddNewItemGUI.php.

$url_creation

string ilObjectAddNewItemGUI::$url_creation

protected

Definition at line 41 of file class.ilObjectAddNewItemGUI.php.

Referenced by getHTML().

$url_creation_callback

int ilObjectAddNewItemGUI::$url_creation_callback = 0

protected

Definition at line 40 of file class.ilObjectAddNewItemGUI.php.

Referenced by getHTML().

---

The documentation for this class was generated from the following file:

• Services/Object/classes/class.ilObjectAddNewItemGUI.php