Basic skill template GUI class. More...

Inheritance diagram for ilBasicSkillTemplateGUI:

Collaboration diagram for ilBasicSkillTemplateGUI:

Public Member Functions
	__construct (Tree\SkillTreeNodeManager $node_manager, int $a_node_id=0, int $a_tref_id=0)

	getType ()

	initForm (string $a_mode="edit")

	setLevelHead ()

	setTabs (string $a_tab="levels")

	saveItem ()

	afterSave ()

	edit ()

	showUsage ()

	showObjects ()

	redirectToParent (bool $a_tmp_mode=false)

Public Member Functions inherited from ilBasicSkillGUI
	__construct (Tree\SkillTreeNodeManager $node_manager, int $a_node_id=0)

	getType ()

	executeCommand ()

	showProperties ()

	saveItem ()

	afterSave ()

	updateItem ()

	edit ()

	initForm (string $a_mode="edit")

	editProperties ()

	addLevel ()

	editLevel ()

	saveLevel ()

	updateLevel ()

	initLevelForm (string $a_mode="edit")

	updateLevelOrder ()

	confirmLevelDeletion ()

	deleteLevel ()

	setLevelHead ()

	setTabs (string $a_tab="levels")

	redirectToParent (bool $a_tmp_mode=false)
	Redirect to parent (identified by current node_id) More...

	showLevelResources ()

	addLevelResource ()

	saveLevelResource ()

	confirmLevelResourcesRemoval ()

	removeLevelResources ()

	saveResourceSettings ()

Public Member Functions inherited from ilSkillTreeNodeGUI
	__construct (Tree\SkillTreeNodeManager $node_manager, int $a_node_id=0)

	isInUse ()

	setParentGUI (object $a_parentgui)

	getParentGUI ()

	readNodeObject (int $a_node_id)
	Get node object instance. More...

	saveAllTitles ()

	deleteNodes ()
	Delete nodes in the hierarchy. More...

	cutItems ()
	Copy items to clipboard, then cut them from the current tree. More...

	copyItems ()
	Copy items to clipboard. More...

	cancelDelete ()

	confirmedDelete ()
	confirmed delete More...

	setSkillNodeDescription ()

	create ()
	Create skill tree node. More...

	addStatusInput (ilPropertyFormGUI $a_form)

	editProperties ()

	getPropertyValues ()
	Get property values for edit form. More...

	save ()
	Save skill tree node. More...

	afterSave ()

	update ()
	Update skill tree node. More...

	afterUpdate ()

	initForm (string $a_mode="edit")

	cancelSave ()

	redirectToParent (bool $a_tmp_mode=false)
	Redirect to parent (identified by current node_id) More...

	saveOrder ()

	insertBasicSkillClip ()

	insertSkillCategoryClip ()

	insertTemplateReferenceClip ()

	insertSkillTemplateClip ()

	insertTemplateCategoryClip ()

	setTitleIcon ()

	addUsageTab (ilTabsGUI $a_tabs)

	showUsage ()

	addObjectsTab (ilTabsGUI $a_tabs)

	showObjects ()

	exportSelectedNodes ()

Protected Attributes
ilCtrl	$ctrl

ilLanguage	$lng

ilTabsGUI	$tabs

ilGlobalTemplateInterface	$tpl

ilHelpGUI	$help

ilToolbarGUI	$toolbar

Protected Attributes inherited from ilBasicSkillGUI
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ilHelpGUI	$help

ilToolbarGUI	$toolbar

ilLanguage	$lng

Factory	$ui_fac

Renderer	$ui_ren

ServerRequestInterface	$request

int	$tref_id = 0

int	$requested_level_id = 0

int	$requested_root_id = 0

array	$requested_level_order = []

array	$requested_level_ids = []

array	$requested_resource_ids = []

array	$requested_suggested = []

array	$requested_trigger = []

Protected Attributes inherited from ilSkillTreeNodeGUI
ilCtrl	$ctrl

ilLanguage	$lng

ilLocatorGUI	$locator

ilGlobalTemplateInterface	$tpl

ilObjUser	$user

ilTree	$tree

ilPropertyFormGUI	$form

object	$parentgui

int	$tref_id = 0

Tree SkillTreeNodeManager	$skill_tree_node_manager

SkillTreeAccess	$tree_access_manager

ilSkillTreeRepository	$tree_repo

int	$skill_tree_id = 0

ilTabsGUI	$tabs

