Class ilObjStudyProgrammeTreeGUI Generates the manage view for ilTrainingProgramme-Repository objects. More...

Collaboration diagram for ilObjStudyProgrammeTreeGUI:

Public Member Functions
	__construct ($a_ref_id)

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

Data Fields
	$ctrl

	$tpl

	$object

	$ilias

	$lng

	$toolbar

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...

	storeTreeOrder ($nodes, $container_sorting=null, $parent_ref_id=null)
	Recursive function for saving the tree order. More...

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

	getContainerSelectionExplorer ($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 the 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 ($permission, $ref_id=null)
	Checks permission of current tree or certain child of it. More...

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

Protected Attributes
	$access

	$locator

	$log

	$ref_id

	$tree

	$modal_id

	$async_output_handler

Detailed Description

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 20 of file class.ilObjStudyProgrammeTreeGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeTreeGUI::__construct ( $a_ref_id )

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

                                               {
                global $tpl, $ilCtrl, $ilAccess, $ilToolbar, $ilLocator, $tree, $lng, $ilLog, $ilias;
 
                $this->ref_id = $a_ref_id;
                $this->tpl = $tpl;
                $this->ctrl = $ilCtrl;
                $this->access = $ilAccess;
                $this->locator = $ilLocator;
                $this->tree = $tree;
                $this->toolbar = $ilToolbar;
                $this->log = $ilLog;
                $this->ilias = $ilias;
                $this->lng = $lng;
                $this->modal_id = "tree_modal";
                $this->async_output_handler = new ilAsyncOutputHandler();
 
                $this->initTree();
 
                $lng->loadLanguageModule("prg");
        }

References $ilCtrl, $ilias, $ilLog, $lng, $tpl, $tree, and initTree().

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilObjStudyProgrammeTreeGUI::cancel ( )

protected

Cancel operation.

Returns: string

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

                                    {
                return ilAsyncOutputHandler::encodeAsyncResponse();
        }

References ilAsyncOutputHandler\encodeAsyncResponse().

Here is the call graph for this function:

◆ cancelDelete()

ilObjStudyProgrammeTreeGUI::cancelDelete ( )

protected

Cancel deletion Return a json string for the async handling.

Returns: string

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

                                          {
                return ilAsyncOutputHandler::encodeAsyncResponse();
        }

References ilAsyncOutputHandler\encodeAsyncResponse().

Here is the call graph for this function:

◆ checkAccess()

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

protected

Checks permission of current tree or certain child of it.

Parameters

string	$permission
null	$ref_id

Returns: bool

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

                                                                    {
                $ref_id = ($ref_id === null)? $this->ref_id : $ref_id;
                $checker = $this->access->checkAccess($permission, '', $ref_id);
 
                return $checker;
        }

References $ref_id.

Referenced by checkAccessOrFail(), and confirmedDelete().

Here is the caller graph for this function:

◆ checkAccessOrFail()

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

protected

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

Parameters

string	$permission
null	$ref_id

Exceptions

ilException

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

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

References $ref_id, and checkAccess().

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

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.

Returns: string

Exceptions

ilException

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

                                             {
                $this->checkAccessOrFail("delete");
 
                if(!isset($_POST['id'], $_POST['item_ref_id']) && is_array($_POST['id'])) {
                        throw new ilException("No item select for deletion!");
                }
 
                $ids = $_POST['id'];
                $current_node = (int) $_POST['item_ref_id'];
                $result = true;
 
                foreach($ids as $id) {
                        $obj = ilObjectFactoryWrapper::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 = function ($obj) { 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);
                        }
 
                        if($current_node != $id && $not_root && $not_parent_of_current && $this->checkAccess('delete', $obj->getRefId())) {
 
                                ilRepUtil::deleteObjects(null, $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));
        }

References $_POST, $result, checkAccess(), checkAccessOrFail(), ilRepUtil\deleteObjects(), ilAsyncOutputHandler\encodeAsyncResponse(), ilObjStudyProgramme\getAllChildren(), and ilObjectFactoryWrapper\getInstanceByRefId().

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 341 of file class.ilObjStudyProgrammeTreeGUI.php.

                                    {
                $parent_id = (isset($_GET['ref_id']))? (int) $_GET['ref_id'] : null;
                $this->checkAccessOrFail('create', $parent_id);
 
                $parent = ilObjectFactoryWrapper::singleton()->getInstanceByRefId($parent_id);
                $accordion = new ilAccordionGUI();
 
                $added_slides = 0;
                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
                        if(!$parent->hasChildren()) {
                                $content_new_leaf = $this->tpl->getMessageHTML($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();
                }
 
                // 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();
        }

References $_GET, checkAccessOrFail(), ilAccordionGUI\FIRST_OPEN, getContainerSelectionExplorer(), getCreationForm(), and ilObjectFactoryWrapper\singleton().

Here is the call graph for this function:

◆ createNewLeaf()

ilObjStudyProgrammeTreeGUI::createNewLeaf ( )

protected

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

Returns: string

Exceptions

ilException

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

                                           {
                $this->checkAccessOrFail('create', (int) $_POST['parent_id']);
 
                if(isset($_POST['target_id'], $_POST['type'], $_POST['parent_id'])) {
                        $target_id = (int) $_POST['target_id'];
                        $parent_id = (int) $_POST['parent_id'];
 
                        // TODO: more generic way for implementing different type of leafs
                        $course_ref = new ilObjCourseReference();
                        $course_ref->setTitleType(ilObjCourseReference::TITLE_TYPE_REUSE);
                        $course_ref->setTargetRefId($target_id);
 
                        $course_ref->create();
                        $course_ref->createReference();
 
                        $course_ref->putInTree($parent_id);
 
                        // This is how its 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(array('success'=>true, 'message'=>$this->lng->txt('prg_added_course_ref_successful')));
        }

References $_POST, $target_id, ilObject\_lookupObjectId(), checkAccessOrFail(), ilAsyncOutputHandler\encodeAsyncResponse(), and ilContainerReference\TITLE_TYPE_REUSE.

Here is the call graph for this function:

◆ delete()

ilObjStudyProgrammeTreeGUI::delete ( )

protected

Show the delete confirmation dialog for objects in the tree.

Exceptions

ilException

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

                                    {
                global $ilSetting;
 
                $this->checkAccessOrFail("delete");
 
                if(!isset($_GET['ref_id'], $_GET['item_ref_id'])) {
                        throw new ilException("Nothing to delete!");
                }
 
                $element_ref_id = (int) $_GET['ref_id'];
 
                $cgui = new ilConfirmationGUI();
 
                $msg = $this->lng->txt("info_delete_sure");
 
                if (!$ilSetting->get('enable_trash'))
                {
                        $msg .= "<br/>".$this->lng->txt("info_delete_warning_no_trash");
                }
                $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($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[]", $element_ref_id, $title,
                        ilObject::_getIcon($obj_id, "small", $type),
                        $alt);
                $cgui->addHiddenItem('item_ref_id', $_GET['item_ref_id']);
 
                $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();
        }

References $_GET, $ilSetting, ilObject\_getIcon(), ilObject\_lookupObjectId(), ilObject\_lookupType(), checkAccessOrFail(), and ilObjectFactory\getClassByType().

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 129 of file class.ilObjStudyProgrammeTreeGUI.php.

                                         {
                $cmd = $this->ctrl->getCmd();
 
                $this->getToolbar();
 
                if ($cmd == "") {
                        $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);
        }

References $cmd, exit, getToolbar(), and ilAsyncOutputHandler\handleAsyncOutput().

Here is the call graph for this function:

◆ getContainerSelectionExplorer()

ilObjStudyProgrammeTreeGUI::getContainerSelectionExplorer ( $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 293 of file class.ilObjStudyProgrammeTreeGUI.php.

                                                                                    {
                $create_leaf_form = new ilAsyncContainerSelectionExplorer(rawurldecode($this->ctrl->getLinkTarget($this, 'createNewLeaf', '', true, false)));
                $create_leaf_form->setId("select_course_explorer");
 
                $ref_expand = ROOT_FOLDER_ID;
                if(isset($_GET['ref_repexpand'])) {
                        $ref_expand = (int) $_GET['ref_repexpand'];
                }
 
                $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();
                else
                        return $create_leaf_form;
        }

References $_GET.

Referenced by create().

Here is the caller graph for this function:

◆ getCreationForm()

ilObjStudyProgrammeTreeGUI::getCreationForm ( )

protected

Returns the async creation form for StudyProgrammes.

Returns: ilAsyncPropertyFormGUI

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

                                             {
                $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;
        }

Referenced by create().

Here is the caller graph for this function:

◆ getToolbar()

ilObjStudyProgrammeTreeGUI::getToolbar ( )

protected

Setup the toolbar.

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

                                        {
                $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);
        }

References ilLinkButton\getInstance().

Referenced by executeCommand().

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.

Returns: string

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

                                                 {
                // 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, false)));
                $async_explorer->initJs();
 
                return $content;
        }

References ilAsyncPropertyFormGUI\addJavaScript(), ilAsyncContainerSelectionExplorer\addJavascript(), ilAccordionGUI\addJavaScript(), ilModalGUI\getInstance(), and ilModalGUI\TYPE_LARGE.

Referenced by view().

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 113 of file class.ilObjStudyProgrammeTreeGUI.php.

                                      {
                $this->tree = new ilObjStudyProgrammeTreeExplorerGUI($this->ref_id, $this->modal_id, "prg_tree", $this, 'view');
 
                $js_url = rawurldecode($this->ctrl->getLinkTarget($this, 'saveTreeOrder', '', true, false));
                $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');
        }

Referenced by __construct().

Here is the caller graph for this function:

◆ saveTreeOrder()

ilObjStudyProgrammeTreeGUI::saveTreeOrder ( )

protected

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

Returns: string json string

Exceptions

ilException

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

                                           {
                $this->checkAccessOrFail('write');
                
                if(!isset($_POST['tree']) || is_null(json_decode(stripslashes($_POST['tree'])))) {
                        throw new ilStudyProgrammeTreeException("There is no tree data to save!");
                }
 
                // saves order recursive
                $this->storeTreeOrder(json_decode(stripslashes($_POST['tree'])));
 
                return ilAsyncOutputHandler::encodeAsyncResponse(array('success'=>true, 'message'=>$this->lng->txt('prg_saved_order_successful')));
        }

References $_POST, checkAccessOrFail(), ilAsyncOutputHandler\encodeAsyncResponse(), and storeTreeOrder().

Here is the call graph for this function:

◆ storeTreeOrder()

ilObjStudyProgrammeTreeGUI::storeTreeOrder	(	$nodes,
		$container_sorting = `null`,
		$parent_ref_id = `null`
	)

protected

Recursive function for saving the tree order.

Parameters

	[ilObjStudyProgramme]	$nodes
ilContainerSorting \| null	$container_sorting
int \| null	$parent_ref_id

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

                                                                                                    {
                $sorting_position = array();
                $position_count = 10;
 
                $parent_node = ($parent_ref_id === null)? ilObjectFactoryWrapper::getInstanceByRefId($this->ref_id) : ilObjectFactoryWrapper::getInstanceByRefId($parent_ref_id);
                $container_sorting = ($container_sorting === null) ? ilContainerSorting::_getInstance(ilObject::_lookupObjectId($this->ref_id)) : $container_sorting;
 
                foreach($nodes as $node) {
                        // get ref_id from json
                        $id = $node->attr->id;
                        $id = substr($id, strrpos($id, "_")+1);
 
                        $sorting_position[$id] = $position_count;
                        $position_count+= 10;
 
                        $node_obj = ilObjectFactoryWrapper::getInstanceByRefId($id);
                        if($node_obj instanceof ilObjStudyProgramme) {
                                $node_obj->moveTo($parent_node);
                        } else {
                                // TODO: implement a method on ilObjStudyProgramme to move leafs
                                global $tree, $rbacadmin;
 
                                $tree->moveTree($node_obj->getRefId(), $parent_node->getRefId());
                                $rbacadmin->adjustMovedObjectPermissions($node_obj->getRefId(), $parent_node->getRefId());
                        }
 
                        // recursion if there are children
                        if(isset($node->children)) {
                                $this->storeTreeOrder($node->children, ilContainerSorting::_getInstance(ilObject::_lookupObjectId($id)), $id);
                        }
                }
                $container_sorting->savePost($sorting_position);
        }

References $tree, ilContainerSorting\_getInstance(), ilObject\_lookupObjectId(), ilObjectFactoryWrapper\getInstanceByRefId(), and storeTreeOrder().

Referenced by saveTreeOrder(), and storeTreeOrder().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ view()

ilObjStudyProgrammeTreeGUI::view ( )

protected

Display the tree view.

Returns: string

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

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