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

Collaboration diagram for ilObjStudyProgrammeTreeGUI:

Public Member Functions
	__construct (ilGlobalTemplateInterface $tpl, ilCtrl $ilCtrl, ilAccess $ilAccess, ilToolbarGUI $ilToolbar, ilLanguage $lng, ilComponentLogger $ilLog, ILIAS $ilias, ilSetting $ilSetting, ilTree $ilTree, ilRbacAdmin $rbacadmin, ILIAS\HTTP\Wrapper\WrapperFactory $http_wrapper, ILIAS\Refinery\Factory $refinery)

	setRefId (int $ref_id)

	executeCommand ()
	Execute GUI-commands If there is a async request the response is sent as a json string. More...

Protected Member Functions
	initTree ()
	Initialize Tree Creates tree instance and set tree configuration. More...

	view ()
	Display the tree view. More...

	cancel ()
	Cancel operation. More...

	saveTreeOrder ()
	Saves tree node order Data is json encoded from the jstree component. More...

	createNewLeaf ()
	Creates a new leaf Currently only course references can be created. More...

	getContainerSelectionExplorer (bool $convert_to_string=true)
	Initialize the Course Explorer for creating a leaf. More...

	getCreationForm ()
	Returns the async creation form for StudyProgrammes. More...

	create ()
	Generates the modal window content for the creation form of nodes or leafs If there are already StudyProgramme-nodes in the parent, leaf creation is disabled and if there are already leafs, nodes can't be created. More...

	delete ()
	Show to delete confirmation dialog for objects in the tree. More...

	confirmedDelete ()
	Deletes a node or a leaf in the tree. More...

	cancelDelete ()
	Cancel deletion Return a json string for the async handling. More...

	initAsyncUIElements ()
	Initializes all elements used for async-interaction Adds HTML-skeleton for the bootstrap modal dialog, the notification mechanism and the Selection container. More...

	getToolbar ()
	Setup the toolbar. More...

	checkAccess (string $permission, int $ref_id=null)
	Checks permission of current tree or certain child of it. More...

	checkAccessOrFail (string $permission, int $ref_id=null)
	Checks permission of a object and throws an exception if they are not granted. More...

Protected Attributes
ilGlobalTemplateInterface	$tpl

ilCtrl	$ctrl

ilAccessHandler	$access

ilToolbarGUI	$toolbar

ilLanguage	$lng

ilComponentLogger	$log

Ilias	$ilias

ilSetting	$ilSetting

ilTree	$ilTree

ilRbacAdmin	$rbacadmin

ILIAS HTTP Wrapper WrapperFactory	$http_wrapper

ILIAS Refinery Factory	$refinery

string	$modal_id
	CSS-ID of the modal windows. More...

ilAsyncOutputHandler	$async_output_handler

int	$ref_id
	Ref-ID of the object. More...

ilObjStudyProgrammeTreeExplorerGUI	$tree

ilObjStudyProgramme	$object

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 Class ilObjStudyProgrammeTreeGUI Generates the manage view for ilTrainingProgramme-Repository objects. Handles all the async requests.

Author: Michael Herren mh@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeTreeGUI::__construct	(	ilGlobalTemplateInterface	$tpl,
		ilCtrl	$ilCtrl,
		ilAccess	$ilAccess,
		ilToolbarGUI	$ilToolbar,
		ilLanguage	$lng,
		ilComponentLogger	$ilLog,
		ILIAS	$ilias,
		ilSetting	$ilSetting,
		ilTree	$ilTree,
		ilRbacAdmin	$rbacadmin,
		ILIAS\HTTP\Wrapper\WrapperFactory	$http_wrapper,
		ILIAS\Refinery\Factory	$refinery
	)

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

