Repository GUI Utilities. More...

Collaboration diagram for ilRepUtilGUI:

Public Member Functions
	__construct ($a_parent_gui, $a_parent_cmd="")
	Constructor. More...

	executeCommand ()

	restoreToNewLocation (\ilPropertyFormGUI $form=null)

	doRestoreToNewLocation ()
	Perform restore to new location. More...

	showDeleteConfirmation ($a_ids, $a_supress_message=false)
	Show delete confirmation table. More...

	handleMultiReferences ($a_obj_id, $a_ref_id, $a_form_name)
	Build subitem list for multiple references. More...

	showTrashTable ($a_ref_id)
	Get trashed objects for a container. More...

	restoreObjects ($a_cur_ref_id, $a_ref_ids)
	Restore objects from trash. More...

	deleteObjects ($a_cur_ref_id, $a_ref_ids)
	Delete objects. More...

	removeObjectsFromSystem ($a_ref_ids, $a_from_recovery_folder=false)
	Remove objects from system. More...

	confirmRemoveFromSystemObject ($a_ids)
	Confirmation for trash. More...

Protected Member Functions
	cancel ()
	Cancel action. More...

	initFormTrashTargetLocation ()

	buildPath ($ref_ids)
	Build path with deep-link. More...

Protected Attributes
	$lng

	$settings

	$ctrl

	$tpl

	$obj_definition

	$access

	$tree

Private Attributes
	$logger = null

Detailed Description

Repository GUI Utilities.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

@ilCtrl_Calls ilRepUtilGUI: ilPropertyFormGUI

Definition at line 15 of file class.ilRepUtilGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRepUtilGUI::__construct	(	$a_parent_gui,
		$a_parent_cmd = `""`
	)

Constructor.

Parameters

object	parent gui object
string	current parent command (like in table2gui)

Definition at line 65 of file class.ilRepUtilGUI.php.

    {
        global $DIC;
 
        $this->lng = $DIC->language();
        $this->settings = $DIC->settings();
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->obj_definition = $DIC["objDefinition"];
        $this->access = $DIC->access();
        $this->tree = $DIC->repositoryTree();
        $this->parent_gui = $a_parent_gui;
        $this->parent_cmd = $a_parent_cmd;
 
        $this->logger = $DIC->logger()->rep();
    }

References $DIC, and settings().

Here is the call graph for this function:

Member Function Documentation

◆ buildPath()

ilRepUtilGUI::buildPath ( $ref_ids )

protected

Build path with deep-link.

Parameters

array $ref_ids

Returns: array

Definition at line 505 of file class.ilRepUtilGUI.php.

    {
        $tree = $this->tree;
 
        include_once 'Services/Link/classes/class.ilLink.php';
        
        if (!count($ref_ids)) {
            return false;
        }
        
        $result = array();
        foreach ($ref_ids as $ref_id) {
            $path = "";
            $path_full = $tree->getPathFull($ref_id);
            foreach ($path_full as $idx => $data) {
                if ($idx) {
                    $path .= " &raquo; ";
                }
                if ($ref_id != $data['ref_id']) {
                    $path .= $data['title'];
                } else {
                    $path .= ('<a target="_top" href="' .
                              ilLink::_getLink($data['ref_id'], $data['type']) . '">' .
                              $data['title'] . '</a>');
                }
            }
 
            $result[] = $path;
        }
        return $result;
    }

References $data, $result, $tree, and ilLink\_getLink().

Referenced by handleMultiReferences().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cancel()

ilRepUtilGUI::cancel ( )

protected

Cancel action.

Definition at line 108 of file class.ilRepUtilGUI.php.

    {
        $this->ctrl->returnToParent($this);
    }

◆ confirmRemoveFromSystemObject()

ilRepUtilGUI::confirmRemoveFromSystemObject ( $a_ids )

Confirmation for trash.

Parameters

array $a_ids ref_ids

