ilPCLearningHistoryGUI 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 ilPCLearningHistoryGUI:

Collaboration diagram for ilPCLearningHistoryGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ?ilPCLearningHistory $a_content_obj=null, string $a_hier_id="", string $a_pc_id="")
	executeCommand ()
	insert (?ilPropertyFormGUI $a_form=null)
	Insert learning history form. More...
	edit (?ilPropertyFormGUI $a_form=null)
	create_lhist ()
	create ()
	update ()
	Update learning history component. More...
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...

Static Public Member Functions
static	getPlaceholderPresentation ()
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()

Protected Member Functions
	initForm (bool $a_insert=false)
	Init learning history edit 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 DI UIServices	$ui
ilLearningHistoryService	$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
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 GUI class for learning history page content

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilPCLearningHistoryGUI: ilPageEditorGUI

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

Constructor & Destructor Documentation

__construct()

ilPCLearningHistoryGUI::__construct	(	ilPageObject	$a_pg_obj,
		?ilPCLearningHistory	$a_content_obj = null,
		string	$a_hier_id = "",
		string	$a_pc_id = ""
	)

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

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

      {
        global $DIC;

        $this->tpl = $DIC["tpl"];
        $this->ctrl = $DIC->ctrl();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule("lhist");
        parent::__construct($a_pg_obj, $a_content_obj, $a_hier_id, $a_pc_id);
        $this->service = $DIC->learningHistory();
        $this->ui = $DIC->ui();
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilPCLearningHistoryGUI::create

(

)

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

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

Referenced by create_lhist().

                            : void
    {
        $valid = false;

        $form = $this->initForm(true);
        if ($form->checkInput()) {
            //$data = $form->getInput("skill_id");
            $valid = true;
        }

        if ($valid) {
            $this->content_obj = new ilPCLearningHistory($this->getPage());
            $this->content_obj->create($this->pg_obj, $this->hier_id, $this->pc_id);
            $this->setAttributesFromInput($form);
            $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:

Here is the caller graph for this function:

create_lhist()

ilPCLearningHistoryGUI::create_lhist

(

)

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

References create().

                                  : void
    {
        $this->create();
    }

Here is the call graph for this function:

edit()

ilPCLearningHistoryGUI::edit

(

?ilPropertyFormGUI

$a_form = null

)

Definition at line 75 of file class.ilPCLearningHistoryGUI.php.

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

Referenced by update().

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

        $this->displayValidationError();

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

ilPCLearningHistoryGUI::executeCommand

(

)

Definition at line 48 of file class.ilPCLearningHistoryGUI.php.

References ILIAS\Repository\ctrl().

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

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

Here is the call graph for this function:

getPlaceholderPresentation()

static ilPCLearningHistoryGUI::getPlaceholderPresentation ( )

static

Definition at line 221 of file class.ilPCLearningHistoryGUI.php.

References $DIC, ilPageContentGUI\$lng, ilLanguage\loadLanguageModule(), and ilLanguage\txt().

Referenced by ilPCLearningHistory\getPresentation().

                                                       : string
    {
        global $DIC;

        $lng = $DIC->language();
        $lng->loadLanguageModule("lhist");

        // @todo we need a ks element for this
        $content = '<div style="margin:5px" class="ilBox"><h3>' . $lng->txt("lhist_lhist") . '</h3><div class="il_Description_no_margin">' .
            $lng->txt("lhist_cont_placeholder_text") . '</div></div>';

        return $content;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilPCLearningHistoryGUI::initForm ( bool  $a_insert = false )

protected

Init learning history edit form.

Definition at line 90 of file class.ilPCLearningHistoryGUI.php.

References ilPageContentGUI\$ctrl, ilPageContentGUI\$lng, IL_CAL_DATE, ILIAS\Repository\lng(), ilMultiSelectInputGUI\setHeight(), ilRadioGroupInputGUI\setValue(), and ilLanguage\txt().

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

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

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

        // duration
        $du = new ilDateDurationInputGUI($lng->txt("lhist_period"), "period");
        if (!$a_insert) {
            if ($this->content_obj->getFrom() != "") {
                $du->setStart(new ilDate($this->content_obj->getFrom(), IL_CAL_DATE));
            }
            if ($this->content_obj->getTo() != "") {
                $du->setEnd(new ilDate($this->content_obj->getTo(), IL_CAL_DATE));
            }
        }
        $du->setAllowOpenIntervals(true);
        $form->addItem($du);

        //
        $radg = new ilRadioGroupInputGUI($lng->txt("lhist_type_of_achievement"), "mode");
        $radg->setValue("0");
        $op1 = new ilRadioOption($lng->txt("lhist_all"), "0");
        $radg->addOption($op1);
        $op2 = new ilRadioOption($lng->txt("lhist_selected"), "1");
        $radg->addOption($op2);
        $form->addItem($radg);


        // select type
        $options = [];
        foreach ($this->service->provider()->getAllProviders(true) as $p) {
            $options[get_class($p)] = $p->getName();
        }
        $si = new ilMultiSelectInputGUI($lng->txt(""), "class");
        $si->setHeight(130);
        if (!$a_insert) {
            $si->setValue($this->content_obj->getClasses());
            if (count($this->content_obj->getClasses()) > 0) {
                $radg->setValue(1);
            }
        }
        $si->setOptions($options);
        $op2->addSubItem($si);

        if ($a_insert) {
            $form->addCommandButton("create_lhist", $this->lng->txt("insert"));
            $form->addCommandButton("cancelCreate", $this->lng->txt("cancel"));
        } else {
            $form->addCommandButton("update", $this->lng->txt("save"));
            $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()

ilPCLearningHistoryGUI::insert

(

?ilPropertyFormGUI

$a_form = null

)

Insert learning history form.

Definition at line 63 of file class.ilPCLearningHistoryGUI.php.

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

Referenced by create().

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

        $this->displayValidationError();

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

ilPCLearningHistoryGUI::update

(

)

Update learning history component.

Definition at line 185 of file class.ilPCLearningHistoryGUI.php.

References ILIAS\Repository\ctrl(), edit(), ilPropertyFormGUI\getInput(), ilPropertyFormGUI\getItemByPostVar(), IL_CAL_DATE, initForm(), and ILIAS\Repository\lng().

                            : void
    {
        $form = $this->initForm();
        if ($form->checkInput()) {
            $this->setAttributesFromInput($form);
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                $this->tpl->setOnScreenMessage('info', $this->lng->txt("msg_obj_modified"), 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

$service

ilLearningHistoryService ilPCLearningHistoryGUI::$service

protected

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

$ui

ILIAS DI UIServices ilPCLearningHistoryGUI::$ui

protected

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

$user

ilObjUser ilPCLearningHistoryGUI::$user

protected

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

---

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

• components/ILIAS/LearningHistory/classes/class.ilPCLearningHistoryGUI.php