Skill template category GUI class. More...

Inheritance diagram for ilSkillTemplateCategoryGUI:

Collaboration diagram for ilSkillTemplateCategoryGUI:

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

	getType ()

	executeCommand ()

	setTabs (string $a_tab)

	initForm (string $a_mode="edit")

	listItems ()

	editProperties ()

	saveItem ()

	updateItem ()

	afterSave ()

	showUsage ()

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

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 ()

Static Public Member Functions
static	addCreationButtons ()

Protected Attributes
ilCtrl	$ctrl

ilGlobalTemplateInterface	$tpl

ilTabsGUI	$tabs

ilLanguage	$lng

ilHelpGUI	$help

int	$tref_id = 0

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

DataFactory	$data_factory

ExportFactoryInterface	$export_factory

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 = []

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

bool	$in_use = false

bool	$use_checked = false

ilAccessHandler	$access

Detailed Description

Skill template category GUI class.

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

Definition at line 29 of file class.ilSkillTemplateCategoryGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilSkillTemplateCategoryGUI::__construct	(	Node\SkillTreeNodeManager	$node_manager,
		int	$a_node_id = `0`,
		int	$a_tref_id = `0`
	)

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

    {
        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");
        $this->tref_id = $a_tref_id;
 
        parent::__construct($node_manager, $a_node_id);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addCreationButtons()

static ilSkillTemplateCategoryGUI::addCreationButtons ( )

static

Definition at line 225 of file class.ilSkillTemplateCategoryGUI.php.

                                               : void
    {
        global $DIC;
 
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();
        $ilToolbar = $DIC->toolbar();
        $ilUser = $DIC->user();
        $admin_gui_request = $DIC->skills()->internal()->gui()->admin_request();
 
        $requested_node_id = $admin_gui_request->getNodeId();
 
        $ilCtrl->setParameterByClass("ilobjskillmanagementgui", "tmpmode", 1);
 
        $ilCtrl->setParameterByClass(
            "ilbasicskilltemplategui",
            "node_id",
            $requested_node_id
        );
        $ilToolbar->addButton(
            $lng->txt("skmg_create_skill_template"),
            $ilCtrl->getLinkTargetByClass("ilbasicskilltemplategui", "create")
        );
        $ilCtrl->setParameterByClass(
            "ilskilltemplatecategorygui",
            "node_id",
            $requested_node_id
        );
        $ilToolbar->addButton(
            $lng->txt("skmg_create_skill_template_category"),
            $ilCtrl->getLinkTargetByClass("ilskilltemplatecategorygui", "create")
        );
 
        // skill templates from clipboard
        $sep = false;
        if ($ilUser->clipboardHasObjectsOfType("sktp")) {
            $ilToolbar->addSeparator();
            $sep = true;
            $ilToolbar->addButton(
                $lng->txt("skmg_insert_skill_template_from_clip"),
                $ilCtrl->getLinkTargetByClass("ilskilltemplatecategorygui", "insertSkillTemplateClip")
            );
        }
 
        // template categories from clipboard
        if ($ilUser->clipboardHasObjectsOfType("sctp")) {
            if (!$sep) {
                $ilToolbar->addSeparator();
                $sep = true;
            }
            $ilToolbar->addButton(
                $lng->txt("skmg_insert_template_category_from_clip"),
                $ilCtrl->getLinkTargetByClass("ilskilltemplatecategorygui", "insertTemplateCategoryClip")
            );
        }
    }

References ilSkillTreeNodeGUI\$admin_gui_request, $DIC, $lng, ilSkillTreeNodeGUI\$requested_node_id, ILIAS\Skill\Service\SkillAdminGUIRequest\getNodeId(), and ilLanguage\txt().

Referenced by listItems(), and ilSkillRootGUI\listTemplates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ afterSave()

ilSkillTemplateCategoryGUI::afterSave ( )

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 314 of file class.ilSkillTemplateCategoryGUI.php.

                               : void
    {
        $this->redirectToParent(true);
    }

References redirectToParent().

Here is the call graph for this function:

◆ editProperties()

ilSkillTemplateCategoryGUI::editProperties ( )

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 282 of file class.ilSkillTemplateCategoryGUI.php.

                                    : void
    {
        $this->setTabs("properties");
        parent::editProperties();
    }

References setTabs().

Here is the call graph for this function:

◆ executeCommand()

ilSkillTemplateCategoryGUI::executeCommand ( )

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

                                    : 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;
        }
    }

References $ctrl, $tabs, and $tpl.

◆ getType()

ilSkillTemplateCategoryGUI::getType ( )

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

                             : string
    {
        return "sctp";
    }

◆ initForm()

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

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 158 of file class.ilSkillTemplateCategoryGUI.php.

                                                     : 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_" . $this->getType()));
            } else {
                $this->form->addCommandButton("update", $lng->txt("save"));
                $this->form->setTitle($lng->txt("skmg_edit_" . $this->getType()));
            }
        } 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));
    }

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

Here is the call graph for this function:

◆ listItems()

