ilPCSkillsGUI Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilPCSkillsGUI:

Collaboration diagram for ilPCSkillsGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id, string $a_pc_id="")
	executeCommand ()
	insert (?ilPropertyFormGUI $a_form=null)
	edit (?ilPropertyFormGUI $a_form=null)
	create ()
	update ()
Public Member Functions inherited from ilPageContentGUI
	__construct (ilPageObject $a_pg_obj, ?ilPageContent $a_content_obj, string $a_hier_id="", string $a_pc_id="0")
	setContentObject (ilPageContent $a_val)
	getContentObject ()
	setPage (ilPageObject $a_val)
	getPage ()
	setPageConfig (ilPageConfig $a_val)
	getPageConfig ()
	setStyleId (int $a_styleid)
	getStyleId ()
	getStyle ()
	getCharacteristicsOfCurrentStyle (array $a_type)
	Get characteristics of current style and call setCharacteristics, if style is given. More...
	setCharacteristics (array $a_chars)
	getCharacteristics ()
	getHierId ()
	setHierId (string $a_hier_id)
	set hierarchical id in dom object More...
	delete ()
	displayValidationError ()
	cancelCreate ()
	cancel creating page content More...
	cancelUpdate ()
	cancel update More...
	cancel ()
	Cancel. More...
	deactivate ()
	gui function set enabled if is not enabled and vice versa More...
	cut ()
	Cut single element. More...
	copy ()
	Copy single element. More...
	getTemplateOptions (string $a_type="")
	Get table templates. More...

Protected Member Functions
	initForm (bool $a_insert=false)
	Init skills form. More...
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent (string $hier_id="")
	getParentReturn (string $hier_id="")
	updateAndReturn ()
	setCurrentTextLang (string $lang_key)
	getCurrentTextLang ()
	setEditorToolContext ()
	initEditor ()
	getEditorScriptTag (string $form_pc_id="", string $form_cname="")

Protected Attributes
ilObjUser	$user
ILIAS Skill Service SkillPersonalService	$skill_personal_service
Protected Attributes inherited from ilPageContentGUI
ILIAS COPage Editor GUIService	$editor_gui
ILIAS COPage InternalGUIService	$gui
EditSessionRepository	$edit_repo
string	$pc_id = ""
array	$chars
ilObjStyleSheet	$style = null
LOMServices	$lom_services
ilLogger	$log
int	$styleid = 0
EditGUIRequest	$request
string	$sub_command = ""
int	$requested_ref_id = 0
ILIAS GlobalScreen ScreenContext ContextServices	$tool_context
Style Content CharacteristicManager	$char_manager

Additional Inherited Members
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
Data Fields inherited from ilPageContentGUI
ilPageContent	$content_obj
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilCtrl	$ctrl
ilPageObject	$pg_obj
string	$hier_id = ""
DOMDocument	$dom
	$updated
string	$target_script = ""
string	$return_location = ""
ilPageConfig	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static string	$style_selector_reset = "margin-top:2px; margin-bottom:2px; text-indent:0px; position:static; float:none; width: auto;"
Static Protected Attributes inherited from ilPageContentGUI
static array	$common_bb_buttons

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilPCSkillsGUI Handles user commands on skills data

Author

Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 24 of file class.ilPCSkillsGUI.php.

Constructor & Destructor Documentation

__construct()

ilPCSkillsGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPageContent	$a_content_obj,
		string	$a_hier_id,
		string	$a_pc_id = ""
	)

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

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

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->skill_personal_service = $DIC->skills()->personal();
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCSkillsGUI::create

(

)

Definition at line 149 of file class.ilPCSkillsGUI.php.

