ilPCLearningHistoryGUI Class Reference

GUI class for learning history page content. More...

Inheritance diagram for ilPCLearningHistoryGUI:

Collaboration diagram for ilPCLearningHistoryGUI:

Public Member Functions
	__construct (ilPageObject $a_pg_obj, ilPCLearningHistory $a_content_obj=null, $a_hier_id="", $a_pc_id="")
	Constructor. More...
	executeCommand ()
	execute command More...
	insert (ilPropertyFormGUI $a_form=null)
	Insert learning history form. More...
	edit (ilPropertyFormGUI $a_form=null)
	Edit skills form. More...
	create ()
	Create new learning history component. More...
	update ()
	Update learning history component. More...
Public Member Functions inherited from ilPageContentGUI
	__construct ($a_pg_obj, $a_content_obj, $a_hier_id=0, $a_pc_id="")
	Constructor @access public. More...
	setContentObject ($a_val)
	Set content object. More...
	getContentObject ()
	Get content object. More...
	setPage ($a_val)
	Set page. More...
	getPage ()
	Get page. More...
	setPageConfig ($a_val)
	Set Page Config. More...
	getPageConfig ()
	Get Page Config. More...
	setStyleId ($a_styleid)
	Set Style Id. More...
	getStyleId ()
	Get Style Id. More...
	getStyle ()
	Get style object. More...
	getCharacteristicsOfCurrentStyle ($a_type)
	Get characteristics of current style. More...
	setCharacteristics ($a_chars)
	Set Characteristics. More...
	getCharacteristics ()
	Get characteristics. More...
	getHierId ()
	get hierarchical id in dom object More...
	setHierId ($a_hier_id)
	get hierarchical id in dom object More...
	getBBMenu ($a_ta_name="par_content")
	Get the bb menu incl. More...
	delete ()
	delete content element More...
	moveAfter ()
	move content element after another element More...
	moveBefore ()
	move content element before another element More...
	splitPage ()
	split page to new page at specified position More...
	splitPageNext ()
	split page to next page at specified position More...
	displayValidationError ()
	display validation errors More...
	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 ($a_type)
	Get table templates. More...

Static Public Member Functions
static	getPlaceholderPresentation ()
	Get placeholder presentation. More...
Static Public Member Functions inherited from ilPageContentGUI
static	_getCommonBBButtons ()
	Get common bb buttons. More...

Protected Member Functions
	initForm ($a_insert=false)
	Init learning history edit form. More...
Protected Member Functions inherited from ilPageContentGUI
	redirectToParent ($hier_id="")
	Redirect to parent. More...
	getParentReturn ($hier_id="")

Protected Attributes
	$user
	$ui
	$service
Protected Attributes inherited from ilPageContentGUI
	$error
	$log

Additional Inherited Members
Data Fields inherited from ilPageContentGUI
	$content_obj
	$tpl
	$lng
	$ctrl
	$pg_obj
	$hier_id
	$dom
	$updated
	$target_script
	$return_location
	$page_config = null
Static Public Attributes inherited from ilPageContentGUI
static	$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	$common_bb_buttons

Detailed Description

GUI class for learning history page content.

Handles user commands on skills data

Author

killi.nosp@m.n@le.nosp@m.ifos..nosp@m.com

@ilCtrl_isCalledBy ilPCLearningHistoryGUI: ilPageEditorGUI

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

Constructor & Destructor Documentation

__construct()

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

Constructor.

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

    {
        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();
    }

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

Here is the call graph for this function:

Member Function Documentation

create()

ilPCLearningHistoryGUI::create

(

)

Create new learning history component.

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

    {
        $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();
        return $this->insert($form);
    }

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

Here is the call graph for this function:

edit()

ilPCLearningHistoryGUI::edit

(

ilPropertyFormGUI

$a_form = null

)

Edit skills form.

Parameters

ilPropertyFormGUI

$a_form

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

    {
        $tpl = $this->tpl;
 
        $this->displayValidationError();
 
        if (!$a_form) {
            $a_form = $this->initForm();
        }
        $tpl->setContent($a_form->getHTML());
    }

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and initForm().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilPCLearningHistoryGUI::executeCommand

(

)

execute command

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

    {
        // 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:
                $ret = $this->$cmd();
                break;
        }
 
        return $ret;
    }

References $ret.

getPlaceholderPresentation()

static ilPCLearningHistoryGUI::getPlaceholderPresentation ( )

static

Get placeholder presentation.

Parameters

return

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

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

References $DIC, and ilPageContentGUI\$lng.

initForm()

ilPCLearningHistoryGUI::initForm (   $a_insert = false )

protected

Init learning history edit form.

Parameters

bool

$a_insert

Returns

ilPropertyFormGUI

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

    {
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
        $lng = $this->lng;
 
        include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
        $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();
        $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;
    }

References ilPageContentGUI\$ctrl, $ilUser, ilPageContentGUI\$lng, $si, $user, and IL_CAL_DATE.

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

Here is the caller graph for this function:

insert()

ilPCLearningHistoryGUI::insert

(

ilPropertyFormGUI

$a_form = null

)

Insert learning history form.

Parameters

ilPropertyFormGUI

$a_form

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

    {
        $tpl = $this->tpl;
 
        $this->displayValidationError();
 
        if (!$a_form) {
            $a_form = $this->initForm(true);
        }
        $tpl->setContent($a_form->getHTML());
    }

References ilPageContentGUI\$tpl, ilPageContentGUI\displayValidationError(), and initForm().

Referenced by create().

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 229 of file class.ilPCLearningHistoryGUI.php.

    {
        $form = $this->initForm();
        if ($form->checkInput()) {
            $this->setAttributesFromInput($form);
            $this->updated = $this->pg_obj->update();
            if ($this->updated === true) {
                ilUtil::sendInfo($this->lng->txt("msg_obj_modified"), true);
                $this->ctrl->returnToParent($this, "jump" . $this->hier_id);
            }
        }
 
        $this->pg_obj->addHierIDs();
        $form->setValuesByPost();
        return $this->edit($form);
    }

References edit(), initForm(), and ilUtil\sendInfo().

Here is the call graph for this function:

Field Documentation

$service

ilPCLearningHistoryGUI::$service

protected

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

$ui

ilPCLearningHistoryGUI::$ui

protected

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

$user

ilPCLearningHistoryGUI::$user

protected

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

Referenced by initForm().

---

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

• Services/LearningHistory/classes/class.ilPCLearningHistoryGUI.php