ilObjectAddNewItemGUI Class Reference

Render add new item selector. More...

Collaboration diagram for ilObjectAddNewItemGUI:

Public Member Functions
	__construct ($a_parent_ref_id)
	Constructor. More...
	setMode ($a_mode)
	setDisabledObjectTypes (array $a_types)
	Set object types which may not be created. More...
	setAfterCreationCallback ($a_ref_id)
	Set after creation callback. More...
	setCreationUrl ($a_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
	$lng
	$obj_definition
	$settings
	$access
	$ctrl
	$toolbar
	$tpl
	$mode
	$parent_ref_id
	$disabled_object_types
	$sub_objects
	$url_creation_callback
	$url_creation

Detailed Description

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

Version

Id

class.ilContainerGUI.php 43751 2013-07-30 10:07:45Z jluetzen

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

Constructor & Destructor Documentation

__construct()

ilObjectAddNewItemGUI::__construct

(

$a_parent_ref_id

)

Constructor.

Parameters

int

$a_parent_ref_id

Returns

ilObjectAddNewItemGUI

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

References $DIC, $lng, ilObjectDefinition\MODE_REPOSITORY, and settings().

    {
        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"];
        $lng = $DIC->language();
        
        $this->parent_ref_id = (int) $a_parent_ref_id;
        $this->mode = ilObjectDefinition::MODE_REPOSITORY;
                
        $lng->loadLanguageModule("rep");
        $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.

Returns

string

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

References $ctrl, $type, $url, $url_creation, $url_creation_callback, ilObject\_getIcon(), ilHelp\getObjCreationTooltipText(), ilUtil\img(), and ilObjectDefinition\MODE_WORKSPACE.

Referenced by render().

    {
        $ilCtrl = $this->ctrl;
                
        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;
        }
        $base_url = $ilCtrl->appendRequestTokenParameterString($base_url);
        
        if ($this->url_creation_callback) {
            $base_url .= "&crtcb=" . $this->url_creation_callback;
        }
        
        include_once("./Services/UIComponent/GroupedList/classes/class.ilGroupedListGUI.php");
        $gl = new ilGroupedListGUI("il-add-new-item-gl");
        $gl->setAsDropDown(true, false);

        foreach ($this->sub_objects as $item) {
            switch ($item["type"]) {
                case "column_separator":
                    $gl->nextColumn();
                    break;

                /*
                case "separator":
                    $gl->addSeparator();
                    break;
                */

                case "group":
                    $gl->addGroupHeader($item["title"]);
                    break;

                case "object":
                    $type = $item["value"];

                    $path = ilObject::_getIcon('', '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 (!)

Returns

bool

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

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

Referenced by render().

    {
        $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 = ilUtil::sortArray($this->sub_objects, "title", 1);
        
        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

Returns

bool

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

References $access, $lng, $obj_definition, $sub_objects, $type, ilObject\_lookupType(), ilObjRepositorySettings\getDefaultNewItemGrouping(), ilObjRepositorySettings\getNewItemGroups(), ilObjRepositorySettings\getNewItemGroupSubItems(), ilObjectPlugin\lookupTxtById(), ilObjRepositorySettings\NEW_ITEM_GROUP_TYPE_GROUP, and ilUtil\sortArray().

Referenced by render().

    {
        $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();
            
            include_once("Services/Repository/classes/class.ilObjRepositorySettings.php");
            $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(++$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 = ilUtil::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 = (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 ($subitem["plugin"]) {
                            include_once("./Services/Component/classes/class.ilPlugin.php");
                            $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 361 of file class.ilObjectAddNewItemGUI.php.

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

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

    {
        $ilToolbar = $this->toolbar;
        $tpl = $this->tpl;
        $lng = $this->lng;
                        
        if ($this->mode == ilObjectDefinition::MODE_WORKSPACE) {
            if (!$this->parsePersonalWorkspace()) {
                return;
            }
        } elseif (!$this->parseRepository()) {
            return;
        }
                
        $ov_id = "il_add_new_item_ov";
        $ov_trigger_id = $ov_id . "_tr";
        

        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
        $adv = new ilAdvancedSelectionListGUI();
        $adv->setPullRight(false);
        $adv->setListTitle($lng->txt("cntr_add_new_item"));
        $this->getHTML();
        $adv->setGroupedList($this->gl);
        $adv->setStyle(ilAdvancedSelectionListGUI::STYLE_EMPH);
        //$ilToolbar->addAdvancedSelectionList($adv);
        $ilToolbar->addStickyItem($adv);
        //$tpl->setVariable("SELECT_OBJTYPE_REPOS", $adv->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAfterCreationCallback()

ilObjectAddNewItemGUI::setAfterCreationCallback

(

$a_ref_id

)

Set after creation callback.

Parameters

int

$a_ref_id

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

    {
        $this->url_creation_callback = $a_ref_id;
    }

setCreationUrl()

ilObjectAddNewItemGUI::setCreationUrl

(

$a_url

)

Set (custom) url for object creation.

Parameters

string

$a_url

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

    {
        $this->url_creation = $a_url;
    }

setDisabledObjectTypes()

ilObjectAddNewItemGUI::setDisabledObjectTypes

(

array

$a_types

)

Set object types which may not be created.

Parameters

array

$a_types

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

    {
        $this->disabled_object_types = $a_types;
    }

setMode()

ilObjectAddNewItemGUI::setMode

(

$a_mode

)

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

Referenced by ilObjOrgUnitGUI\showPossibleSubObjects().

    {
        $this->mode = (int) $a_mode;
    }

Here is the caller graph for this function:

Field Documentation

$access

ilObjectAddNewItemGUI::$access

protected

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

Referenced by parseRepository().

$ctrl

ilObjectAddNewItemGUI::$ctrl

protected

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

Referenced by getHTML().

$disabled_object_types

ilObjectAddNewItemGUI::$disabled_object_types

protected

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

$lng

ilObjectAddNewItemGUI::$lng

protected

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

Referenced by __construct(), parsePersonalWorkspace(), parseRepository(), and render().

$mode

ilObjectAddNewItemGUI::$mode

protected

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

$obj_definition

ilObjectAddNewItemGUI::$obj_definition

protected

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

Referenced by parsePersonalWorkspace(), and parseRepository().

$parent_ref_id

ilObjectAddNewItemGUI::$parent_ref_id

protected

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

$settings

ilObjectAddNewItemGUI::$settings

protected

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

Referenced by parsePersonalWorkspace().

$sub_objects

ilObjectAddNewItemGUI::$sub_objects

protected

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

Referenced by parsePersonalWorkspace(), and parseRepository().

$toolbar

ilObjectAddNewItemGUI::$toolbar

protected

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

Referenced by render().

$tpl

ilObjectAddNewItemGUI::$tpl

protected

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

Referenced by render().

$url_creation

ilObjectAddNewItemGUI::$url_creation

protected

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

Referenced by getHTML().

$url_creation_callback

ilObjectAddNewItemGUI::$url_creation_callback

protected

Definition at line 54 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