SkillAdminGUIRequest	$admin_gui_request

int	$requested_ref_id = 0

int	$requested_node_id = 0

string	$requested_backcmd = ""

int	$requested_tmpmode = 0

int	$base_skill_id = 0

array	$requested_node_ids = []

array	$requested_node_order = []

Additional Inherited Members
Data Fields inherited from ilSkillTreeNodeGUI
object	$node_object = null

bool	$in_use = false

bool	$use_checked = false

ilAccessHandler	$access

Detailed Description

Basic skill template GUI class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e ilBasicSkillTemplateGUI: ilObjSkillManagementGUI, ilObjSkillTreeGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilBasicSkillTemplateGUI::__construct	(	Tree\SkillTreeNodeManager	$node_manager,
		int	$a_node_id = `0`,
		int	$a_tref_id = `0`
	)

Definition at line 37 of file class.ilBasicSkillTemplateGUI.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

     {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->tabs = $DIC->tabs();
         $this->tpl = $DIC["tpl"];
         $this->help = $DIC["ilHelp"];
         $this->toolbar = $DIC->toolbar();
         $ilCtrl = $DIC->ctrl();
 
         $this->tref_id = $a_tref_id;
 
         $ilCtrl->saveParameter($this, array("node_id", "level_id"));
 
         parent::__construct($node_manager, $a_node_id);
     }

Here is the call graph for this function:

Member Function Documentation

◆ afterSave()

ilBasicSkillTemplateGUI::afterSave ( )

Definition at line 252 of file class.ilBasicSkillTemplateGUI.php.

References $ctrl, and ilCtrl\setParameterByClass().

                                : void
     {
         $ilCtrl = $this->ctrl;
 
         if (!$this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
             return;
         }
 
         $ilCtrl->setParameterByClass(
             "ilbasicskilltemplategui",
             "node_id",
             $this->node_object->getId()
         );
         $ilCtrl->redirectByClass("ilbasicskilltemplategui", "edit");
     }

Here is the call graph for this function:

◆ edit()

ilBasicSkillTemplateGUI::edit ( )

Definition at line 268 of file class.ilBasicSkillTemplateGUI.php.

References $ctrl, $lng, $toolbar, $tpl, ilSkillTreeNodeGUI\isInUse(), ilGlobalTemplateInterface\setContent(), setTabs(), and ilLanguage\txt().

                           : void
     {
         $tpl = $this->tpl;
         $ilToolbar = $this->toolbar;
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $this->setTabs("levels");
 
         if ($this->isInUse()) {
             $this->tpl->setOnScreenMessage('info', $lng->txt("skmg_skill_in_use"));
         } elseif ($this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
             if ($this->tref_id == 0) {
                 $ilToolbar->addButton(
                     $lng->txt("skmg_add_level"),
                     $ilCtrl->getLinkTarget($this, "addLevel")
                 );
             }
         }
 
         $table = new ilSkillLevelTableGUI(
             $this->requested_node_id,
             $this,
             "edit",
             $this->tref_id,
             $this->isInUse(),
             $this->tree_access_manager->hasManageCompetenceTemplatesPermission()
         );
         $tpl->setContent($table->getHTML());
     }

Here is the call graph for this function:

◆ getType()

ilBasicSkillTemplateGUI::getType ( )

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

                              : string
     {
         return "sktp";
     }

◆ initForm()

ilBasicSkillTemplateGUI::initForm ( string $a_mode = "edit" )

Definition at line 61 of file class.ilBasicSkillTemplateGUI.php.

References $ctrl, $lng, ILIAS\Repository\form(), ilTextAreaInputGUI\setRows(), and ilLanguage\txt().

                                                      : void
     {
         $lng = $this->lng;
         $ilCtrl = $this->ctrl;
 
         $this->form = new ilPropertyFormGUI();
 
         // title
         $ti = new ilTextInputGUI($lng->txt("title"), "title");
         $ti->setMaxLength(200);
         $ti->setSize(50);
         $ti->setRequired(true);
         $this->form->addItem($ti);
 
         // description
         $ta = new ilTextAreaInputGUI($lng->txt("description"), "description");
         $ta->setRows(5);
         $this->form->addItem($ta);
 
         // save and cancel commands
         if ($this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
             if ($a_mode == "create") {
                 $this->form->addCommandButton("save", $lng->txt("save"));
                 $this->form->addCommandButton("cancelSave", $lng->txt("cancel"));
                 $this->form->setTitle($lng->txt("skmg_create_skll"));
             } else {
                 $this->form->addCommandButton("update", $lng->txt("save"));
                 $this->form->setTitle($lng->txt("skmg_edit_skll"));
             }
         } else {
             foreach ($this->form->getItems() as $item) {
                 $item->setDisabled(true);
             }
         }
 
         $ilCtrl->setParameter($this, "node_id", $this->requested_node_id);
         $this->form->setFormAction($ilCtrl->getFormAction($this));
     }

