ilSkillTemplateReferenceGUI Class Reference

Skill template reference GUI class. More...

Inheritance diagram for ilSkillTemplateReferenceGUI:

Collaboration diagram for ilSkillTemplateReferenceGUI:

Public Member Functions
	__construct (Node\SkillTreeNodeManager $node_manager, int $a_tref_id=0)
	getType ()
	executeCommand ()
	setTabs ($a_tab="levels")
	insert ()
	editProperties ()
	initForm (string $a_mode="edit")
	getValues ()
	saveItem ()
	afterSave ()
	updateSkillTemplateReference ()
	listItems ()
	showObjects ()
	redirectToParent (bool $a_tmp_mode=false)
Public Member Functions inherited from ilBasicSkillTemplateGUI
	__construct (Node\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 (Node\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 ()
	removeLevelResources ()
	saveResourcesAsSuggested ()
	saveResourcesAsNotSuggested ()
	saveResourcesAsTrigger ()
	saveResourcesAsNoTrigger ()
Public Member Functions inherited from ilSkillTreeNodeGUI
	__construct (Node\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 ()

Additional Inherited Members
Data Fields inherited from ilSkillTreeNodeGUI
object	$node_object = null
bool	$in_use = false
bool	$use_checked = false
ilAccessHandler	$access
Protected Attributes inherited from ilBasicSkillTemplateGUI
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
Data Factory	$df
ServerRequestInterface	$request
ArrayBasedRequestWrapper	$query
Resource SkillResourcesManager	$resource_manager
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 = []
string	$requested_table_action = ""
array	$requested_table_rep_ref_ids = []
Protected Attributes inherited from ilSkillTreeNodeGUI
ilCtrl	$ctrl
ilLanguage	$lng
ilLocatorGUI	$locator
ilGlobalTemplateInterface	$tpl
ilObjUser	$user
ilTree	$tree
ilPropertyFormGUI	$form
UI Factory	$ui_fac
UI Renderer	$ui_ren
object	$parentgui
int	$tref_id = 0
Node SkillTreeNodeManager	$skill_tree_node_manager
SkillTreeAccess	$tree_access_manager
Table TableManager	$table_manager
Usage SkillUsageManager	$usage_manager
ilSkillTreeRepository	$tree_repo
int	$skill_tree_id = 0
ilTabsGUI	$tabs
SkillAdminGUIRequest	$admin_gui_request
SkillUIService	$skill_ui_service
int	$requested_ref_id = 0
int	$requested_node_id = 0
string	$requested_backcmd = ""
bool	$requested_tmpmode = false
int	$base_skill_id = 0
array	$requested_node_ids = []
array	$requested_node_order = []

Detailed Description

Skill template reference GUI class.

Author

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

ilSkillTemplateReferenceGUI: ilObjSkillManagementGUI, ilObjSkillTreeGUI

Definition at line 31 of file class.ilSkillTemplateReferenceGUI.php.

Constructor & Destructor Documentation

__construct()

ilSkillTemplateReferenceGUI::__construct	(	Node\SkillTreeNodeManager	$node_manager,
		int	$a_tref_id = 0
	)

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

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), ILIAS\Repository\ctrl(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\tabs().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC["tpl"];
        $this->tabs = $DIC->tabs();
        $this->lng = $DIC->language();
        $this->help = $DIC["ilHelp"];
        $ilCtrl = $DIC->ctrl();

        $ilCtrl->saveParameter($this, "node_id");
        $ilCtrl->saveParameter($this, "tref_id");

        parent::__construct($node_manager, $a_tref_id);

        $this->tref_id = $a_tref_id;
        if (is_object($this->node_object)) {
            $this->base_skill_id = $this->node_object->getSkillTemplateId();
        }
    }

Here is the call graph for this function:

Member Function Documentation

afterSave()

ilSkillTemplateReferenceGUI::afterSave

(

)

Definition at line 274 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$ctrl, and ilCtrl\setParameterByClass().

                               : void
    {
        $ilCtrl = $this->ctrl;

        if (!$this->tree_access_manager->hasManageCompetencesPermission()) {
            return;
        }

        $ilCtrl->setParameterByClass(
            "ilskilltemplatereferencegui",
            "tref_id",
            $this->node_object->getId()
        );
        $ilCtrl->setParameterByClass(
            "ilskilltemplatereferencegui",
            "node_id",
            $this->node_object->getSkillTemplateId()
        );
        $ilCtrl->redirectByClass("ilskilltemplatereferencegui", "listItems");
    }

Here is the call graph for this function:

editProperties()

ilSkillTemplateReferenceGUI::editProperties

(

)

Definition at line 163 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$tpl, ILIAS\Repository\form(), getValues(), initForm(), ilGlobalTemplateInterface\setContent(), and setTabs().

                                    : void
    {
        $tpl = $this->tpl;

        $this->setTabs("properties");

        $this->initForm();
        $this->getValues();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

executeCommand()

ilSkillTemplateReferenceGUI::executeCommand

(

)

Definition at line 60 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$ctrl, ilBasicSkillTemplateGUI\$tabs, and ilBasicSkillTemplateGUI\$tpl.

                                    : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $ilTabs = $this->tabs;

        //$tpl->getStandardTemplate();

        $next_class = $ilCtrl->getNextClass($this);
        $cmd = $ilCtrl->getCmd();

        switch ($next_class) {
            default:
                $ret = $this->$cmd();
                break;
        }
    }

getType()

ilSkillTemplateReferenceGUI::getType

(

)

Definition at line 55 of file class.ilSkillTemplateReferenceGUI.php.

                             : string
    {
        return "sktr";
    }

getValues()

ilSkillTemplateReferenceGUI::getValues

(

)

Definition at line 246 of file class.ilSkillTemplateReferenceGUI.php.

References ILIAS\Repository\form().

Referenced by editProperties().

                               : void
    {
        $values = [];
        $values["skill_template_id"] = $this->node_object->getSkillTemplateId();
        $values["title"] = $this->node_object->getTitle();
        $values["description"] = $this->node_object->getDescription();
        $values["selectable"] = $this->node_object->getSelfEvaluation();
        $values["status"] = $this->node_object->getStatus();
        $this->form->setValuesByArray($values);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilSkillTemplateReferenceGUI::initForm

(

string

$a_mode = "edit"

)

Definition at line 174 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$ctrl, ilBasicSkillTemplateGUI\$lng, ilSkillTreeNode\_lookupDescription(), ilSkillTreeNodeGUI\addStatusInput(), ILIAS\Repository\form(), ilSelectInputGUI\setOptions(), and ilLanguage\txt().

Referenced by editProperties(), insert(), and updateSkillTemplateReference().

                                                     : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;

        //TODO: Refactoring to UI Form when non-editable input is available

        $this->form = new ilPropertyFormGUI();

        // select skill template
        $tmplts = $this->skill_tree_node_manager->getTopTemplates();

        // title
        $ti = new ilTextInputGUI($lng->txt("title"), "title");
        $ti->setRequired(true);
        $this->form->addItem($ti);

        // description
        if ($a_mode == "edit") {
            $desc = ilSkillTreeNode::_lookupDescription($this->node_object->getSkillTemplateId());
            if (!empty($desc)) {
                $ne = new ilNonEditableValueGUI($lng->txt("description"), "template_description");
                $ne->setValue($desc);
                $ne->setInfo($lng->txt("skmg_description_info"));
                $this->form->addItem($ne);
            }
        }

        // template
        $options = array(
            "" => $lng->txt("please_select"),
            );
        foreach ($tmplts as $tmplt) {
            $options[$tmplt["child"]] = $tmplt["title"];
        }
        if ($a_mode != "edit") {
            $si = new ilSelectInputGUI($lng->txt("skmg_skill_template"), "skill_template_id");
            $si->setOptions($options);
            $si->setRequired(true);
            $this->form->addItem($si);
        } else {
            $ne = new ilNonEditableValueGUI($lng->txt("skmg_skill_template"), "");
            $ne->setValue($options[$this->node_object->getSkillTemplateId()] ?? "");
            $this->form->addItem($ne);
        }

        // status
        $this->addStatusInput($this->form);

        // selectable
        $cb = new ilCheckboxInputGUI($lng->txt("skmg_selectable"), "selectable");
        $cb->setInfo($lng->txt("skmg_selectable_info"));
        $this->form->addItem($cb);

        if ($this->tree_access_manager->hasManageCompetencesPermission()) {
            if ($a_mode == "create") {
                $this->form->addCommandButton("save", $lng->txt("save"));
                $this->form->addCommandButton("cancelSave", $lng->txt("cancel"));
                $this->form->setTitle($lng->txt("skmg_new_sktr"));
            } else {
                $this->form->addCommandButton("updateSkillTemplateReference", $lng->txt("save"));
                $this->form->setTitle($lng->txt("skmg_edit_sktr"));
            }
        } else {
            foreach ($this->form->getItems() as $item) {
                $item->setDisabled(true);
            }
        }

        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilSkillTemplateReferenceGUI::insert

(

)

Definition at line 152 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$ctrl, ilBasicSkillTemplateGUI\$tpl, ILIAS\Repository\form(), initForm(), and ilGlobalTemplateInterface\setContent().

                            : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        $ilCtrl->saveParameter($this, "parent_id");
        $ilCtrl->saveParameter($this, "target");
        $this->initForm("create");
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

listItems()

ilSkillTemplateReferenceGUI::listItems

(

)

Definition at line 322 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$lng, ilBasicSkillTemplateGUI\$tpl, ilSkillTreeNode\_lookupType(), ilSkillTreeNodeGUI\isInUse(), ilSkillCatTableGUI\MODE_SCTP, ilGlobalTemplateInterface\setContent(), setTabs(), and ilLanguage\txt().

                               : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;

        if ($this->isInUse()) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("skmg_skill_in_use"));
        }

        $this->setTabs("content");

        $sk_id = $this->node_object->getSkillTemplateId();
        $obj_type = ilSkillTreeNode::_lookupType($sk_id);

        if ($obj_type == "sctp") {
            $table = new ilSkillCatTableGUI(
                $this,
                "listItems",
                (int) $sk_id,
                ilSkillCatTableGUI::MODE_SCTP,
                $this->node_object->getId()
            );
            $tpl->setContent($table->getHTML());
        } elseif ($obj_type == "sktp") {
            $table = new ilSkillLevelTableGUI(
                (int) $sk_id,
                $this,
                "edit",
                $this->node_object->getId(),
                false,
                $this->tree_access_manager->hasManageCompetencesPermission()
            );
            $tpl->setContent($table->getHTML());
        }
    }