ilSkillTemplateCategoryGUI::listItems ( )

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

                               : void
    {
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        if ($this->isInUse()) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("skmg_skill_in_use"));
        }
 
        if ($this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
            if ($this->tref_id == 0) {
                self::addCreationButtons();
            }
        }
 
        $this->setTabs("content");
 
        $table = new ilSkillCatTableGUI(
            $this,
            "listItems",
            $this->requested_node_id,
            ilSkillCatTableGUI::MODE_SCTP,
            $this->tref_id
        );
 
        $tpl->setContent($table->getHTML());
    }

References $lng, $tpl, addCreationButtons(), ilSkillTreeNodeGUI\isInUse(), ilSkillCatTableGUI\MODE_SCTP, ILIAS\UICore\GlobalTemplate\setContent(), setTabs(), and ilLanguage\txt().

Here is the call graph for this function:

◆ redirectToParent()

ilSkillTemplateCategoryGUI::redirectToParent ( bool $a_tmp_mode = false )

Redirect to parent (identified by current node_id)

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 344 of file class.ilSkillTemplateCategoryGUI.php.

                                                              : void
    {
        parent::redirectToParent(true);
    }

Referenced by afterSave().

Here is the caller graph for this function:

◆ saveItem()

ilSkillTemplateCategoryGUI::saveItem ( )

Definition at line 288 of file class.ilSkillTemplateCategoryGUI.php.

                              : void
    {
        if (!$this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
            return;
        }
 
        $it = new ilSkillTemplateCategory();
        $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);
    }

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

Here is the call graph for this function:

◆ setTabs()

ilSkillTemplateCategoryGUI::setTabs ( string $a_tab )

Definition at line 79 of file class.ilSkillTemplateCategoryGUI.php.

                                          : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilHelp = $this->help;
 
        $ilTabs->clearTargets();
        $ilHelp->setScreenIdComponent("skmg_sctp");
 
        // content
        $ilTabs->addTab(
            "content",
            $lng->txt("content"),
            $ilCtrl->getLinkTarget($this, 'listItems')
        );
 
 
        // properties
        if ($this->tref_id == 0) {
            $ilTabs->addTab(
                "properties",
                $lng->txt("settings"),
                $ilCtrl->getLinkTarget($this, 'editProperties')
            );
        }
 
        // usage
        $this->addUsageTab($ilTabs);
 
        $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);
 
        // back link
        if ($this->tref_id == 0) {
            if ($parent_type === "sctp") {
                $ilCtrl->setParameter(
                    $this,
                    "node_id",
                    $parent_node_id
                );
                $ilTabs->setBackTarget(
                    $parent_title,
                    $ilCtrl->getLinkTarget($this, "listItems")
                );
                $ilCtrl->setParameter(
                    $this,
                    "node_id",
                    $this->requested_node_id
                );
            } else {
                $ilCtrl->setParameterByClass(
                    "ilskillrootgui",
                    "node_id",
                    $this->skill_tree_node_manager->getRootId()
                );
                $ilTabs->setBackTarget(
                    $lng->txt("skmg_skill_templates"),
                    $ilCtrl->getLinkTargetByClass("ilskillrootgui", "listTemplates")
                );
                $ilCtrl->setParameterByClass(
                    "ilskillrootgui",
                    "node_id",
                    $this->requested_node_id
                );
            }
        }
 
        parent::setTitleIcon();
        $tpl->setTitle(
            $lng->txt("skmg_sctp") . ": " . $this->node_object->getTitle()
        );
        $this->setSkillNodeDescription();
 
        $ilTabs->activateTab($a_tab);
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showUsage()

ilSkillTemplateCategoryGUI::showUsage ( )

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 319 of file class.ilSkillTemplateCategoryGUI.php.

                               : void
    {
        $tpl = $this->tpl;
 
        // (a) referenced skill template category in main tree
        if ($this->tref_id > 0) {
            parent::showUsage();
            return;
        }
 
        // (b) skill template category in templates view
 
        $this->setTabs("usage");
 
        $usages = $this->usage_manager->getAllUsagesOfTemplate($this->requested_node_id);
 
        $html = "";
        foreach ($usages as $k => $usage) {
            $usages_ui = $this->skill_ui_service->getUsagesUI($k, $usage);
            $html .= $usages_ui->render() . "<br/><br/>";
        }
 
        $tpl->setContent($html);
    }

References $tpl, ILIAS\UICore\GlobalTemplate\setContent(), and setTabs().

Here is the call graph for this function:

◆ updateItem()

ilSkillTemplateCategoryGUI::updateItem ( )

Definition at line 301 of file class.ilSkillTemplateCategoryGUI.php.

                                : void
    {
        if (!$this->tree_access_manager->hasManageCompetenceTemplatesPermission()) {
            return;
        }
 
        $this->node_object->setTitle($this->form->getInput("title"));
        $this->node_object->setDescription($this->form->getInput("description"));
        $this->node_object->setOrderNr((int) $this->form->getInput("order_nr"));
        $this->node_object->setSelfEvaluation((bool) $this->form->getInput("self_eval"));
        $this->node_object->update();
    }