Here is the call graph for this function:

◆ redirectToParent()

ilBasicSkillTemplateGUI::redirectToParent ( bool $a_tmp_mode = false )

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

References $ctrl, and ilCtrl\setParameterByClass().

                                                               : void
     {
         $ilCtrl = $this->ctrl;
 
         $ilCtrl->setParameterByClass("ilskillrootgui", "node_id", $this->requested_node_id);
         $ilCtrl->redirectByClass("ilskillrootgui", "listTemplates");
     }

Here is the call graph for this function:

◆ saveItem()

ilBasicSkillTemplateGUI::saveItem ( )

Definition at line 238 of file class.ilBasicSkillTemplateGUI.php.

References ILIAS\Repository\form(), and ilTree\POS_LAST_NODE.

                               : void
     {
         if (!$this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
             return;
         }
 
         $it = new ilBasicSkillTemplate();
         $it->setTitle($this->form->getInput("title"));
         $it->setDescription($this->form->getInput("description"));
         $it->create();
         $this->skill_tree_node_manager->putIntoTree($it, $this->requested_node_id, ilTree::POS_LAST_NODE);
         $this->node_object = $it;
     }

Here is the call graph for this function:

◆ setLevelHead()

ilBasicSkillTemplateGUI::setLevelHead ( )

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

References $ctrl, $help, $lng, $tabs, $tpl, ilSkillTreeNode\getIconPath(), ilBasicSkill\lookupLevelTitle(), ilGlobalTemplateInterface\setDescription(), ilHelpGUI\setScreenIdComponent(), ilGlobalTemplateInterface\setTitle(), ilGlobalTemplateInterface\setTitleIcon(), and ilLanguage\txt().

                                   : void
     {
         $ilTabs = $this->tabs;
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $lng = $this->lng;
         $ilHelp = $this->help;
 
         // tabs
         $ilTabs->clearTargets();
         $ilHelp->setScreenIdComponent("skmg_lev");
         $ilTabs->setBackTarget(
             $lng->txt("skmg_skill_levels"),
             $ilCtrl->getLinkTarget($this, "edit")
         );
 
         if ($this->requested_level_id > 0) {
             if ($this->tref_id == 0) {
                 $ilTabs->addTab(
                     "level_settings",
                     $lng->txt("settings"),
                     $ilCtrl->getLinkTarget($this, "editLevel")
                 );
             } else {
                 $ilTabs->addTab(
                     "level_resources",
                     $lng->txt("skmg_resources"),
                     $ilCtrl->getLinkTarget($this, "showLevelResources")
                 );
             }
         }
 
         // title
         if ($this->requested_level_id > 0) {
             $tpl->setTitle($lng->txt("skmg_skill_level") . ": " .
                 ilBasicSkill::lookupLevelTitle($this->requested_level_id));
         } else {
             $tpl->setTitle($lng->txt("skmg_skill_level"));
         }
 
         $desc = $this->skill_tree_node_manager->getWrittenPath($this->node_object->getId());
         $tpl->setDescription($desc);
 
         $tpl->setTitleIcon(
             ilSkillTreeNode::getIconPath(
                 0,
                 "sktp",
                 "",
                 false
             )
         );
     }

Here is the call graph for this function:

◆ setTabs()

ilBasicSkillTemplateGUI::setTabs ( string $a_tab = "levels" )

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

References $ctrl, $help, $lng, $tabs, $tpl, ilSkillTreeNode\_lookupTitle(), ilSkillTreeNode\_lookupType(), ilSkillTreeNodeGUI\addObjectsTab(), ilSkillTreeNodeGUI\addUsageTab(), ilGlobalTemplateInterface\setDescription(), ilHelpGUI\setScreenIdComponent(), ilSkillTreeNodeGUI\setSkillNodeDescription(), ilGlobalTemplateInterface\setTitle(), and ilLanguage\txt().

