Inheritance diagram for ilRepositoryExplorer:

Collaboration diagram for ilRepositoryExplorer:

Public Member Functions
	setForceOpenPath (array $a_path)
	set force open path More...

	buildLinkTarget ($a_node_id, string $a_type)
	note: most of this stuff is used by ilCourseContentInterface too More...

	getImage (string $a_name, string $a_type="", $a_obj_id="")

	isClickable (string $type, int $ref_id=0)

	showChilds ($a_parent_id, int $a_obj_id=0)

	isVisible ($a_ref_id, string $a_type)

	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)

	sortNodes (array $a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array More...

	forceExpanded ($a_obj_id)
	force expansion of node More...

Public Member Functions inherited from ilExplorer
	setId (string $a_val)

	getId ()

	setAsynchExpanding (bool $a_val)

	getAsynchExpanding ()

	initItemCounter (int $a_number)

	setTitle (string $a_val)

	setTitleLength (int $a_length)

	getTitleLength ()

	getTitle ()

	setRoot ($a_root_id)

	getRoot ()

	setOrderColumn (string $a_column)

	setOrderDirection (string $a_direction)

	setTargetGet (string $a_target_get)

	setParamsGet (array $a_params_get)

	setExpandTarget (string $a_exp_target)
	target script for expand icons More...

	setFrameUpdater (string $a_up_frame, string $a_up_script, string $a_params="")

	highlightNode (string $a_id)

	checkPermissions (bool $a_check)

	setSessionExpandVariable (string $a_var_name="expand")

	outputIcons (bool $a_icons)

	setClickable (string $a_type, bool $a_clickable)

	isVisible ( $a_ref_id, string $a_type)

	setTreeLead (string $a_val)

	getTreeLead ()

	isClickable (string $type, int $ref_id=0)

	setPostSort (bool $a_sort)

	setFilterMode (int $a_mode=IL_FM_NEGATIVE)

	getFilterMode ()

	setUseStandardFrame (bool $a_val)
	Set use standard frame. More...

	getUseStandardFrame ()

	getChildsOfNode ($a_parent_id)

	setOutput ( $a_parent_id, int $a_depth=1, int $a_obj_id=0, bool $a_highlighted_subtree=false)
	Creates output for explorer view in admin menue recursive method. More...

	modifyChilds ( $a_parent_id, array $a_objects)

	showChilds ($a_parent_id)
	determines wether the childs of an object should be shown or not note: this standard implementation always returns true but it could be overwritten by derived classes (e.g. More...

	forceExpanded ($a_obj_id)
	force expansion of node More...

	getMaximumTreeDepth ()

	getOutput ()

	handleListEndTags (ilTemplate $a_tpl_tree, int $a_cur_depth, int $a_item_depth)
	handle list end tags ( and ) More...

	handleListStartTags (ilTemplate $a_tpl_tree, int $a_cur_depth, int $a_item_depth)
	handle list start tags ( More...

	formatHeader (ilTemplate $tpl, $a_obj_id, array $a_option)

	formatObject (ilTemplate $tpl, $a_node_id, array $a_option, $a_obj_id=0)

	getImage (string $a_name, string $a_type="", $a_obj_id="")

	getImageAlt (string $a_default_text, string $a_type="", $a_obj_id="")

	getNodeStyleClass ( $a_id, string $a_type)

	buildLinkTarget ( $a_node_id, string $a_type)

	buildOnClick ( $a_node_id, string $a_type, string $a_title)

	buildTitle (string $a_title, $a_id, string $a_type)

	buildDescription (string $a_desc, $a_id, string $a_type)

	buildSelect ($a_node_id, string $a_type)
	standard implementation for adding an option select box between image and title More...

	buildFrameTarget (string $a_type, $a_child=0, $a_obj_id=0)

	createTarget (string $a_type, $a_node_id, bool $a_highlighted_subtree=false, bool $a_append_anch=true)

	setFrameTarget (string $a_target)

	createLines (int $a_depth)

	is_in_array (int $a_start, int $a_depth)

	getIndex (array $a_data)

	addFilter (string $a_item)

	delFilter (string $a_item)

	setExpand ($a_node_id)
	set the expand option this value is stored in a SESSION variable to save it different view (lo view, frm view,...) More...

	forceExpandAll (bool $a_mode, bool $a_show_minus=true)
	force expandAll. More...

	setFiltered (bool $a_bool)

	checkFilter (string $a_item)

	sortNodes (array $a_nodes, $a_parent_obj_id)
	sort nodes and put adm object to the end of sorted array More...

Protected Attributes
ilSetting	$settings

ilDBInterface	$db

ilObjUser	$user

ilAccessHandler	$access

ilCtrl	$ctrl

array	$force_open_path

StandardGUIRequest	$request

array	$session_materials

array	$item_group_items

array	$type_grps

Protected Attributes inherited from ilExplorer
ilObjectDefinition	$obj_definition

ilErrorHandling	$error

ilRbacSystem	$rbacsystem

ilGlobalTemplateInterface	$tpl

ilLanguage	$lng

	$filter = []

string	$highlighted = ""

bool	$show_minus = true

int	$counter = 0

bool	$asnch_expanding = false

int	$textwidth = 0

string	$title = ""

string	$up_frame = ""

string	$a_up_script = ""

string	$up_params = ""

string	$frame_target = ""

string	$up_script = ""

string	$tree_lead = ""

array	$iconList = []

ILIAS Refinery Factory	$refinery

ILIAS HTTP Wrapper WrapperFactory	$wrapper

Additional Inherited Members
Data Fields inherited from ilExplorer
string	$id = ""

string	$output = ""

array	$format_options = []

ilTree	$tree

string	$target = ""

string	$target_get = ""

string	$params_get = ""

array	$expanded = []

string	$order_column = ""

string	$order_direction = "asc"

string	$expand_target = null

bool	$rbac_check = false

bool	$output_icons = false

string	$expand_variable = ""

array	$is_clickable = []

bool	$post_sort = false

bool	$filtered = false

bool	$filter_mode

bool	$expand_all = false

	$root_id = null

bool	$use_standard_frame = false

Protected Member Functions inherited from ilExplorer
	requestStr (string $key)

Detailed Description

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

Member Function Documentation

◆ buildLinkTarget()

ilRepositoryExplorer::buildLinkTarget	(		$a_node_id,
		string	$a_type
	)

note: most of this stuff is used by ilCourseContentInterface too

Reimplemented from ilExplorer.

Definition at line 102 of file class.ilRepositoryExplorer.php.

                                                               : string
    {
        $ilCtrl = $this->ctrl;
 
        $ref_id = $this->request->getRefId();
 
        switch ($a_type) {
            case "cat":
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "");
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
                return $link;
 
            case "grpr":
            case "crsr":
            case "catr":
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "redirect");
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
                return $link;
 
            case "grp":
                $ilCtrl->setParameterByClass("ilobjgroupgui", "ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass(["ilrepositorygui", "ilobjgroupgui"], "");
                $ilCtrl->setParameterByClass("ilobjgroupgui", "ref_id", $ref_id);
                return $link;
 
            case "crs":
                $ilCtrl->setParameterByClass("ilobjcoursegui", "ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass(["ilrepositorygui", "ilobjcoursegui"], "view");
                $ilCtrl->setParameterByClass("ilobjcoursegui", "ref_id", $ref_id);
                return $link;
 
            case 'rcrs':
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass("ilrepositorygui", "infoScreen");
                $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", $ref_id);
                return $link;
 
            case 'prg':
                $ilCtrl->setParameterByClass("ilobjstudyprogrammegui", "ref_id", $a_node_id);
                $link = $ilCtrl->getLinkTargetByClass("ilobjstudyprogrammegui", "view");
                $ilCtrl->setParameterByClass("ilobjstudyprogrammegui", "ref_id", $ref_id);
                return $link;
 
            default:
                return ilLink::_getStaticLink($a_node_id, $a_type, true);
 
        }
    }

References $ctrl, $ref_id, and ilLink\_getStaticLink().

Here is the call graph for this function:

◆ forceExpanded()

ilRepositoryExplorer::forceExpanded ( $a_obj_id )

force expansion of node

Reimplemented from ilExplorer.

Definition at line 394 of file class.ilRepositoryExplorer.php.

                                            : bool
    {
        if (in_array($a_obj_id, $this->force_open_path)) {
            return true;
        }
        return false;
    }

◆ formatHeader()

ilRepositoryExplorer::formatHeader	(	ilTemplate	$tpl,
			$a_obj_id,
		array	$a_option
	)

Reimplemented from ilExplorer.

Reimplemented in ilPasteIntoMultipleItemsExplorer.

Definition at line 314 of file class.ilRepositoryExplorer.php.

                                                                             : void
    {
        $lng = $this->lng;
        $tree = $this->tree;
        $ilCtrl = $this->ctrl;
 
        // custom icons
        $path = ilObject::_getIcon((int) $a_obj_id, "tiny", "root");
 
        $tpl->setCurrentBlock("icon");
        $nd = $tree->getNodeData(ROOT_FOLDER_ID);
        $title = $nd["title"];
        if ($title === "ILIAS") {
            $title = $lng->txt("repository");
        }
 
        $tpl->setVariable("ICON_IMAGE", $path);
        $tpl->setVariable("TXT_ALT_IMG", $lng->txt("icon") . " " . $title);
        $tpl->parseCurrentBlock();
 
        $tpl->setCurrentBlock("link");
        $tpl->setVariable("TITLE", $title);
        $ilCtrl->setParameterByClass("ilrepositorygui", "ref_id", "1");
        $tpl->setVariable(
            "LINK_TARGET",
            $ilCtrl->getLinkTargetByClass("ilrepositorygui", "")
        );
        $ilCtrl->setParameterByClass(
            "ilrepositorygui",
            "ref_id",
            $this->request->getRefId()
        );
        $tpl->setVariable("TARGET", " target=\"_top\"");
        $tpl->parseCurrentBlock();
 
        $tpl->setCurrentBlock("element");
        $tpl->parseCurrentBlock();
    }

References $ctrl, ilExplorer\$lng, $nd, $path, ilExplorer\$title, ilExplorer\$tpl, ilExplorer\$tree, ilObject\_getIcon(), ilTree\getNodeData(), ilGlobalTemplateInterface\parseCurrentBlock(), ROOT_FOLDER_ID, ilGlobalTemplateInterface\setCurrentBlock(), ilGlobalTemplateInterface\setVariable(), and ilLanguage\txt().

Here is the call graph for this function:

◆ getImage()

ilRepositoryExplorer::getImage	(	string	$a_name,
		string	$a_type = `""`,
			$a_obj_id = `""`
	)

Reimplemented from ilExplorer.

Definition at line 153 of file class.ilRepositoryExplorer.php.

                                                                                 : string
    {
        if ($a_type !== "") {
            return ilObject::_getIcon((int) $a_obj_id, "tiny", $a_type);
        }
 
        return parent::getImage($a_name);
    }

References ilObject\_getIcon().

Here is the call graph for this function:

◆ isClickable()

ilRepositoryExplorer::isClickable	(	string	$type,
		int	$ref_id = `0`
	)

Reimplemented from ilExplorer.

Reimplemented in ilPasteIntoMultipleItemsExplorer.

Definition at line 162 of file class.ilRepositoryExplorer.php.

                                                              : bool
    {
        $rbacsystem = $this->rbacsystem;
        $ilDB = $this->db;
 
        $obj_id = ilObject::_lookupObjId($ref_id);
        if (!ilConditionHandler::_checkAllConditionsOfTarget(
            $ref_id,
            $obj_id
        )) {
            return false;
        }
 
        switch ($type) {
            case 'tst':
                if (!$rbacsystem->checkAccess("read", $ref_id)) {
                    return false;
                }
 
                $query = sprintf("SELECT * FROM tst_tests WHERE obj_fi=%s", $obj_id);
                $res = $ilDB->query($query);
                while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                    return (bool) $row->complete;
                }
                return false;
 
            case 'svy':
                if (!$rbacsystem->checkAccess("read", $ref_id)) {
                    return false;
                }
 
                $query = sprintf("SELECT * FROM svy_svy WHERE obj_fi=%s", $obj_id);
                $res = $ilDB->query($query);
                while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                    return (bool) $row->complete;
                }
                return false;
 
            // media pools can only be edited
            case "mep":
                if ($rbacsystem->checkAccess("read", $ref_id)) {
                    return true;
                }
                return false;
            case 'grpr':
            case 'crsr':
            case 'catr':
                return ilContainerReferenceAccess::_isAccessible($ref_id);
            case 'prg':
                    return $rbacsystem->checkAccess("visible", $ref_id);
 
 
 
            // all other types are only clickable, if read permission is given
            default:
                if ($rbacsystem->checkAccess("read", $ref_id)) {
                    // check if lm is online
                    if ($type === "lm") {
                        $lm_obj = new ilObjLearningModule($ref_id);
                        if (($lm_obj->getOfflineStatus()) && (!$rbacsystem->checkAccess('write', $ref_id))) {
                            return false;
                        }
                    }
                    // check if fblm is online
                    if ($type === "htlm") {
                        $lm_obj = new ilObjFileBasedLM($ref_id);
                        if (($lm_obj->getOfflineStatus()) && (!$rbacsystem->checkAccess('write', $ref_id))) {
                            return false;
                        }
                    }
                    // check if fblm is online
                    if ($type === "sahs") {
                        $lm_obj = new ilObjSAHSLearningModule($ref_id);
                        if (($lm_obj->getOfflineStatus()) && (!$rbacsystem->checkAccess('write', $ref_id))) {
                            return false;
                        }
                    }
                    // check if glossary is online
                    if ($type === "glo") {
                        $obj_id = ilObject::_lookupObjectId($ref_id);
                        if ((!ilObjGlossary::_lookupOnline($obj_id)) &&
                            (!$rbacsystem->checkAccess('write', $ref_id))) {
                            return false;
                        }
                    }
 
                    return true;
                }
                return false;
        }
    }

References $db, $ilDB, $query, ilExplorer\$rbacsystem, $ref_id, $res, $type, ilConditionHandler\_checkAllConditionsOfTarget(), ilContainerReferenceAccess\_isAccessible(), ilObject\_lookupObjectId(), ilObject\_lookupObjId(), ilObjGlossary\_lookupOnline(), ilRbacSystem\checkAccess(), and ilDBConstants\FETCHMODE_OBJECT.

Here is the call graph for this function:

◆ isVisible()

ilRepositoryExplorer::isVisible	(		$a_ref_id,
		string	$a_type
	)

Reimplemented from ilExplorer.

Reimplemented in ilPasteIntoMultipleItemsExplorer.

Definition at line 274 of file class.ilRepositoryExplorer.php.

                                                        : bool
    {
        $ilAccess = $this->access;
        $tree = $this->tree;
        $ilSetting = $this->settings;
 
        if (!$ilAccess->checkAccess('visible', '', $a_ref_id)) {
            return false;
        }
 
        $is_course = false;
        $container_parent_id = $tree->checkForParentType($a_ref_id, 'grp');
        if (!$container_parent_id) {
            $is_course = true;
            $container_parent_id = $tree->checkForParentType($a_ref_id, 'crs');
        }
        if ($container_parent_id) {
            // do not display session materials for container course/group
            if ($container_parent_id !== $a_ref_id && $ilSetting->get("repository_tree_pres") === "all_types") {
                // get container event items only once
                if (!isset($this->session_materials[$container_parent_id])) {
                    $this->session_materials[$container_parent_id] = ilEventItems::_getItemsOfContainer($container_parent_id);
                }
                // get item group items only once
                if (!isset($this->item_group_items[$container_parent_id])) {
                    $this->item_group_items[$container_parent_id] = ilItemGroupItems::_getItemsOfContainer($container_parent_id);
                }
                if (in_array($a_ref_id, $this->session_materials[$container_parent_id])) {
                    return false;
                }
                if (in_array($a_ref_id, $this->item_group_items[$container_parent_id])) {
                    return false;
                }
            }
        }
 
        return true;
    }

References $access, $ilSetting, $settings, ilExplorer\$tree, ilItemGroupItems\_getItemsOfContainer(), ilEventItems\_getItemsOfContainer(), and ilTree\checkForParentType().

Here is the call graph for this function:

◆ setForceOpenPath()

ilRepositoryExplorer::setForceOpenPath ( array $a_path )

set force open path

Definition at line 94 of file class.ilRepositoryExplorer.php.

                                                   : void
    {
        $this->force_open_path = $a_path;
    }

◆ showChilds()

ilRepositoryExplorer::showChilds	(		$a_parent_id,
		int	$a_obj_id = `0`
	)

Parameters

int | string $a_parent_id

Definition at line 257 of file class.ilRepositoryExplorer.php.

                                                               : bool
    {
        $rbacsystem = $this->rbacsystem;
 
        if ($a_parent_id == 0) {
            return true;
        }
        if (!ilConditionHandler::_checkAllConditionsOfTarget((int) $a_parent_id, $a_obj_id)) {
            return false;
        }
        if ($rbacsystem->checkAccess("read", (int) $a_parent_id)) {
            return true;
        }
 
        return false;
    }

References ilExplorer\$rbacsystem, ilConditionHandler\_checkAllConditionsOfTarget(), and ilRbacSystem\checkAccess().

Here is the call graph for this function:

◆ sortNodes()

ilRepositoryExplorer::sortNodes	(	array	$a_nodes,
			$a_parent_obj_id
	)

sort nodes and put adm object to the end of sorted array

Reimplemented from ilExplorer.

Definition at line 353 of file class.ilRepositoryExplorer.php.

                                                               : array
    {
        $objDefinition = $this->obj_definition;
 
        if ($a_parent_obj_id > 0) {
            $parent_type = ilObject::_lookupType($a_parent_obj_id);
        } else {
            $parent_type = "dummy";
            $this->type_grps["dummy"] = ["root" => "dummy"];
        }
 
        if (empty($this->type_grps[$parent_type])) {
            $this->type_grps[$parent_type] = $objDefinition->getGroupedRepositoryObjectTypes($parent_type);
        }
        $group = [];
 
        foreach ($a_nodes as $node) {
            $g = $objDefinition->getGroupOfObj($node["type"]);
            if ($g == "") {
                $g = $node["type"];
            }
            $group[$g][] = $node;
        }
 
        $nodes = [];
        foreach ($this->type_grps[$parent_type] as $t => $g) {
            if (array_key_exists($t, $group)
                && is_array($group[$t])) {
                // do we have to sort this group??
                $sort = ilContainerSorting::_getInstance($a_parent_obj_id);
                $group = $sort->sortItems($group);
 
                foreach ($group[$t] as $k => $item) {
                    $nodes[] = $item;
                }
            }
        }
 
        return $nodes;
    }