Definition at line 542 of file class.ilRepUtilGUI.php.

    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        $objDefinition = $this->obj_definition;
        $tpl = $this->tpl;
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
 
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($ilCtrl->getFormAction($this->parent_gui));
        $cgui->setCancel($lng->txt("cancel"), "trash");
        $cgui->setConfirm($lng->txt("confirm"), "removeFromSystem");
        $cgui->setFormName("trash_confirmation");
        $cgui->setHeaderText($lng->txt("info_delete_sure"));
 
        foreach ($a_ids as $id) {
            $obj_id = ilObject::_lookupObjId($id);
            $type = ilObject::_lookupType($obj_id);
            $title = call_user_func(array(ilObjectFactory::getClassByType($type),'_lookupTitle'), $obj_id);
            $alt = ($objDefinition->isPlugin($type))
                ? $lng->txt("icon") . " " . ilObjectPlugin::lookupTxtById($type, "obj_" . $type)
                : $lng->txt("icon") . " " . $lng->txt("obj_" . $type);
 
            $cgui->addItem(
                "trash_id[]",
                $id,
                $title,
                ilObject::_getIcon($obj_id, "small", $type),
                $alt
            );
        }
 
        $tpl->setContent($cgui->getHTML());
    }

References $ctrl, $ilCtrl, $lng, $obj_definition, $tpl, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), ilObjectFactory\getClassByType(), and ilObjectPlugin\lookupTxtById().

Here is the call graph for this function:

◆ deleteObjects()

ilRepUtilGUI::deleteObjects	(	$a_cur_ref_id,
		$a_ref_ids
	)

Delete objects.

Definition at line 451 of file class.ilRepUtilGUI.php.

    {
        $ilSetting = $this->settings;
        $lng = $this->lng;
        
        if (!is_array($a_ref_ids) || count($a_ref_ids) == 0) {
            ilUtil::sendFailure($lng->txt("no_checkbox"), true);
            return false;
        } else {
            include_once("./Services/Repository/classes/class.ilRepUtil.php");
            try {
                ilRepUtil::deleteObjects($a_cur_ref_id, $a_ref_ids);
                if ($ilSetting->get('enable_trash')) {
                    ilUtil::sendSuccess($lng->txt("info_deleted"), true);
                } else {
                    ilUtil::sendSuccess($lng->txt("msg_removed"), true);
                }
            } catch (Exception $e) {
                ilUtil::sendFailure($e->getMessage(), true);
                return false;
            }
        }
    }