Here is the call graph for this function:

redirectToParent()

ilSkillTemplateReferenceGUI::redirectToParent

(

bool

$a_tmp_mode = false

)

Definition at line 376 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$ctrl, and ilCtrl\setParameterByClass().

                                                              : void
    {
        $ilCtrl = $this->ctrl;

        $ilCtrl->setParameterByClass("ilskillrootgui", "node_id", $this->requested_node_id);
        $ilCtrl->redirectByClass("ilskillrootgui", "listSkills");
    }

Here is the call graph for this function:

saveItem()

ilSkillTemplateReferenceGUI::saveItem

(

)

Definition at line 257 of file class.ilSkillTemplateReferenceGUI.php.

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

                              : void
    {
        if (!$this->tree_access_manager->hasManageCompetencesPermission()) {
            return;
        }

        $sktr = new ilSkillTemplateReference();
        $sktr->setTitle($this->form->getInput("title"));
        $sktr->setDescription($this->form->getInput("description"));
        $sktr->setSkillTemplateId((int) $this->form->getInput("skill_template_id"));
        $sktr->setSelfEvaluation((bool) $this->form->getInput("selectable"));
        $sktr->setStatus((int) $this->form->getInput("status"));
        $sktr->create();
        $this->skill_tree_node_manager->putIntoTree($sktr, $this->requested_node_id, ilTree::POS_LAST_NODE);
        $this->node_object = $sktr;
    }