References $http_wrapper, $ilias, $ilSetting, $ilTree, $lng, $rbacadmin, $refinery, $tpl, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilLanguage\loadLanguageModule(), ILIAS\Repository\refinery(), and ILIAS\Repository\toolbar().

       {
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->access = $ilAccess;
         $this->toolbar = $ilToolbar;
         $this->log = $ilLog;
         $this->ilias = $ilias;
         $this->lng = $lng;
         $this->ilSetting = $ilSetting;
         $this->ilTree = $ilTree;
         $this->rbacadmin = $rbacadmin;
         $this->http_wrapper = $http_wrapper;
         $this->refinery = $refinery;
 
         $this->modal_id = "tree_modal";
         $this->async_output_handler = new ilAsyncOutputHandler();
 
         $lng->loadLanguageModule("prg");
     }

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilObjStudyProgrammeTreeGUI::cancel ( )

protected

Cancel operation.

Definition at line 166 of file class.ilObjStudyProgrammeTreeGUI.php.

References ilAsyncOutputHandler\encodeAsyncResponse().

                                : string
     {
         return ilAsyncOutputHandler::encodeAsyncResponse();
     }

Here is the call graph for this function:

◆ cancelDelete()

ilObjStudyProgrammeTreeGUI::cancelDelete ( )

protected

Cancel deletion Return a json string for the async handling.

Definition at line 525 of file class.ilObjStudyProgrammeTreeGUI.php.

References ilAsyncOutputHandler\encodeAsyncResponse().

                                      : string
     {
         return ilAsyncOutputHandler::encodeAsyncResponse();
     }

Here is the call graph for this function:

◆ checkAccess()

ilObjStudyProgrammeTreeGUI::checkAccess	(	string	$permission,
		int	$ref_id = `null`
	)

protected

Checks permission of current tree or certain child of it.

Definition at line 589 of file class.ilObjStudyProgrammeTreeGUI.php.

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