References Vendor\Package\$e, $ilSetting, $lng, $settings, ilRepUtil\deleteObjects(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ doRestoreToNewLocation()

ilRepUtilGUI::doRestoreToNewLocation ( )

Perform restore to new location.

Definition at line 144 of file class.ilRepUtilGUI.php.

    {
        $trash_ids = [];
        if (isset($_REQUEST['trash_ids'])) {
            $trash_ids = explode(',', $_REQUEST['trash_ids']);
        }
 
        $form = $this->initFormTrashTargetLocation();
        if (!$form->checkInput() && count($trash_ids)) {
            $this->lng->loadLanguageModule('search');
            \ilUtil::sendFailure($this->lng->txt('search_no_selection'), true);
            $this->ctrl->returnToParent($this);
        }
 
        try {
            \ilRepUtil::restoreObjects($form->getInput('target_id'), $trash_ids);
            \ilUtil::sendSuccess($this->lng->txt('msg_undeleted'), true);
            $this->ctrl->returnToParent($this);
        } catch (\ilRepositoryException $e) {
            \ilUtil::sendFailure($e->getMessage(), true);
            $this->ctrl->returnToParent($this);
        }
    }

References Vendor\Package\$e, initFormTrashTargetLocation(), ilRepUtil\restoreObjects(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ executeCommand()

ilRepUtilGUI::executeCommand ( )

Exceptions

ilCtrlException

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

    {
        global $DIC;
 
        $logger = $DIC->logger()->rep();
        $next_class = $this->ctrl->getNextClass($this);
        switch ($next_class) {
            case "ilpropertyformgui":
                $form = $this->initFormTrashTargetLocation();
                $this->ctrl->forwardCommand($form);
                break;
 
            default:
                $cmd = $this->ctrl->getCmd('cancel');
                $this->$cmd();
                break;
 
        }
    }

References $DIC, $logger, and initFormTrashTargetLocation().

Here is the call graph for this function:

◆ handleMultiReferences()

ilRepUtilGUI::handleMultiReferences	(	$a_obj_id,
		$a_ref_id,
		$a_form_name
	)

Build subitem list for multiple references.

Parameters

int	$a_obj_id
int	$a_ref_id
string	$a_form_name

Returns: string

Definition at line 289 of file class.ilRepUtilGUI.php.

    {
        $lng = $this->lng;
        $ilAccess = $this->access;
        $tree = $this->tree;
                                
        // process
    
        $all_refs = ilObject::_getAllReferences($a_obj_id);
        if (sizeof($all_refs) > 1) {
            $lng->loadLanguageModule("rep");
            
            $may_delete_any = 0;
            $counter = 0;
            $items = array();
            foreach ($all_refs as $mref_id) {
                // not the already selected reference, no refs from trash
                if ($mref_id != $a_ref_id && !$tree->isDeleted($mref_id)) {
                    if ($ilAccess->checkAccess("read", "", $mref_id)) {
                        $may_delete = false;
                        if ($ilAccess->checkAccess("delete", "", $mref_id)) {
                            $may_delete = true;
                            $may_delete_any++;
                        }
                                                
                        $items[] = array("id" => $mref_id,
                            "path" => array_shift($this->buildPath(array($mref_id))),
                            "delete" => $may_delete);
                    } else {
                        $counter++;
                    }
                }
            }
 
            
            // render
 
            $tpl = new ilTemplate("tpl.rep_multi_ref.html", true, true, "Services/Repository");
 
            $tpl->setVariable("TXT_INTRO", $lng->txt("rep_multiple_reference_deletion_intro"));
            
            if ($may_delete_any) {
                $tpl->setVariable("TXT_INSTRUCTION", $lng->txt("rep_multiple_reference_deletion_instruction"));
            }
            
            if ($items) {
                $var_name = "mref_id[]";
                
                foreach ($items as $item) {
                    if ($item["delete"]) {
                        $tpl->setCurrentBlock("cbox");
                        $tpl->setVariable("ITEM_NAME", $var_name);
                        $tpl->setVariable("ITEM_VALUE", $item["id"]);
                        $tpl->parseCurrentBlock();
                    } else {
                        $tpl->setCurrentBlock("item_info");
                        $tpl->setVariable("TXT_ITEM_INFO", $lng->txt("rep_no_permission_to_delete"));
                        $tpl->parseCurrentBlock();
                    }
                    
                    $tpl->setCurrentBlock("item");
                    $tpl->setVariable("ITEM_TITLE", $item["path"]);
                    $tpl->parseCurrentBlock();
                }
                
                if ($may_delete_any > 1) {
                    $tpl->setCurrentBlock("cbox");
                    $tpl->setVariable("ITEM_NAME", "sall_" . $a_ref_id);
                    $tpl->setVariable("ITEM_VALUE", "");
                    $tpl->setVariable("ITEM_ADD", " onclick=\"il.Util.setChecked('" .
                        $a_form_name . "', '" . $var_name . "', document." . $a_form_name .
                        ".sall_" . $a_ref_id . ".checked)\"");
                    $tpl->parseCurrentBlock();
                    
                    $tpl->setCurrentBlock("item");
                    $tpl->setVariable("ITEM_TITLE", $lng->txt("select_all"));
                    $tpl->parseCurrentBlock();
                }
            }
            
            if ($counter) {
                $tpl->setCurrentBlock("add_info");
                $tpl->setVariable(
                    "TXT_ADDITIONAL_INFO",
                    sprintf($lng->txt("rep_object_references_cannot_be_read"), $counter)
                );
                $tpl->parseCurrentBlock();
            }
 
            return $tpl->get();
        }
    }

References $access, $lng, $tpl, $tree, ilObject\_getAllReferences(), and buildPath().

Referenced by showDeleteConfirmation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormTrashTargetLocation()

ilRepUtilGUI::initFormTrashTargetLocation ( )

protected

Returns: \ilPropertyFormGUI

Definition at line 171 of file class.ilRepUtilGUI.php.

    {
        $form = new \ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
 
        $target = new \ilRepositorySelector2InputGUI(
            $this->lng->txt('rep_target_location'),
            'target_id',
            false
        );
        $target->setRequired(true);
 
        $explorer = new \ilRepositorySelectorExplorerGUI(
            [
                \ilAdministrationGUI::class,
                get_class($this->parent_gui),
                \ilRepUtilGUI::class,
                \ilPropertyFormGUI::class,
                \ilFormPropertyDispatchGUI::class,
                \ilRepositorySelector2InputGUI::class
            ],
            'handleExplorerCommand',
            $target,
            'root_id',
            'rep_exp_sel_' . $target->getPostVar()
        );
        $explorer->setSelectMode($target->getPostVar() . "_sel", false);
        $explorer->setRootId(ROOT_FOLDER_ID);
        $explorer->setTypeWhiteList(['root','cat','crs','grp','fold']);
        $target->setExplorerGUI($explorer);
 
        $form->addItem($target);
        $form->addCommandButton('doRestoreToNewLocation', $this->lng->txt('btn_undelete'));
        $form->addCommandButton('cancel', $this->lng->txt('cancel'));
 
        return $form;
    }

Referenced by doRestoreToNewLocation(), executeCommand(), and restoreToNewLocation().

Here is the caller graph for this function:

◆ removeObjectsFromSystem()

ilRepUtilGUI::removeObjectsFromSystem	(	$a_ref_ids,
		$a_from_recovery_folder = `false`
	)

Remove objects from system.

Definition at line 478 of file class.ilRepUtilGUI.php.

    {
        $lng = $this->lng;
        
        if (!is_array($a_ref_ids) || count($a_ref_ids) == 0) {
            ilUtil::sendFailure($lng->txt("no_checkbox"), true);
            return false;
        } else {
            include_once("./Services/Repository/classes/class.ilRepUtil.php");
            try {
                ilRepUtil::removeObjectsFromSystem($a_ref_ids, $a_from_recovery_folder);
                ilUtil::sendSuccess($lng->txt("msg_removed"), true);
            } catch (Exception $e) {
                ilUtil::sendFailure($e->getMessage(), true);
                return false;
            }
        }
 
        return true;
    }

References Vendor\Package\$e, $lng, ilRepUtil\removeObjectsFromSystem(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ restoreObjects()

ilRepUtilGUI::restoreObjects	(	$a_cur_ref_id,
		$a_ref_ids
	)

Restore objects from trash.

Parameters

int	current ref id
int[]	array of ref ids to be restored

Definition at line 412 of file class.ilRepUtilGUI.php.

    {
        $lng = $this->lng;
        $lng->loadLanguageModule('rep');
        
        if (!is_array($a_ref_ids) || count($a_ref_ids) == 0) {
            ilUtil::sendFailure($lng->txt("no_checkbox"), true);
            return false;
        }
 
        $tree_trash_queries = new \ilTreeTrashQueries();
        if ($tree_trash_queries->isTrashedTrash($a_ref_ids)) {
            \ilUtil::sendFailure($this->lng->txt('rep_failure_trashed_trash'), true);
            return false;
        }
        try {
 
            // find parent foreach node
            $by_location = [];
            foreach ($a_ref_ids as $deleted_node_id) {
                $target_id = $tree_trash_queries->findRepositoryLocationForDeletedNode($deleted_node_id);
                if ($target_id) {
                    $by_location[$target_id][] = $deleted_node_id;
                }
            }
            foreach ($by_location as $target_id => $deleted_node_ids) {
                \ilRepUtil::restoreObjects($target_id, $deleted_node_ids);
            }
            ilUtil::sendSuccess($lng->txt("msg_undeleted"), true);
        } catch (Exception $e) {
            ilUtil::sendFailure($e->getMessage(), true);
            return false;
        }
        return true;
    }

References Vendor\Package\$e, $lng, $target_id, ilRepUtil\restoreObjects(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ restoreToNewLocation()

ilRepUtilGUI::restoreToNewLocation ( \ilPropertyFormGUI $form = null )

Parameters

\ilPropertyFormGUI | null $form

Returns: bool

Definition at line 117 of file class.ilRepUtilGUI.php.

    {
        $this->lng->loadLanguageModule('rep');
 
        if (isset($_POST['trash_id'])) {
            $trash_ids = (array) $_POST['trash_id'];
        } elseif (isset($_REQUEST['trash_ids'])) {
            $trash_ids = explode(',', $_POST['trash_ids']);
        }
 
        $this->ctrl->setParameter($this, 'trash_ids', implode(',', $trash_ids));
 
        if (!count($trash_ids)) {
            \ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->returnToParent($this);
        }
 
        if (!$form instanceof \ilPropertyFormGUI) {
            $form = $this->initFormTrashTargetLocation();
        }
        \ilUtil::sendInfo($this->lng->txt('rep_target_location_info'));
        $this->tpl->setContent($form->getHTML());
    }

References $_POST, initFormTrashTargetLocation(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ showDeleteConfirmation()

ilRepUtilGUI::showDeleteConfirmation	(	$a_ids,
		$a_supress_message = `false`
	)

Show delete confirmation table.

Definition at line 213 of file class.ilRepUtilGUI.php.

    {
        $lng = $this->lng;
        $ilSetting = $this->settings;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $objDefinition = $this->obj_definition;
 
        if (!is_array($a_ids) || count($a_ids) == 0) {
            ilUtil::sendFailure($lng->txt("no_checkbox"), true);
            return false;
        }
        
        // Remove duplicate entries
        $a_ids = array_unique((array) $a_ids);
 
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $cgui = new ilConfirmationGUI();
 
        if (!$a_supress_message) {
            $msg = $lng->txt("info_delete_sure");
            
            if (!$ilSetting->get('enable_trash')) {
                $msg .= "<br/>" . $lng->txt("info_delete_warning_no_trash");
            }
            
            $cgui->setHeaderText($msg);
        }
        $cgui->setFormAction($ilCtrl->getFormAction($this->parent_gui));
        $cgui->setCancel($lng->txt("cancel"), "cancelDelete");
        $cgui->setConfirm($lng->txt("confirm"), "confirmedDelete");
        
        $form_name = "cgui_" . md5(uniqid());
        $cgui->setFormName($form_name);
 
        $deps = array();
        foreach ($a_ids as $ref_id) {
            $obj_id = ilObject::_lookupObjId($ref_id);
            $type = ilObject::_lookupType($obj_id);
            $title = call_user_func(array(ilObjectFactory::getClassByType($type),'_lookupTitle'), $obj_id);
            $alt = ($objDefinition->isPlugin($type))
                ? $lng->txt("icon") . " " . ilObjectPlugin::lookupTxtById($type, "obj_" . $type)
                : $lng->txt("icon") . " " . $lng->txt("obj_" . $type);
            
            $title .= $this->handleMultiReferences($obj_id, $ref_id, $form_name);
            
            $cgui->addItem(
                "id[]",
                $ref_id,
                $title,
                ilObject::_getIcon($obj_id, "small", $type),
                $alt
            );
 
            ilObject::collectDeletionDependencies($deps, $ref_id, $obj_id, $type);
        }
        $deps_html = "";
 
        if (is_array($deps) && count($deps) > 0) {
            include_once("./Services/Repository/classes/class.ilRepDependenciesTableGUI.php");
            $tab = new ilRepDependenciesTableGUI($deps);
            $deps_html = "<br/><br/>" . $tab->getHTML();
        }
        
        $tpl->setContent($cgui->getHTML() . $deps_html);
        return true;
    }

References $ctrl, $ilCtrl, $ilSetting, $lng, $obj_definition, $settings, $tab, $tpl, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), ilObject\collectDeletionDependencies(), ilObjectFactory\getClassByType(), handleMultiReferences(), ilObjectPlugin\lookupTxtById(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ showTrashTable()

ilRepUtilGUI::showTrashTable ( $a_ref_id )

Get trashed objects for a container.

Parameters

interger ref id of container

Definition at line 387 of file class.ilRepUtilGUI.php.

    {
        $tpl = $this->tpl;
        $tree = $this->tree;
        $lng = $this->lng;
        
        $objects = $tree->getSavedNodeData($a_ref_id);
        
        if (count($objects) == 0) {
            ilUtil::sendInfo($lng->txt("msg_trash_empty"));
            return;
        }
        include_once("./Services/Repository/classes/class.ilTrashTableGUI.php");
        $ttab = new ilTrashTableGUI($this->parent_gui, "trash");
        $ttab->setData($objects);
        
        $tpl->setContent($ttab->getHTML());
    }

References $lng, $tpl, $tree, and ilUtil\sendInfo().

Here is the call graph for this function:

Field Documentation

◆ $access

ilRepUtilGUI::$access

protected

Definition at line 45 of file class.ilRepUtilGUI.php.

Referenced by handleMultiReferences().

◆ $ctrl

ilRepUtilGUI::$ctrl

protected

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

Referenced by confirmRemoveFromSystemObject(), and showDeleteConfirmation().

◆ $lng

ilRepUtilGUI::$lng

protected

Definition at line 20 of file class.ilRepUtilGUI.php.

Referenced by confirmRemoveFromSystemObject(), deleteObjects(), handleMultiReferences(), removeObjectsFromSystem(), restoreObjects(), showDeleteConfirmation(), and showTrashTable().

◆ $logger

ilRepUtilGUI::$logger = null

private

Definition at line 56 of file class.ilRepUtilGUI.php.

Referenced by executeCommand().

◆ $obj_definition

ilRepUtilGUI::$obj_definition

protected

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

Referenced by confirmRemoveFromSystemObject(), and showDeleteConfirmation().

◆ $settings

ilRepUtilGUI::$settings

protected

Definition at line 25 of file class.ilRepUtilGUI.php.

Referenced by deleteObjects(), and showDeleteConfirmation().

◆ $tpl

ilRepUtilGUI::$tpl

protected

Definition at line 35 of file class.ilRepUtilGUI.php.

Referenced by confirmRemoveFromSystemObject(), handleMultiReferences(), showDeleteConfirmation(), and showTrashTable().

◆ $tree

ilRepUtilGUI::$tree

protected

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

Referenced by buildPath(), handleMultiReferences(), and showTrashTable().

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

Services/Repository/classes/class.ilRepUtilGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildPath()

◆ cancel()

◆ confirmRemoveFromSystemObject()

◆ deleteObjects()

◆ doRestoreToNewLocation()

◆ executeCommand()

◆ handleMultiReferences()

◆ initFormTrashTargetLocation()

◆ removeObjectsFromSystem()

◆ restoreObjects()

◆ restoreToNewLocation()

◆ showDeleteConfirmation()

◆ showTrashTable()

Field Documentation

◆ $access

◆ $ctrl

◆ $lng

◆ $logger

◆ $obj_definition

◆ $settings

◆ $tpl

◆ $tree