Here is the call graph for this function:

setTabs()

ilSkillTemplateReferenceGUI::setTabs

(

$a_tab = "levels"

)

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

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

Referenced by editProperties(), listItems(), and showObjects().

                                              : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilHelp = $this->help;

        $ilTabs->clearTargets();
        $ilHelp->setScreenIdComponent("skmg_sktr");

        if (is_object($this->node_object)) {
            $sk_id = $this->node_object->getSkillTemplateId();
            $obj_type = ilSkillTreeNode::_lookupType($sk_id);

            if ($obj_type == "sctp") {
                // content
                $ilTabs->addTab(
                    "content",
                    $lng->txt("content"),
                    $ilCtrl->getLinkTarget($this, 'listItems')
                );
            } else {
                // content
                $ilTabs->addTab(
                    "content",
                    $lng->txt("skmg_skill_levels"),
                    $ilCtrl->getLinkTarget($this, 'listItems')
                );
            }

            // properties
            $ilTabs->addTab(
                "properties",
                $lng->txt("settings"),
                $ilCtrl->getLinkTarget($this, 'editProperties')
            );

            // usage
            $this->addUsageTab($ilTabs);

            // assigned objects
            if ($obj_type != "sctp") {
                $this->addObjectsTab($ilTabs);
            }

            $ilCtrl->setParameterByClass(
                "ilskillrootgui",
                "node_id",
                $this->skill_tree_node_manager->getRootId()
            );
            $ilTabs->setBackTarget(
                $lng->txt("skmg_skills"),
                $ilCtrl->getLinkTargetByClass("ilskillrootgui", "listSkills")
            );
            $ilCtrl->setParameterByClass(
                "ilskillrootgui",
                "node_id",
                $this->requested_node_id
            );

            $tid = ilSkillTemplateReference::_lookupTemplateId($this->node_object->getId());
            $add = " (" . ilSkillTreeNode::_lookupTitle($tid) . ")";

            parent::setTitleIcon();
            $tpl->setTitle(
                $lng->txt("skmg_sktr") . ": " . $this->node_object->getTitle() . $add
            );
            $this->setSkillNodeDescription();

            $ilTabs->activateTab($a_tab);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showObjects()

ilSkillTemplateReferenceGUI::showObjects

(

)

Definition at line 358 of file class.ilSkillTemplateReferenceGUI.php.

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

                                 : void
    {
        $tpl = $this->tpl;

        $this->setTabs("objects");

        $objects = $this->usage_manager->getAssignedObjectsForSkill($this->base_skill_id, $this->tref_id);

        $table = $this->table_manager->getAssignedObjectsTable(
            $this,
            $objects,
            $this->base_skill_id,
            $this->tref_id
        )->getComponent();

        $tpl->setContent($this->ui_ren->render($table));
    }

Here is the call graph for this function:

updateSkillTemplateReference()

ilSkillTemplateReferenceGUI::updateSkillTemplateReference

(

)

Definition at line 295 of file class.ilSkillTemplateReferenceGUI.php.

References ilBasicSkillTemplateGUI\$ctrl, ilBasicSkillTemplateGUI\$lng, ilBasicSkillTemplateGUI\$tpl, ILIAS\Repository\form(), initForm(), ilGlobalTemplateInterface\setContent(), and ilLanguage\txt().

                                                  : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;

        if (!$this->tree_access_manager->hasManageCompetencesPermission()) {
            return;
        }

        $this->initForm("edit");
        if ($this->form->checkInput()) {
            // perform update
            $this->node_object->setTitle($this->form->getInput("title"));
            $this->node_object->setDescription($this->form->getInput("description"));
            $this->node_object->setSelfEvaluation((bool) $this->form->getInput("selectable"));
            $this->node_object->setStatus((int) $this->form->getInput("status"));
            $this->node_object->update();

            $this->tpl->setOnScreenMessage('success', $lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "editProperties");
        }

        $this->form->setValuesByPost();
        $tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

---

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

• Services/Skill/Node/class.ilSkillTemplateReferenceGUI.php