Referenced by checkAccessOrFail(), and confirmedDelete().

                                                                           : bool
     {
         if (is_null($ref_id)) {
             $ref_id = $this->ref_id;
         }
         return $this->access->checkAccess($permission, '', $ref_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessOrFail()

ilObjStudyProgrammeTreeGUI::checkAccessOrFail	(	string	$permission,
		int	$ref_id = `null`
	)

protected

Checks permission of a object and throws an exception if they are not granted.

Exceptions

ilException

Definition at line 602 of file class.ilObjStudyProgrammeTreeGUI.php.

References checkAccess().

Referenced by confirmedDelete(), create(), createNewLeaf(), delete(), and saveTreeOrder().

                                                                                 : void
     {
         if (!$this->checkAccess($permission, $ref_id)) {
             throw new ilException("You have no permission for " . $permission . " Object with ref_id " . $ref_id . "!");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmedDelete()

ilObjStudyProgrammeTreeGUI::confirmedDelete ( )

protected

Deletes a node or a leaf in the tree.

Exceptions

ilException

Definition at line 452 of file class.ilObjStudyProgrammeTreeGUI.php.

References $id, checkAccess(), checkAccessOrFail(), ilRepUtil\deleteObjects(), ilAsyncOutputHandler\encodeAsyncResponse(), ilObjStudyProgramme\getAllChildren(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilObjectFactoryWrapper\singleton().

                                         : string
     {
         $this->checkAccessOrFail("delete");
 
         if (
             (!$this->http_wrapper->post()->has("id") || !$this->http_wrapper->post()->has("item_ref_id")) &&
             is_array($this->http_wrapper->post()->retrieve(
                 "id[]",
                 $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
             ))
         ) {
             throw new ilException("No item select for deletion!");
         }
 
         $ids = $this->http_wrapper->post()->retrieve(
             "id",
             $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int())
         );
         $current_node = $this->http_wrapper->post()->retrieve("item_ref_id", $this->refinery->kindlyTo()->int());
         $result = true;
         $msg = '';
 
         foreach ($ids as $id) {
             $obj = ilObjectFactoryWrapper::singleton()->getInstanceByRefId($id);
 
             $not_parent_of_current = true;
             $not_root = true;
 
             // do some additional validation if it is a StudyProgramme
             if ($obj instanceof ilObjStudyProgramme) {
 
                 //check if you are not deleting a parent element of the current element
                 $children_of_node = ilObjStudyProgramme::getAllChildren($obj->getRefId());
                 $get_ref_ids = static function (ilObjStudyProgramme $obj): int {
                     return $obj->getRefId();
                 };
 
                 $children_ref_ids = array_map($get_ref_ids, $children_of_node);
                 $not_parent_of_current = (!in_array($current_node, $children_ref_ids));
 
                 $not_root = ($obj->getRoot() != null);// TODO PHP8-REVIEW This is always true
             }
 
             if (
                 $current_node != $id &&
                 $not_root &&
                 $not_parent_of_current &&
                 $this->checkAccess('delete', $obj->getRefId())
             ) {
                 ilRepUtil::deleteObjects(0, [$id]);
 
                 // deletes the tree-open-node-session storage
                 if (isset($children_of_node)) {
                     $this->tree->closeCertainNode($id);
                     foreach ($children_of_node as $child) {
                         $this->tree->closeCertainNode($child->getRefId());
                     }
                 }
 
                 $msg = $this->lng->txt("prg_deleted_safely");
             } else {
                 $msg = $this->lng->txt("prg_not_allowed_node_to_delete");
                 $result = false;
             }
         }
 
         return ilAsyncOutputHandler::encodeAsyncResponse(array('success' => $result, 'message' => $msg));
     }

Here is the call graph for this function:

◆ create()

ilObjStudyProgrammeTreeGUI::create ( )

protected

Generates the modal window content for the creation form of nodes or leafs If there are already StudyProgramme-nodes in the parent, leaf creation is disabled and if there are already leafs, nodes can't be created.

Exceptions

ilException

Definition at line 348 of file class.ilObjStudyProgrammeTreeGUI.php.

References checkAccessOrFail(), ilAccordionGUI\FIRST_OPEN, getContainerSelectionExplorer(), getCreationForm(), ilUtil\getSystemMessageHTML(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilObjectFactoryWrapper\singleton().

                                : void
     {
         $parent_id = null;
         if ($this->http_wrapper->query()->has("ref_id")) {
             $parent_id = $this->http_wrapper->query()->retrieve("ref_id", $this->refinery->kindlyTo()->int());
         }
         $this->checkAccessOrFail('create', $parent_id);
 
         $parent = ilObjectFactoryWrapper::singleton()->getInstanceByRefId($parent_id);// TODO PHP8-REVIEW `$parent_id` is NULL, an `int` is expected
         $accordion = new ilAccordionGUI();
 
         $added_slides = 0;
         $content = "";
         if ($parent instanceof ilObjStudyProgramme) {
             // only allow adding new StudyProgramme-Node if there are no lp-children
             if (!$parent->hasLPChildren()) {
                 $content_new_node = $this->getCreationForm()->getHTML();
                 $accordion->addItem($this->lng->txt('prg_create_new_node'), $content_new_node);
                 $added_slides++;
             }
 
             /* only allow adding new LP-Children if there are no other StudyProgrammes
              * AND creating crs references is activated in administration
              */
             if (!$parent->hasChildren() && $this->ilSetting->get("obj_dis_creation_crsr") === "") {
                 $content_new_leaf = ilUtil::getSystemMessageHTML(
                     $this->lng->txt('prg_please_select_a_course_for_creating_a_leaf')
                 );
                 $content_new_leaf .= $this->getContainerSelectionExplorer();
 
                 $accordion->addItem($this->lng->txt('prg_create_new_leaf'), $content_new_leaf);
                 $added_slides++;
             }
 
             if ($added_slides === 1) {
                 $accordion->setBehaviour(ilAccordionGUI::FIRST_OPEN);
             }
 
             $content = $accordion->getHTML(true);
         }
 
         // creating modal window output
         $this->async_output_handler->setHeading($this->lng->txt("prg_async_" . $this->ctrl->getCmd()));
         $this->async_output_handler->setContent($content);
         $this->async_output_handler->terminate();
     }

Here is the call graph for this function:

◆ createNewLeaf()

ilObjStudyProgrammeTreeGUI::createNewLeaf ( )

protected

Creates a new leaf Currently only course references can be created.

Exceptions

ilException

Definition at line 258 of file class.ilObjStudyProgrammeTreeGUI.php.

References $target_id, ilObject\_lookupObjectId(), checkAccessOrFail(), ilAsyncOutputHandler\encodeAsyncResponse(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ilContainerReference\TITLE_TYPE_REUSE.

                                       : string
     {
         $this->checkAccessOrFail('create', $this->http_wrapper->post()->retrieve("parent_id", $this->refinery->kindlyTo()->int()));
 
         if (
             $this->http_wrapper->post()->has("target_id") &&
             $this->http_wrapper->post()->has("type") &&
             $this->http_wrapper->post()->has("parent_id")
         ) {
             $target_id = $this->http_wrapper->post()->retrieve("target_id", $this->refinery->kindlyTo()->int());
             $parent_id = $this->http_wrapper->post()->retrieve("parent_id", $this->refinery->kindlyTo()->int());
 
             // TODO: more generic way for implementing different type of leafs
             $course_ref = new ilObjCourseReference();
             $course_ref->setTitleType(ilContainerReference::TITLE_TYPE_REUSE);
             $course_ref->setTargetRefId($target_id);
 
             $course_ref->create();
             $course_ref->createReference();
 
             $course_ref->putInTree($parent_id);
 
             // This is how it's done in ILIAS. If you set the target ID before the creation, it won't work
             $course_ref->setTargetId(ilObject::_lookupObjectId($target_id));
             $course_ref->update();
         }
 
         return ilAsyncOutputHandler::encodeAsyncResponse(
             ['success' => true, 'message' => $this->lng->txt('prg_added_course_ref_successful')]
         );
     }

Here is the call graph for this function:

◆ delete()

ilObjStudyProgrammeTreeGUI::delete ( )

protected

Show to delete confirmation dialog for objects in the tree.

Exceptions

ilException

Definition at line 400 of file class.ilObjStudyProgrammeTreeGUI.php.

References $type, ilObject\_getIcon(), ilObject\_lookupObjectId(), ilObject\_lookupType(), checkAccessOrFail(), ILIAS\Repository\ctrl(), ilObjectFactory\getClassByType(), ILIAS\Repository\lng(), and ILIAS\Repository\refinery().

                                : void
     {
         $this->checkAccessOrFail("delete");
 
         if (!$this->http_wrapper->query()->has("ref_id") || !$this->http_wrapper->query()->has("item_ref_id")) {
             throw new ilException("Nothing to delete!");
         }
 
         $element_ref_id = $this->http_wrapper->query()->retrieve("ref_id", $this->refinery->kindlyTo()->int());
 
         $cgui = new ilConfirmationGUI();
 
         $msg = $this->lng->txt("info_delete_sure");
         if (!$this->ilSetting->get('enable_trash')) {
             $msg .= "<br/>" . $this->lng->txt("info_delete_warning_no_trash");
         }
         $cgui->setHeaderText($msg);
         $cgui->setFormAction($this->ctrl->getFormAction($this, 'confirmedDelete', '', true));
         $cgui->setCancel($this->lng->txt("cancel"), "cancelDelete");
         $cgui->setConfirm($this->lng->txt("confirm"), "confirmedDelete");
         $cgui->setFormName('async_form');
 
         $obj_id = ilObject::_lookupObjectId((int) $element_ref_id);
         $type = ilObject::_lookupType($obj_id);
         $title = call_user_func(array(ilObjectFactory::getClassByType($type),'_lookupTitle'), $obj_id);
         $alt = $this->lng->txt("icon") . " " . $this->lng->txt("obj_" . $type);
 
         $cgui->addItem(
             "id[]",
             (string)$element_ref_id,
             $title,
             ilObject::_getIcon($obj_id, "small", $type),
             $alt
         );
         $cgui->addHiddenItem(
             'item_ref_id',
             $this->http_wrapper->query()->retrieve("item_ref_id", $this->refinery->kindlyTo()->string())
         );
 
         $content = $cgui->getHTML();
 
         // creating the modal window output
         $this->async_output_handler->setHeading($msg);
         $this->async_output_handler->setContent($content);
         $this->async_output_handler->terminate();
     }

Here is the call graph for this function:

◆ executeCommand()

ilObjStudyProgrammeTreeGUI::executeCommand ( )

Execute GUI-commands If there is a async request the response is sent as a json string.

Exceptions

ilException

Definition at line 114 of file class.ilObjStudyProgrammeTreeGUI.php.

References ILIAS\Repository\ctrl(), exit, getToolbar(), ilAsyncOutputHandler\handleAsyncOutput(), and initTree().

                                     : void
     {
         $this->initTree();
         $cmd = $this->ctrl->getCmd();
 
         $this->getToolbar();
 
         if ($cmd === "" || $cmd === null) {
             $cmd = "view";
         }
 
         // handles tree commands ("openNode", "closeNode", "getNodeAsync")
         if ($this->tree->handleCommand()) {
             exit();
         }
 
         switch ($cmd) {
             case "view":
             case "create":
             case "save":
             case "cancel":
             case "delete":
             case "confirmedDelete":
             case "cancelDelete":
             case "getContainerSelectionExplorer":
             case "saveTreeOrder":
             case "createNewLeaf":
 
                 $content = $this->$cmd();
                 break;
             default:
                 throw new ilException("ilObjStudyProgrammeTreeGUI: " .
                     "Command not supported: $cmd");
         }
 
         ilAsyncOutputHandler::handleAsyncOutput($content);
     }

Here is the call graph for this function:

◆ getContainerSelectionExplorer()

ilObjStudyProgrammeTreeGUI::getContainerSelectionExplorer ( bool $convert_to_string = true )

protected

Initialize the Course Explorer for creating a leaf.

Parameters

bool $convert_to_string If set to true, the getOutput function is already called

Returns: ilAsyncContainerSelectionExplorer|string

Definition at line 297 of file class.ilObjStudyProgrammeTreeGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\refinery(), ROOT_FOLDER_ID, and ilExplorer\setId().

Referenced by create().

     {
         $create_leaf_form = new ilAsyncContainerSelectionExplorer(
             rawurldecode($this->ctrl->getLinkTarget($this, 'createNewLeaf', '', true)),
             $this->refinery,
             $this->http_wrapper->query()
         );
         $create_leaf_form->setId("select_course_explorer");
 
         $ref_expand = ROOT_FOLDER_ID;
         if ($this->http_wrapper->query()->has("ref_repexpand")) {
             $ref_expand = $this->http_wrapper->query()->retrieve("ref_repexpand", $this->refinery->kindlyTo()->int());
         }
 
         $create_leaf_form->setExpand($ref_expand);
         $create_leaf_form->setExpandTarget($this->ctrl->getLinkTarget($this, 'getContainerSelectionExplorer'));
         $create_leaf_form->setAsynchExpanding(true);
         $create_leaf_form->setTargetGet('target_id');
         $create_leaf_form->setFrameTarget("_self");
         $create_leaf_form->setClickable('crs', true);
         $create_leaf_form->setTargetType('crs');
         $create_leaf_form->setOutput(0);
 
         if ($convert_to_string) {
             return $create_leaf_form->getOutput();
         }
 
         return $create_leaf_form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCreationForm()

ilObjStudyProgrammeTreeGUI::getCreationForm ( )

protected

Returns the async creation form for StudyProgrammes.

Definition at line 330 of file class.ilObjStudyProgrammeTreeGUI.php.

References ILIAS\Repository\ctrl().

Referenced by create().

                                         : ilAsyncPropertyFormGUI
     {
         $tmp_obj = new ilObjStudyProgrammeGUI();
 
         $create_node_form = $tmp_obj->getAsyncCreationForm();
         $create_node_form->setTitle("");
         $this->ctrl->setParameterByClass("ilobjstudyprogrammegui", "new_type", "prg");
         $create_node_form->setFormAction($this->ctrl->getFormActionByClass("ilobjstudyprogrammegui", "save"));
 
         return $create_node_form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getToolbar()

ilObjStudyProgrammeTreeGUI::getToolbar ( )

protected

Setup the toolbar.

Definition at line 568 of file class.ilObjStudyProgrammeTreeGUI.php.

References ilLinkButton\getInstance(), and ILIAS\Repository\toolbar().

Referenced by executeCommand().

                                    : void
     {
         $save_order_btn = ilLinkButton::getInstance();
         $save_order_btn->setId('save_order_button');
         $save_order_btn->setUrl("javascript:void(0);");
         $save_order_btn->setOnClick("$('body').trigger('study_programme-save_order');");
         $save_order_btn->setCaption('prg_save_tree_order');
 
         $cancel_order_btn = ilLinkButton::getInstance();
         $cancel_order_btn->setId('cancel_order_button');
         $cancel_order_btn->setUrl("javascript:void(0);");
         $cancel_order_btn->setOnClick("$('body').trigger('study_programme-cancel_order');");
         $cancel_order_btn->setCaption('prg_cancel_tree_order');
 
         $this->toolbar->addButtonInstance($save_order_btn);
         $this->toolbar->addButtonInstance($cancel_order_btn);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initAsyncUIElements()

ilObjStudyProgrammeTreeGUI::initAsyncUIElements ( )

protected

Initializes all elements used for async-interaction Adds HTML-skeleton for the bootstrap modal dialog, the notification mechanism and the Selection container.

Definition at line 534 of file class.ilObjStudyProgrammeTreeGUI.php.

References ilAsyncContainerSelectionExplorer\addJavascript(), ilAsyncPropertyFormGUI\addJavaScript(), ilAccordionGUI\addJavaScript(), ILIAS\Repository\ctrl(), ilModalGUI\getInstance(), ilAsyncContainerSelectionExplorer\initJs(), ILIAS\Repository\refinery(), and ilModalGUI\TYPE_LARGE.

Referenced by view().

                                             : string
     {
         // add  js files
         ilAccordionGUI::addJavaScript();
         ilAsyncPropertyFormGUI::addJavaScript(true);
         ilAsyncContainerSelectionExplorer::addJavascript();
 
         // add bootstrap modal
         $settings_modal = ilModalGUI::getInstance();
         $settings_modal->setId($this->modal_id);
         $settings_modal->setType(ilModalGUI::TYPE_LARGE);
         $this->tpl->addOnLoadCode('$("#' . $this->modal_id . '").study_programme_modal();');
 
         $content = $settings_modal->getHTML();
 
         // init js notifications
         $notifications = new ilAsyncNotifications();
         $notifications->addJsConfig('events', array('success' => array('study_programme-show_success')));
         $notifications->initJs();
 
         // init tree selection explorer
         $async_explorer = new ilAsyncContainerSelectionExplorer(
             rawurldecode($this->ctrl->getLinkTarget($this, 'createNewLeaf', '', true)),
             $this->refinery,
             $this->http_wrapper->query()
         );
         $async_explorer->initJs();
 
         return $content;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initTree()

ilObjStudyProgrammeTreeGUI::initTree ( )

protected

Initialize Tree Creates tree instance and set tree configuration.

Definition at line 98 of file class.ilObjStudyProgrammeTreeGUI.php.

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

                                  : void
     {
         $this->tree = new ilObjStudyProgrammeTreeExplorerGUI($this->ref_id, $this->modal_id, "prg_tree", $this, 'view');
 
         $js_url = rawurldecode($this->ctrl->getLinkTarget($this, 'saveTreeOrder', '', true));
         $this->tree->addJsConf('save_tree_url', $js_url);
         $this->tree->addJsConf('save_button_id', 'save_order_button');
         $this->tree->addJsConf('cancel_button_id', 'cancel_order_button');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveTreeOrder()

ilObjStudyProgrammeTreeGUI::saveTreeOrder ( )

protected

Saves tree node order Data is json encoded from the jstree component.

Exceptions

ilException

Definition at line 177 of file class.ilObjStudyProgrammeTreeGUI.php.

References $id, $ref_id, ilContainerSorting\_getInstance(), ilObject\_lookupObjectId(), checkAccessOrFail(), ilAsyncOutputHandler\encodeAsyncResponse(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilObjectFactoryWrapper\singleton(), and ilUtil\stripSlashes().

                                       : string
     {
         $this->checkAccessOrFail('write');
 
         $tree = "";
         if ($this->http_wrapper->post()->has("tree")) {
             $tree = $this->http_wrapper->post()->retrieve("tree", $this->refinery->kindlyTo()->string());
         }
         $treeAsJson = ilUtil::stripSlashes($tree);
         $treeData = json_decode($treeAsJson, false, 512, JSON_THROW_ON_ERROR);
 
         if (!is_array($treeData) || [] === $treeData) {
             throw new ilStudyProgrammeTreeException("There is no tree data to save!");
         }
 
         // saves order recursive
         $this->storeTreeOrder($treeData);
 
         return ilAsyncOutputHandler::encodeAsyncResponse(
             ['success' => true, 'message' => $this->lng->txt('prg_saved_order_successful')]
         );
     }

Here is the call graph for this function:

◆ setRefId()

ilObjStudyProgrammeTreeGUI::setRefId ( int $ref_id )

Definition at line 89 of file class.ilObjStudyProgrammeTreeGUI.php.

References $ref_id.

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

◆ view()

ilObjStudyProgrammeTreeGUI::view ( )

protected

Display the tree view.

Definition at line 155 of file class.ilObjStudyProgrammeTreeGUI.php.

References initAsyncUIElements().

                              : string
     {
         $output = $this->tree->getHTML();
         $output .= $this->initAsyncUIElements();
 
         return $output;
     }

Here is the call graph for this function:

ilComponentLogger ilObjStudyProgrammeTreeGUI::$log

protected

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

◆ $modal_id

string ilObjStudyProgrammeTreeGUI::$modal_id

protected

CSS-ID of the modal windows.

Definition at line 46 of file class.ilObjStudyProgrammeTreeGUI.php.

◆ $object

ilObjStudyProgramme ilObjStudyProgrammeTreeGUI::$object

protected

Definition at line 54 of file class.ilObjStudyProgrammeTreeGUI.php.

◆ $rbacadmin

ilRbacAdmin ilObjStudyProgrammeTreeGUI::$rbacadmin

protected

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

Referenced by __construct().

◆ $ref_id

int ilObjStudyProgrammeTreeGUI::$ref_id

protected

Ref-ID of the object.

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

Referenced by checkAccess(), saveTreeOrder(), and setRefId().

◆ $refinery

ILIAS Refinery Factory ilObjStudyProgrammeTreeGUI::$refinery

protected

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

Referenced by __construct().

◆ $toolbar

ilToolbarGUI ilObjStudyProgrammeTreeGUI::$toolbar

protected

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

◆ $tpl

ilGlobalTemplateInterface ilObjStudyProgrammeTreeGUI::$tpl

protected

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

Referenced by __construct().

◆ $tree

ilObjStudyProgrammeTreeExplorerGUI ilObjStudyProgrammeTreeGUI::$tree

protected

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

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

Modules/StudyProgramme/classes/class.ilObjStudyProgrammeTreeGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancel()

◆ cancelDelete()

◆ checkAccess()

◆ checkAccessOrFail()

◆ confirmedDelete()

◆ create()

◆ createNewLeaf()

◆ delete()

◆ executeCommand()

◆ getContainerSelectionExplorer()

◆ getCreationForm()

◆ getToolbar()

◆ initAsyncUIElements()

◆ initTree()

◆ saveTreeOrder()

◆ setRefId()

◆ view()

Field Documentation

◆ $access

◆ $async_output_handler

◆ $ctrl

◆ $http_wrapper

◆ $ilias

◆ $ilSetting

◆ $ilTree

◆ $lng

◆ $log

◆ $modal_id

◆ $object

◆ $rbacadmin

◆ $ref_id

◆ $refinery

◆ $toolbar

◆ $tpl

◆ $tree