Referenced by edit(), showObjects(), and showUsage().

                                                      : void
     {
         $ilTabs = $this->tabs;
         $ilCtrl = $this->ctrl;
         $tpl = $this->tpl;
         $lng = $this->lng;
         $ilHelp = $this->help;
 
         $ilTabs->clearTargets();
         $ilHelp->setScreenIdComponent("skmg_sktp");
 
         $parent_node_id = $this->tree_repo->getParentNodeIdForNodeId($this->requested_node_id);
         $parent_title = ilSkillTreeNode::_lookupTitle($parent_node_id);
         $parent_type = ilSkillTreeNode::_lookupType($parent_node_id);
 
         if ($this->tref_id == 0) {
             if ($parent_type === "sctp") {
                 $ilCtrl->setParameterByClass(
                     "ilskilltemplatecategorygui",
                     "node_id",
                     $parent_node_id
                 );
                 $ilTabs->setBackTarget(
                     $parent_title,
                     $ilCtrl->getLinkTargetByClass("ilskilltemplatecategorygui", "listItems")
                 );
                 $ilCtrl->setParameterByClass(
                     "ilskilltemplatecategorygui",
                     "node_id",
                     ""
                 );
             } else {
                 $ilTabs->setBackTarget(
                     $lng->txt("skmg_skill_templates"),
                     $ilCtrl->getLinkTargetByClass("ilobjskilltreegui", "editSkillTemplates")
                 );
             }
         }
 
         if (is_object($this->node_object)) {
             if ($this->tref_id == 0) {
                 $tpl->setTitle($lng->txt("skmg_skill_template") . ": " .
                     $this->node_object->getTitle());
             } else {
                 $tpl->setTitle(
                     $this->node_object->getTitle()
                 );
             }
 
             // levels
             $ilTabs->addTab(
                 "levels",
                 $lng->txt("skmg_skill_levels"),
                 $ilCtrl->getLinkTarget($this, 'edit')
             );
 
             // properties
             if ($this->tref_id == 0) {
                 $ilTabs->addTab(
                     "properties",
                     $lng->txt("settings"),
                     $ilCtrl->getLinkTarget($this, 'editProperties')
                 );
             }
 
             //                  if ($this->tref_id > 0)
             //                  {
             // usage
             $this->addUsageTab($ilTabs);
             //                  }
 
             // assigned objects
             $this->addObjectsTab($ilTabs);
 
             $ilTabs->activateTab($a_tab);
 
             parent::setTitleIcon();
 
             $this->setSkillNodeDescription();
         } else {
             $tpl->setTitle($lng->txt("skmg_skill"));
             $tpl->setDescription("");
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showObjects()

ilBasicSkillTemplateGUI::showObjects ( )

Definition at line 326 of file class.ilBasicSkillTemplateGUI.php.

References $tpl, ilGlobalTemplateInterface\setContent(), and setTabs().

                                  : void
     {
         $tpl = $this->tpl;
 
         // (a) referenced skill template in main tree
         if ($this->tref_id > 0) {
             parent::showObjects();
             return;
         }
 
         // (b) skill template in templates view
 
         $this->setTabs("objects");
 
         $usage_info = new ilSkillUsage();
         $objects = $usage_info->getAssignedObjectsForSkillTemplate($this->base_skill_id);
 
         $tab = new ilSkillAssignedObjectsTableGUI($this, "showObjects", $objects);
 
         $tpl->setContent($tab->getHTML());
     }

Here is the call graph for this function:

◆ showUsage()

ilBasicSkillTemplateGUI::showUsage ( )

Definition at line 299 of file class.ilBasicSkillTemplateGUI.php.

References $tpl, ilGlobalTemplateInterface\setContent(), and setTabs().

                                : void
     {
         $tpl = $this->tpl;
 
 
         // (a) referenced skill template in main tree
         if ($this->tref_id > 0) {
             parent::showUsage();
             return;
         }
 
         // (b) skill template in templates view
 
         $this->setTabs("usage");
 
         $usage_info = new ilSkillUsage();
         $usages = $usage_info->getAllUsagesOfTemplate($this->base_skill_id);
 
         $html = "";
         foreach ($usages as $k => $usage) {
             $tab = new ilSkillUsageTableGUI($this, "showUsage", $k, $usage);
             $html .= $tab->getHTML() . "<br/><br/>";
         }
 
         $tpl->setContent($html);
     }