ilSkillCategoryGUI Class Reference

Skill category GUI class. More...

Inheritance diagram for ilSkillCategoryGUI:

Collaboration diagram for ilSkillCategoryGUI:

Public Member Functions
	__construct (Node\SkillTreeNodeManager $node_manager, int $a_node_id=0)
	getType ()
	executeCommand ()
	setTabs (string $a_tab)
	editProperties ()
	edit ()
	initForm (string $a_mode="edit")
	saveItem ()
	getValues ()
	Get current values for from. More...
	updateItem ()
	listItems ()
	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
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 category GUI class.

Author

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

@ilCtrl_isCalledBy ilSkillCategoryGUI: ilObjSkillManagementGUI, ilObjSkillTreeGUI

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

Constructor & Destructor Documentation

__construct()

ilSkillCategoryGUI::__construct	(	Node\SkillTreeNodeManager	$node_manager,
		int	$a_node_id = 0
	)

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 38 of file class.ilSkillCategoryGUI.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");
 
        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 ilSkillCategoryGUI::addCreationButtons ( )

static

Definition at line 280 of file class.ilSkillCategoryGUI.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();
 
        // skill
        $ilCtrl->setParameterByClass(
            "ilbasicskillgui",
            "node_id",
            $requested_node_id
        );
        $ilToolbar->addButton(
            $lng->txt("skmg_create_skll"),
            $ilCtrl->getLinkTargetByClass("ilbasicskillgui", "create")
        );
 
        // skill category
        $ilCtrl->setParameterByClass(
            "ilskillcategorygui",
            "node_id",
            $requested_node_id
        );
        $ilToolbar->addButton(
            $lng->txt("skmg_create_skill_category"),
            $ilCtrl->getLinkTargetByClass("ilskillcategorygui", "create")
        );
 
        // skill template reference
        $ilCtrl->setParameterByClass(
            "ilskilltemplatereferencegui",
            "node_id",
            $requested_node_id
        );
        $ilToolbar->addButton(
            $lng->txt("skmg_create_skill_template_reference"),
            $ilCtrl->getLinkTargetByClass("ilskilltemplatereferencegui", "create")
        );
 
        // skills from clipboard
        $sep = false;
        if ($ilUser->clipboardHasObjectsOfType("skll")) {
            $ilToolbar->addSeparator();
            $sep = true;
            $ilToolbar->addButton(
                $lng->txt("skmg_insert_basic_skill_from_clip"),
                $ilCtrl->getLinkTargetByClass("ilskillcategorygui", "insertBasicSkillClip")
            );
        }
 
        // skills from clipboard
        if ($ilUser->clipboardHasObjectsOfType("scat")) {
            if (!$sep) {
                $ilToolbar->addSeparator();
                $sep = true;
            }
            $ilToolbar->addButton(
                $lng->txt("skmg_insert_skill_category_from_clip"),
                $ilCtrl->getLinkTargetByClass("ilskillcategorygui", "insertSkillCategoryClip")
            );
        }
 
        // skills from clipboard
        if ($ilUser->clipboardHasObjectsOfType("sktr")) {
            if (!$sep) {
                $ilToolbar->addSeparator();
                $sep = true;
            }
            $ilToolbar->addButton(
                $lng->txt("skmg_insert_skill_template_reference_from_clip"),
                $ilCtrl->getLinkTargetByClass("ilskillcategorygui", "insertTemplateReferenceClip")
            );
        }
 
        // skill template reference
        $ilToolbar->addButton(
            $lng->txt("skmg_import_skills"),
            $ilCtrl->getLinkTargetByClass("ilskillrootgui", "showImportForm")
        );
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

edit()

ilSkillCategoryGUI::edit

(

)

Definition at line 159 of file class.ilSkillCategoryGUI.php.

                          : void
    {
        $tpl = $this->tpl;
 
        $this->initForm();
        $this->getValues();
        $tpl->setContent($this->form->getHTML());
    }

References $tpl, ILIAS\Repository\form(), getValues(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

editProperties()

ilSkillCategoryGUI::editProperties

(

)

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 151 of file class.ilSkillCategoryGUI.php.

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

References $tpl, and setTabs().

Here is the call graph for this function:

executeCommand()

ilSkillCategoryGUI::executeCommand

(

)

Definition at line 59 of file class.ilSkillCategoryGUI.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()

ilSkillCategoryGUI::getType

(

)

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

                             : string
    {
        return "scat";
    }

getValues()

ilSkillCategoryGUI::getValues

(

)

Get current values for from.

Definition at line 233 of file class.ilSkillCategoryGUI.php.

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

References ILIAS\Repository\form().

Referenced by edit().

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilSkillCategoryGUI::initForm

(

string

$a_mode = "edit"

)

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 168 of file class.ilSkillCategoryGUI.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);
 
        // status
        $this->addStatusInput($this->form);
 
        // selectable
        $cb = new ilCheckboxInputGUI($lng->txt("skmg_selectable"), "self_eval");
        $cb->setInfo($lng->txt("skmg_selectable_info"));
        $this->form->addItem($cb);
 
        // save and cancel commands
        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_create_skill_category"));
            } else {
                $this->form->addCommandButton("update", $lng->txt("save"));
                $this->form->setTitle($lng->txt("skmg_edit_scat"));
            }
        } 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, ilSkillTreeNodeGUI\addStatusInput(), ILIAS\Repository\form(), and ilLanguage\txt().