References $data, $valid, ILIAS\Repository\ctrl(), ilPageContentGUI\getPage(), ilPageContentGUI\getPageConfig(), initForm(), insert(), and null.

                            : void
    {
        $valid = false;
        $data = null;
        $form = null;

        // template mode: get skills from global skill tree
        if ($this->getPageConfig()->getEnablePCType("PlaceHolder")) {
            $data = $this->request->getInt("skill_id");
            $valid = true;
        }
        // editor mode: use personal skills
        else {
            $form = $this->initForm(true);
            if ($form->checkInput()) {
                $data = $form->getInput("skill_id");
                $valid = true;
            }
        }

        if ($valid) {
            $this->content_obj = new ilPCSkills($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->content_obj->setData($data);
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }

        $form->setValuesByPost();
        $this->insert($form);
    }

Here is the call graph for this function:

edit()

ilPCSkillsGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 82 of file class.ilPCSkillsGUI.php.

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), ilPageContentGUI\getPageConfig(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by update().

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

        $this->displayValidationError();

        // template mode: get skills from global skill tree
        if ($this->getPageConfig()->getEnablePCType("PlaceHolder")) {
            $exp = new ilPersonalSkillExplorerGUI($this, "edit", $this, "update", "skill_id");
            if (!$exp->handleCommand()) {
                $tpl->setContent($exp->getHTML());
            }
        }
        // editor mode: use personal skills
        else {
            if (!$a_form) {
                $a_form = $this->initForm();
            }
            $tpl->setContent($a_form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCSkillsGUI::executeCommand

(

)

Definition at line 45 of file class.ilPCSkillsGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        // get next class that processes or forwards current command
        $next_class = $this->ctrl->getNextClass($this);

        // get current command
        $cmd = $this->ctrl->getCmd();

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

Here is the call graph for this function:

initForm()

ilPCSkillsGUI::initForm ( bool  $a_insert = false )

protected

Init skills form.

Definition at line 107 of file class.ilPCSkillsGUI.php.

References ilPageContentGUI\$ctrl, $user, ILIAS\Repository\lng(), and ilFormPropertyGUI\setRequired().

Referenced by create(), edit(), insert(), and update().

     : ilPropertyFormGUI {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;

        $form = new ilPropertyFormGUI();
        $form->setFormAction($ilCtrl->getFormAction($this));
        if ($a_insert) {
            $form->setTitle($this->lng->txt("cont_insert_skills"));
        } else {
            $form->setTitle($this->lng->txt("cont_update_skills"));
        }

        $options = array();

        $skills = $this->skill_personal_service->getSelectedUserSkills($ilUser->getId());
        if ($skills) {
            foreach ($skills as $skill) {
                $options[$skill->getSkillNodeId()] = $skill->getTitle();
            }
            asort($options);
        } else {
            $this->tpl->setOnScreenMessage('failure', "cont_no_skills");
        }
        $obj = new ilSelectInputGUI($this->lng->txt("cont_pc_skills"), "skill_id");
        $obj->setRequired(true);
        $obj->setOptions($options);
        $form->addItem($obj);

        if ($a_insert) {
            $form->addCommandButton("create", $this->lng->txt("select"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            $obj->setValue($this->content_obj->getSkillId());
            $form->addCommandButton("update", $this->lng->txt("select"));
            $form->addCommandButton("cancelUpdate", $this->lng->txt("cancel"));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

insert()

ilPCSkillsGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

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

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), ilPageContentGUI\getPageConfig(), initForm(), and ILIAS\UICore\GlobalTemplate\setContent().

Referenced by create().

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

        $this->displayValidationError();

        // template mode: get skills from global skill tree
        if ($this->getPageConfig()->getEnablePCType("PlaceHolder")) {
            $exp = new ilPersonalSkillExplorerGUI($this, "insert", $this, "create", "skill_id");
            if (!$exp->handleCommand()) {
                $tpl->setContent($exp->getHTML());
            }
        }
        // editor mode: use personal skills
        else {
            if (!$a_form) {
                $a_form = $this->initForm(true);
            }
            $tpl->setContent($a_form->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilPCSkillsGUI::update

(

)

Definition at line 183 of file class.ilPCSkillsGUI.php.

References $data, $valid, ILIAS\Repository\ctrl(), edit(), ilPageContentGUI\getPageConfig(), initForm(), and null.

                            : void
    {
        $valid = false;
        $data = null;
        $form = null;

        // template mode: get skills from global skill tree
        if ($this->getPageConfig()->getEnablePCType("PlaceHolder")) {
            $data = $this->request->getInt("skill_id");
            $valid = true;
        }
        // editor mode: use personal skills
        else {
            $form = $this->initForm();
            if ($form->checkInput()) {
                $data = $form->getInput("skill_id");
                $valid = true;
            }
        }

        if ($valid) {
            $this->content_obj->setData($data);
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }

        $this->pg_obj->addHierIDs();
        $form->setValuesByPost();
        $this->edit($form);
    }

Here is the call graph for this function:

Field Documentation

$skill_personal_service

ILIAS Skill Service SkillPersonalService ilPCSkillsGUI::$skill_personal_service

protected

Definition at line 27 of file class.ilPCSkillsGUI.php.

$user

ilObjUser ilPCSkillsGUI::$user

protected

Definition at line 26 of file class.ilPCSkillsGUI.php.

Referenced by initForm().

---

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

• components/ILIAS/COPage/PC/Skills/class.ilPCSkillsGUI.php