ilPasteIntoMultipleItemsExplorer Explorer More...

Inheritance diagram for ilPasteIntoMultipleItemsExplorer:

Collaboration diagram for ilPasteIntoMultipleItemsExplorer:

Public Member Functions
	__construct (int $type, string $target, string $session_variable)

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

	addFormItemForType (string $type)

	removeFormItemForType (string $type)

	setCheckedItems (array $checked_items=[])

	isItemChecked (int $id)

	setPostVar (string $post_var)

	getPostVar ()

	setRequiredFormItemPermission (string $form_item_permission)

	getRequiredFormItemPermission ()

	buildFormItem (int $node_id, string $type)

	formatObject (ilTemplate $tpl, $node_id, array $option, $obj_id=0)

	formatHeader (ilTemplate $tpl, $obj_id, array $option)

	showChilds ($parent_id, $obj_id=0)

	isVisible ($ref_id, string $type)

Public Member Functions inherited from ilRepositoryExplorer
	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...

Data Fields
const	SEL_TYPE_CHECK = 1

const	SEL_TYPE_RADIO = 2

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 Attributes
int	$type = 0

ClipboardManager	$clipboard

array	$checked_items = []

string	$post_var = ''

array	$form_items = []

string	$form_item_permission = 'read'

Protected Attributes inherited from ilRepositoryExplorer
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
Protected Member Functions inherited from ilExplorer
	requestStr (string $key)

Detailed Description

ilPasteIntoMultipleItemsExplorer Explorer

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

ilPasteIntoMultipleItemsExplorer::__construct	(	int	$type,
		string	$target,
		string	$session_variable
	)

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

    {
        global $DIC;
 
        $this->setId("cont_paste_explorer");
        $this->type = $type;
 
        parent::__construct($target);
 
        $this->root_id = $this->tree->readRootId();
        $this->order_column = 'title';
        $this->setSessionExpandVariable($session_variable);
 
        $this->addFilter('root');
        $this->addFilter('crs');
        $this->addFilter('grp');
        $this->addFilter('cat');
        $this->addFilter('fold');
        $this->addFilter('lso');
 
        $this->addFormItemForType('root');
        $this->addFormItemForType('crs');
        $this->addFormItemForType('grp');
        $this->addFormItemForType('cat');
        $this->addFormItemForType('fold');
        $this->addFormItemForType('lso');
 
        $this->setFiltered(true);
        $this->setFilterMode(IL_FM_POSITIVE);
        $this->clipboard = $DIC
            ->repository()
            ->internal()
            ->domain()
            ->clipboard();
    }

References $DIC, ilExplorer\$target, $type, ILIAS\GlobalScreen\Provider\__construct(), ilExplorer\addFilter(), addFormItemForType(), IL_FM_POSITIVE, ilExplorer\setFiltered(), ilExplorer\setFilterMode(), ilExplorer\setId(), and ilExplorer\setSessionExpandVariable().

Here is the call graph for this function:

Member Function Documentation

◆ addFormItemForType()

ilPasteIntoMultipleItemsExplorer::addFormItemForType ( string $type )