Referenced by edit().

Here is the call graph for this function:

Here is the caller graph for this function:

listItems()

ilSkillCategoryGUI::listItems

(

)

Definition at line 256 of file class.ilSkillCategoryGUI.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->hasManageCompetencesPermission()) {
            self::addCreationButtons();
        }
        $this->setTabs("content");
 
        $table = new ilSkillCatTableGUI(
            $this,
            "listItems",
            $this->requested_node_id,
            ilSkillCatTableGUI::MODE_SCAT
        );
 
        $tpl->setContent($table->getHTML());
    }

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

Here is the call graph for this function:

redirectToParent()

ilSkillCategoryGUI::redirectToParent

(

bool

$a_tmp_mode = false

)

Redirect to parent (identified by current node_id)

Reimplemented from ilSkillTreeNodeGUI.

Definition at line 370 of file class.ilSkillCategoryGUI.php.

                                                              : void
    {
        $ilCtrl = $this->ctrl;
 
        $t = ilSkillTreeNode::_lookupType($this->requested_node_id);
 
        switch ($t) {
            case "skrt":
                $ilCtrl->setParameterByClass("ilskillrootgui", "node_id", $this->requested_node_id);
                $ilCtrl->redirectByClass("ilskillrootgui", "listSkills");
                break;
        }
 
        parent::redirectToParent();
    }

References $ctrl, and ilSkillTreeNode\_lookupType().

Here is the call graph for this function:

saveItem()

ilSkillCategoryGUI::saveItem

(

)

Definition at line 215 of file class.ilSkillCategoryGUI.php.

                              : void
    {
        if (!$this->tree_access_manager->hasManageCompetencesPermission()) {
            return;
        }
 
        $it = new ilSkillCategory();
        $it->setTitle($this->form->getInput("title"));
        $it->setDescription($this->form->getInput("description"));
        $it->setSelfEvaluation((bool) $this->form->getInput("self_eval"));
        $it->setStatus((int) $this->form->getInput("status"));
        $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()

ilSkillCategoryGUI::setTabs

(

string

$a_tab

)

Definition at line 77 of file class.ilSkillCategoryGUI.php.

                                          : void
    {
        $ilTabs = $this->tabs;
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilHelp = $this->help;
 
        $ilTabs->clearTargets();
        $ilHelp->setScreenIdComponent("skmg_scat");
 
        // content
        $ilTabs->addTab(
            "content",
            $lng->txt("content"),
            $ilCtrl->getLinkTarget($this, 'listItems')
        );
 
        // properties
        $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 ($parent_type === "scat") {
            $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_skills"),
                $ilCtrl->getLinkTargetByClass("ilskillrootgui", "listSkills")
            );
            $ilCtrl->setParameterByClass(
                "ilskillrootgui",
                "node_id",
                $this->requested_node_id
            );
        }
 
        parent::setTitleIcon();
        $tpl->setTitle(
            $lng->txt("scat") . ": " . $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(), and listItems().

Here is the call graph for this function:

Here is the caller graph for this function:

updateItem()

ilSkillCategoryGUI::updateItem

(

)

Definition at line 243 of file class.ilSkillCategoryGUI.php.

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

References ILIAS\Repository\form().

Here is the call graph for this function:

Field Documentation

$ctrl

ilCtrl ilSkillCategoryGUI::$ctrl

protected

Definition at line 32 of file class.ilSkillCategoryGUI.php.

Referenced by executeCommand(), initForm(), redirectToParent(), and setTabs().

$help

ilHelpGUI ilSkillCategoryGUI::$help

protected

Definition at line 36 of file class.ilSkillCategoryGUI.php.

Referenced by setTabs().

$lng

ilLanguage ilSkillCategoryGUI::$lng

protected

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

Referenced by addCreationButtons(), initForm(), listItems(), and setTabs().

$tabs

ilTabsGUI ilSkillCategoryGUI::$tabs

protected

Definition at line 34 of file class.ilSkillCategoryGUI.php.

Referenced by executeCommand(), and setTabs().

$tpl

ilGlobalTemplateInterface ilSkillCategoryGUI::$tpl

protected

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

Referenced by edit(), editProperties(), executeCommand(), listItems(), and setTabs().

---

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

• components/ILIAS/Skill/Node/class.ilSkillCategoryGUI.php