Definition at line 85 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                    : void
    {
        $this->form_items[$type] = true;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ buildFormItem()

ilPasteIntoMultipleItemsExplorer::buildFormItem	(	int	$node_id,
		string	$type
	)

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

                                                             : string
    {
        if (!$this->access->checkAccess($this->getRequiredFormItemPermission(), '', $node_id)) {
            return "";
        }
 
        if (
            !array_key_exists($type, $this->form_items) ||
            !$this->form_items[$type]
        ) {
            return "";
        }
 
        $disabled = false;
        if ($this->clipboard->hasEntries()) {
            $disabled = in_array($node_id, $this->clipboard->getRefIds());
        } elseif ($this->clipboard->getCmd() == 'copy' && $node_id == $this->clipboard->getParent()) {
            $disabled = true;
        }
 
        switch ($this->type) {
            case self::SEL_TYPE_CHECK:
                return ilLegacyFormElementsUtil::formCheckbox(
                    $this->isItemChecked($node_id),
                    $this->post_var,
                    (string) $node_id,
                    $disabled
                );
            case self::SEL_TYPE_RADIO:
                return ilLegacyFormElementsUtil::formRadioButton(
                    $this->isItemChecked($node_id),
                    $this->post_var,
                    (string) $node_id,
                    '',
                    $disabled
                );
        }
        return "";
    }

References ILIAS\Repository\access(), ilLegacyFormElementsUtil\formCheckbox(), and ilLegacyFormElementsUtil\formRadioButton().

Here is the call graph for this function:

◆ formatHeader()

ilPasteIntoMultipleItemsExplorer::formatHeader	(	ilTemplate	$tpl,
			$obj_id,
		array	$option
	)

Reimplemented from ilRepositoryExplorer.

Definition at line 286 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                                         : void
    {
        $path = ilObject::_getIcon((int) $obj_id, "tiny", "root");
 
        $tpl->setCurrentBlock("icon");
        $nd = $this->tree->getNodeData(ROOT_FOLDER_ID);
        $title = $nd["title"];
        if ($title == "ILIAS") {
            $title = $this->lng->txt("repository");
        }
 
        $tpl->setVariable("ICON_IMAGE", $path);
        $tpl->setVariable("TXT_ALT_IMG", $title);
        $tpl->parseCurrentBlock();
 
        if (strlen($formItem = $this->buildFormItem((int) $obj_id, $option['type']))) {
            $tpl->setCurrentBlock('check');
            $tpl->setVariable('OBJ_CHECK', $formItem);
            $tpl->parseCurrentBlock();
        }
 
        $tpl->setVariable('OBJ_TITLE', $title);
    }

References $nd, $path, ilObject\_getIcon(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ROOT_FOLDER_ID, ilTemplate\setCurrentBlock(), and HTML_Template_IT\setVariable().

Here is the call graph for this function:

◆ formatObject()

ilPasteIntoMultipleItemsExplorer::formatObject	(	ilTemplate	$tpl,
			$node_id,
		array	$option,
			$obj_id = `0`
	)

Reimplemented from ilExplorer.

Definition at line 165 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                                                       : void
    {
        $node_id = (int) $node_id;
        $obj_id = (int) $obj_id;
        if (!isset($node_id) or !is_array($option)) {
            $this->error->raiseError(
                get_class($this) .
                "::formatObject(): Missing parameter or wrong datatype! " .
                "node_id: " .
                $node_id .
                " options:" .
                var_dump($option),
                $this->error->WARNING
            );
        }
 
        $pic = false;
        foreach ($option["tab"] as $picture) {
            if ($picture == 'plus') {
                $tpl->setCurrentBlock("expander");
                $tpl->setVariable("EXP_DESC", $this->lng->txt("expand"));
                $target = $this->createTarget('+', $node_id);
                $tpl->setVariable("LINK_NAME", $node_id);
                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                $tpl->setVariable("IMGPATH", $this->getImage("browser/plus.png"));
                $tpl->parseCurrentBlock();
                $pic = true;
            }
 
            if ($picture == 'minus' && $this->show_minus) {
                $tpl->setCurrentBlock("expander");
                $tpl->setVariable("EXP_DESC", $this->lng->txt("collapse"));
                $target = $this->createTarget('-', $node_id);
                $tpl->setVariable("LINK_NAME", $node_id);
                $tpl->setVariable("LINK_TARGET_EXPANDER", $target);
                $tpl->setVariable("IMGPATH", $this->getImage("browser/minus.png"));
                $tpl->parseCurrentBlock();
                $pic = true;
            }
        }
 
        if (!$pic) {
            $tpl->setCurrentBlock("blank");
            $tpl->setVariable("BLANK_PATH", $this->getImage("browser/blank.png"));
            $tpl->parseCurrentBlock();
        }
 
        if ($this->output_icons) {
            $tpl->setCurrentBlock("icon");
 
            $path = ilObject::_getIcon($obj_id, "tiny", $option["type"]);
            $tpl->setVariable("ICON_IMAGE", $path);
 
            $tpl->setVariable("TARGET_ID", "iconid_" . $node_id);
            $this->iconList[] = "iconid_" . $node_id;
            $tpl->setVariable("TXT_ALT_IMG", $this->lng->txt($option["desc"]));
            $tpl->parseCurrentBlock();
        }
 
        if (strlen($formItem = $this->buildFormItem($node_id, $option['type']))) {
            $tpl->setCurrentBlock('check');
            $tpl->setVariable('OBJ_CHECK', $formItem);
            $tpl->parseCurrentBlock();
        }
 
        if ($this->isClickable($option["type"], $node_id)) {
            $tpl->setCurrentBlock("link");
            $tpl->setVariable("LINK_TARGET", $this->buildLinkTarget($node_id, $option["type"]));
 
            $style_class = $this->getNodeStyleClass($node_id, $option["type"]);
 
            if ($style_class != "") {
                $tpl->setVariable("A_CLASS", ' class="' . $style_class . '" ');
            }
 
            if (($onclick = $this->buildOnClick($node_id, $option["type"], $option["title"])) != "") {
                $tpl->setVariable("ONCLICK", "onClick=\"$onclick\"");
            }
 
            $tpl->setVariable("LINK_NAME", $node_id);
            $tpl->setVariable("TITLE", $this->buildTitle($option["title"], $node_id, $option["type"]));
            $tpl->setVariable(
                "DESC",
                ilStr::shortenTextExtended(
                    $this->buildDescription($option["description"], $node_id, $option["type"]),
                    $this->textwidth,
                    true
                )
            );
            $frame_target = $this->buildFrameTarget($option["type"], $node_id, $option["obj_id"]);
            if ($frame_target != "") {
                $tpl->setVariable("TARGET", " target=\"" . $frame_target . "\"");
            }
        } else {
            $obj_title = $this->buildTitle($option["title"], $node_id, $option["type"]);
 
            if ($node_id == $this->highlighted) {
                $obj_title = "<span class=\"ilHighlighted\">" . $obj_title . "</span>";
            }
 
            $tpl->setCurrentBlock("text");
            $tpl->setVariable("OBJ_TITLE", $obj_title);
            $tpl->setVariable(
                "OBJ_DESC",
                ilStr::shortenTextExtended(
                    $this->buildDescription($option["desc"], $node_id, $option["type"]),
                    $this->textwidth,
                    true
                )
            );
        }
        $tpl->parseCurrentBlock();
 
        $tpl->setCurrentBlock("list_item");
        $tpl->parseCurrentBlock();
        $tpl->touchBlock("element");
    }

References $path, ilObject\_getIcon(), error(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilTemplate\parseCurrentBlock(), ilTemplate\setCurrentBlock(), HTML_Template_IT\setVariable(), ilStr\shortenTextExtended(), and ilTemplate\touchBlock().

Here is the call graph for this function:

◆ getPostVar()

ilPasteIntoMultipleItemsExplorer::getPostVar ( )

Definition at line 110 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                : string
    {
        return $this->post_var;
    }

◆ getRequiredFormItemPermission()

ilPasteIntoMultipleItemsExplorer::getRequiredFormItemPermission ( )

Definition at line 120 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                   : string
    {
        return $this->form_item_permission;
    }

◆ isClickable()

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

Reimplemented from ilRepositoryExplorer.

Definition at line 78 of file class.ilPasteIntoMultipleItemsExplorer.php.

     : bool {
        return false;
    }

◆ isItemChecked()

ilPasteIntoMultipleItemsExplorer::isItemChecked ( int $id )

Definition at line 100 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                          : bool
    {
        return in_array($id, $this->checked_items);
    }

References $id.

◆ isVisible()

ilPasteIntoMultipleItemsExplorer::isVisible	(		$ref_id,
		string	$type
	)

Reimplemented from ilRepositoryExplorer.

Definition at line 321 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                    : bool
    {
        if (!$this->access->checkAccess('visible', '', (int) $ref_id)) {
            return false;
        }
        return true;
    }

References $ref_id, and ILIAS\Repository\access().

Here is the call graph for this function:

◆ removeFormItemForType()

ilPasteIntoMultipleItemsExplorer::removeFormItemForType ( string $type )

Definition at line 90 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                       : void
    {
        $this->form_items[$type] = false;
    }

◆ setCheckedItems()

ilPasteIntoMultipleItemsExplorer::setCheckedItems ( array $checked_items = [] )

Definition at line 95 of file class.ilPasteIntoMultipleItemsExplorer.php.

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

◆ setPostVar()

ilPasteIntoMultipleItemsExplorer::setPostVar ( string $post_var )

Definition at line 105 of file class.ilPasteIntoMultipleItemsExplorer.php.

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

◆ setRequiredFormItemPermission()

ilPasteIntoMultipleItemsExplorer::setRequiredFormItemPermission ( string $form_item_permission )

Definition at line 115 of file class.ilPasteIntoMultipleItemsExplorer.php.

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

◆ showChilds()

ilPasteIntoMultipleItemsExplorer::showChilds	(	$parent_id,
		$obj_id = `0`
	)

Definition at line 310 of file class.ilPasteIntoMultipleItemsExplorer.php.

                                                       : bool
    {
        if ($parent_id == 0) {
            return true;
        }
        if ($this->access->checkAccess("read", "", (int) $parent_id)) {
            return true;
        }
        return false;
    }