ilLPListOfSettingsGUI Class Reference

Class ilLPListOfSettingsGUI. More...

Inheritance diagram for ilLPListOfSettingsGUI:

Collaboration diagram for ilLPListOfSettingsGUI:

Public Member Functions
	__construct ($a_mode, $a_ref_id)
	executeCommand ()
	execute command More...
Public Member Functions inherited from ilLearningProgressBaseGUI
	__construct ($a_mode, $a_ref_id=0, $a_usr_id=0)
	isAnonymized ()
	getMode ()
	getRefId ()
	getObjId ()
	getUserId ()
	__getDefaultCommand ()
	__setSubTabs ($a_active)
	__buildFooter ()
	__buildHeader ()
	__insertPath (&$a_tpl, $a_ref_id)
	insert path More...
	__showImageByStatus (&$tpl, $a_status, $tpl_prefix="")
&	__initTableGUI ()
	__showObjectDetails (&$info, $item_id=0, $add_section=true)
	show details about current object. More...
	__appendUserInfo (&$info, $a_user)
	__appendLPDetails (&$info, $item_id, $user_id)
	__sort ($a_ids, $a_table, $a_field, $a_id_name)
	Function that sorts ids by a given table field using WHERE IN E.g: __sort(array(6,7),'usr_data','lastname','usr_id') => sorts by lastname. More...
	__getPercent ($max, $reached)
	__readItemStatusInfo ($a_items)
	__getLegendHTML (int $variant=ilLPStatusIcons::ICON_VARIANT_LONG)
	__showEditUser ($a_user_id, $a_ref_id, $a_cancel, $a_sub_id=false)
	__updateUser ($user_id, $obj_id)

Protected Member Functions
	show ()
	Show settings tables. More...
	initFormSettings ()
	Init property form. More...
	saveSettings ()
	Save learning progress settings. More...
	getTableByMode ()
	Get tables by mode. More...
	assign ()
	Save material assignment. More...
	deassign ()
	save mterial assignment More...
	groupMaterials ()
	Group materials. More...
	releaseMaterials ()
	saveObligatoryMaterials ()
	Save obligatory state per grouped materials. More...
	updateTLT ()
	getLPPathInfo ($a_ref_id, array &$a_res)
	Gather LP data about parent objects. More...
	handleLPUsageInfo ()
Protected Member Functions inherited from ilLearningProgressBaseGUI
	initEditUserForm ($a_user_id, $a_obj_id, $a_cancel=null)

Protected Attributes
	$obj_settings
	$obj_lp
Protected Attributes inherited from ilLearningProgressBaseGUI
	$anonymized
	$logger
	$tabs_gui

Additional Inherited Members
Static Public Member Functions inherited from ilLearningProgressBaseGUI
static	_showImageByStatus (&$tpl, $a_status, $tpl_prefix="")
	we need this public in table classes More...
static	_getImagePathForStatus ($a_status)
	Get image path for status. More...
static	_getStatusText ($a_status, $a_lng=null)
	Get status alt text. More...
static	__readStatus ($a_obj_id, $user_id)
static	isObjectOffline ($a_obj_id, $a_type=null)
Data Fields inherited from ilLearningProgressBaseGUI
	$tpl = null
	$ctrl = null
	$lng = null
	$ref_id = 0
	$mode = 0
const	LP_CONTEXT_PERSONAL_DESKTOP = 1
const	LP_CONTEXT_ADMINISTRATION = 2
const	LP_CONTEXT_REPOSITORY = 3
const	LP_CONTEXT_USER_FOLDER = 4
const	LP_CONTEXT_ORG_UNIT = 5
const	LP_ACTIVE_SETTINGS = 1
const	LP_ACTIVE_OBJECTS = 2
const	LP_ACTIVE_PROGRESS = 3
const	LP_ACTIVE_USERS = 5
const	LP_ACTIVE_SUMMARY = 6
const	LP_ACTIVE_OBJSTATACCESS = 7
const	LP_ACTIVE_OBJSTATTYPES = 8
const	LP_ACTIVE_OBJSTATDAILY = 9
const	LP_ACTIVE_OBJSTATADMIN = 10
const	LP_ACTIVE_MATRIX = 11

Detailed Description

Class ilLPListOfSettingsGUI.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

ilLPListOfSettingsGUI:

Definition at line 20 of file class.ilLPListOfSettingsGUI.php.

Constructor & Destructor Documentation

__construct()

ilLPListOfSettingsGUI::__construct	(		$a_mode,
			$a_ref_id
	)

Definition at line 25 of file class.ilLPListOfSettingsGUI.php.

References ILIAS\GlobalScreen\Provider\__construct(), ilObjectLP\getInstance(), and ilLearningProgressBaseGUI\getObjId().

    {
        parent::__construct($a_mode, $a_ref_id);
        
        $this->obj_settings = new ilLPObjSettings($this->getObjId());
        
        include_once './Services/Object/classes/class.ilObjectLP.php';
        $this->obj_lp = ilObjectLP::getInstance($this->getObjId());
    }

Here is the call graph for this function:

Member Function Documentation

assign()

ilLPListOfSettingsGUI::assign ( )

protected

Save material assignment.

Returns

void

Definition at line 213 of file class.ilLPListOfSettingsGUI.php.

References $_POST, ilLPStatusWrapper\_refreshStatus(), ilLearningProgressBaseGUI\getObjId(), and ilUtil\sendFailure().

    {
        if (!$_POST['item_ids']) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'show');
        }
        if (count($_POST['item_ids'])) {
            $collection = $this->obj_lp->getCollectionInstance();
            if ($collection && $collection->hasSelectableItems()) {
                $collection->activateEntries($_POST['item_ids']);
            }
            
            // #15045 - has to be done before LP refresh!
            $this->obj_lp->resetCaches();
            
            // refresh learning progress
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_refreshStatus($this->getObjId());
        }
        ilUtil::sendSuccess($this->lng->txt('trac_settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

deassign()

ilLPListOfSettingsGUI::deassign ( )

protected

save mterial assignment

Returns

void

Definition at line 240 of file class.ilLPListOfSettingsGUI.php.

References $_POST, ilLPStatusWrapper\_refreshStatus(), ilLearningProgressBaseGUI\getObjId(), and ilUtil\sendFailure().

    {
        if (!$_POST['item_ids']) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'show');
            return false;
        }
        if (count($_POST['item_ids'])) {
            $collection = $this->obj_lp->getCollectionInstance();
            if ($collection && $collection->hasSelectableItems()) {
                $collection->deactivateEntries($_POST['item_ids']);
            }
            
            // #15045 - has to be done before LP refresh!
            $this->obj_lp->resetCaches();
            
            // refresh learning progress
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_refreshStatus($this->getObjId());
        }
        ilUtil::sendSuccess($this->lng->txt('trac_settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

executeCommand()

ilLPListOfSettingsGUI::executeCommand

(

)

execute command

Definition at line 38 of file class.ilLPListOfSettingsGUI.php.

References ilLearningProgressBaseGUI\__getDefaultCommand().

    {
        switch ($this->ctrl->getNextClass()) {
            default:
                $cmd = $this->__getDefaultCommand();
                $this->$cmd();

        }
        return true;
    }

Here is the call graph for this function:

getLPPathInfo()

ilLPListOfSettingsGUI::getLPPathInfo (   $a_ref_id, array &  $a_res  )

protected

Gather LP data about parent objects.

Parameters

int	$a_ref_id
array	$a_res

Returns

bool

Definition at line 379 of file class.ilLPListOfSettingsGUI.php.

References $DIC, ilObjectLP\getInstance(), and ilObjectLP\isSupportedObjectType().

Referenced by handleLPUsageInfo().

    {
        global $DIC;

        $tree = $DIC['tree'];
        
        $has_lp_parents = false;
                
        $path = $tree->getNodePath($a_ref_id);
        array_shift($path);      // root
        foreach ($path as $node) {
            $supports_lp = ilObjectLP::isSupportedObjectType($node["type"]);
            
            if ($supports_lp || $has_lp_parents) {
                $a_res[$node["child"]]["node"] = array(
                    "type" => $node["type"]
                    ,"title" => $node["title"]
                    ,"obj_id" => $node["obj_id"]
                    ,"lp" => false
                    ,"active" => false
                );
            }
            
            if (
                $supports_lp &&
                $node["child"] != $a_ref_id) {
                $a_res[$node["child"]]["node"]["lp"] = true;
                $has_lp_parents = true;

                $parent_obj_id = $node['obj_id'];
                $parent_obj_lp = \ilObjectLP::getInstance($parent_obj_id);
                $parent_collection = $parent_obj_lp->getCollectionInstance();
                if (
                    $parent_collection &&
                    $parent_collection->hasSelectableItems() &&
                    $parent_collection->isAssignedEntry($a_ref_id)
                ) {
                    $a_res[$node['child']]['node']['active'] = true;
                }
            }
        }
        return $has_lp_parents;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTableByMode()

ilLPListOfSettingsGUI::getTableByMode ( )

protected

Get tables by mode.

Definition at line 198 of file class.ilLPListOfSettingsGUI.php.

References ilLearningProgressBaseGUI\getRefId(), and ilLPCollectionSettingsTableGUI\parse().

Referenced by saveSettings(), and show().

    {
        $collection = $this->obj_lp->getCollectionInstance();
        if ($collection && $collection->hasSelectableItems()) {
            include_once "Services/Tracking/classes/repository_statistics/class.ilLPCollectionSettingsTableGUI.php";
            $table = new ilLPCollectionSettingsTableGUI($this, 'show', $this->getRefId(), $this->obj_lp->getCurrentMode());
            $table->parse($collection);
            return $table->getHTML();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

groupMaterials()

ilLPListOfSettingsGUI::groupMaterials ( )

protected

Group materials.

Definition at line 267 of file class.ilLPListOfSettingsGUI.php.

References $_POST, ilLPStatusWrapper\_refreshStatus(), ilLearningProgressBaseGUI\getObjId(), and ilUtil\sendFailure().

    {
        if (!count((array) $_POST['item_ids'])) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'show');
        }
        
        $collection = $this->obj_lp->getCollectionInstance();
        if ($collection && $collection->hasSelectableItems()) {
            // Assign new grouping id
            $collection->createNewGrouping((array) $_POST['item_ids']);

            // refresh learning progress
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_refreshStatus($this->getObjId());
        }

        ilUtil::sendSuccess($this->lng->txt('trac_settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

handleLPUsageInfo()

ilLPListOfSettingsGUI::handleLPUsageInfo ( )

protected

Definition at line 423 of file class.ilLPListOfSettingsGUI.php.

References $_GET, $DIC, ilLearningProgressBaseGUI\$lng, $panel, ilLearningProgressBaseGUI\$ref_id, ilLearningProgressBaseGUI\$tpl, ilLink\_getLink(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilPanelGUI\getInstance(), getLPPathInfo(), ilUtil\getTypeIconPath(), and ilPanelGUI\PANEL_STYLE_SECONDARY.

Referenced by show().

    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilAccess = $DIC['ilAccess'];
        
        $ref_id = $_GET["ref_id"];
        if (!$ref_id) {
            $ref_id = $_REQUEST["ref_id"];
        }
        
        $coll = array();
        if ($ref_id &&
            $this->getLPPathInfo($ref_id, $coll)) {
            include_once "Services/Link/classes/class.ilLink.php";
            
            $tpl = new ilTemplate("tpl.lp_obj_settings_tree_info.html", true, true, "Services/Tracking");
            
            $margin = 0;
            $has_active = false;
            foreach ($coll as $parent_ref_id => $parts) {
                $node = $parts["node"];
                $params = array();
                if ($node["lp"]) {
                    if ($node["active"]) {
                        $tpl->touchBlock("parent_active_bl");
                        $has_active = true;
                    }
                    
                    $params["gotolp"] = 1;
                }
                
                if ($ilAccess->checkAccess("read", "", $parent_ref_id) &&
                    $parent_ref_id != $ref_id) { // #17170
                    $tpl->setCurrentBlock("parent_link_bl");
                    $tpl->setVariable("PARENT_LINK_TITLE", $node["title"]);
                    $tpl->setVariable("PARENT_URL", ilLink::_getLink($parent_ref_id, $node["type"], $params));
                    $tpl->parseCurrentBlock();
                } else {
                    $tpl->setCurrentBlock("parent_nolink_bl");
                    $tpl->setVariable("PARENT_NOLINK_TITLE", $node["title"]);
                    $tpl->parseCurrentBlock();
                }
                
                $tpl->setCurrentBlock("parent_usage_bl");
                $tpl->setVariable("PARENT_TYPE_URL", ilUtil::getTypeIconPath($node["type"], $node["obj_id"]));
                $tpl->setVariable("PARENT_TYPE_ALT", $lng->txt("obj_" . $node["type"]));
                
                $tpl->setVariable("PARENT_STYLE", $node["lp"]
                    ? ''
                    : ' class="ilLPParentInfoListLPUnsupported"');
                $tpl->setVariable("MARGIN", $margin);
                $tpl->parseCurrentBlock();
                
                $margin += 25;
            }
            
            if ($has_active) {
                $tpl->setVariable("LEGEND", sprintf(
                    $lng->txt("trac_lp_settings_info_parent_legend"),
                    ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id))
                ));
            }
            
            include_once "Services/UIComponent/Panel/classes/class.ilPanelGUI.php";
            $panel = ilPanelGUI::getInstance();
            $panel->setPanelStyle(ilPanelGUI::PANEL_STYLE_SECONDARY);
            $panel->setHeading($lng->txt("trac_lp_settings_info_parent_container"));
            $panel->setBody($tpl->get());
            
            return $panel->getHTML();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormSettings()

ilLPListOfSettingsGUI::initFormSettings ( )

protected

Init property form.

Returns

ilPropertyFormGUI $form

this is neccessary for cmix object

See also

ilCmiXapiLP::initModeOptions()

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

References ilObjUserTracking\_getValidTimeSpan(), ilLPObjSettings\LP_MODE_VISITS, ilFormPropertyGUI\setRequired(), ilNumberInputGUI\setSize(), and ilRadioOption\setValue().

Referenced by saveSettings(), and show().

    {
        include_once './Services/Form/classes/class.ilPropertyFormGUI.php';
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('tracking_settings'));
        $form->setFormAction($this->ctrl->getFormAction($this));

        // Mode
        $mod = new ilRadioGroupInputGUI($this->lng->txt('trac_mode'), 'modus');
        $mod->setRequired(true);
        $mod->setValue($this->obj_lp->getCurrentMode());
        $form->addItem($mod);

        if (method_exists($this->obj_lp, 'initModeOptions')) {
            $this->obj_lp->initModeOptions($mod);
        } else {
            foreach ($this->obj_lp->getValidModes() as $mode_key) {
                $opt = new ilRadioOption(
                    $this->obj_lp->getModeText($mode_key),
                    $mode_key,
                    $this->obj_lp->getModeInfoText($mode_key)
            );
                $opt->setValue($mode_key);
                $mod->addOption($opt);

                // :TODO: Subitem for visits ?!
                if ($mode_key == ilLPObjSettings::LP_MODE_VISITS) {
                    $vis = new ilNumberInputGUI($this->lng->txt('trac_visits'), 'visits');
                    $vis->setSize(3);
                    $vis->setMaxLength(4);
                    $vis->setInfo(sprintf(
                        $this->lng->txt('trac_visits_info'),
                        ilObjUserTracking::_getValidTimeSpan()
                ));
                    $vis->setRequired(true);
                    $vis->setValue($this->obj_settings->getVisits());
                    $opt->addSubItem($vis);
                }
            }
        }
        
        $form->addCommandButton('saveSettings', $this->lng->txt('save'));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

releaseMaterials()

ilLPListOfSettingsGUI::releaseMaterials ( )

protected

Definition at line 291 of file class.ilLPListOfSettingsGUI.php.

References $_POST, ilLPStatusWrapper\_refreshStatus(), ilLearningProgressBaseGUI\getObjId(), and ilUtil\sendFailure().

    {
        if (!count((array) $_POST['item_ids'])) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'show');
        }

        $collection = $this->obj_lp->getCollectionInstance();
        if ($collection && $collection->hasSelectableItems()) {
            $collection->releaseGrouping((array) $_POST['item_ids']);
            
            // refresh learning progress
            include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
            ilLPStatusWrapper::_refreshStatus($this->getObjId());
        }
        
        ilUtil::sendSuccess($this->lng->txt('trac_settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

saveObligatoryMaterials()

ilLPListOfSettingsGUI::saveObligatoryMaterials ( )

protected

Save obligatory state per grouped materials.

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

References $_POST, Vendor\Package\$e, ilLPStatusWrapper\_refreshStatus(), ilLearningProgressBaseGUI\getObjId(), ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        if (!is_array((array) $_POST['grp'])) {
            ilUtil::sendFailure($this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, 'show');
        }

        try {
            $collection = $this->obj_lp->getCollectionInstance();
            if ($collection && $collection->hasSelectableItems()) {
                $collection->saveObligatoryMaterials((array) $_POST['grp']);

                // refresh learning progress
                include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
                ilLPStatusWrapper::_refreshStatus($this->getObjId());
            }

            ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'show');
        } catch (UnexpectedValueException $e) {
            ilUtil::sendFailure($this->lng->txt('trac_grouped_material_obligatory_err'), true);
            ilUtil::sendInfo($this->lng->txt('err_check_input'), true);
            $this->ctrl->redirect($this, 'show');
        }
    }

Here is the call graph for this function:

saveSettings()

ilLPListOfSettingsGUI::saveSettings ( )

protected

Save learning progress settings.

Returns

void

this is neccessary for cmix object

See also

ilCmiXapiLP::fetchModeOption()

Definition at line 133 of file class.ilLPListOfSettingsGUI.php.

References getTableByMode(), initFormSettings(), ilLPObjSettings\LP_MODE_MANUAL_BY_TUTOR, ilLPObjSettings\LP_MODE_VISITS, ilUtil\sendFailure(), and ilUtil\sendInfo().

    {
        $form = $this->initFormSettings();
        if ($form->checkInput()) {
            // anything changed?
            
            // mode
            if (method_exists($this->obj_lp, 'fetchModeOption')) {
                $new_mode = (int) $this->obj_lp->fetchModeOption($form);
            } else {
                $new_mode = (int) $form->getInput('modus');
            }
            $old_mode = $this->obj_lp->getCurrentMode();
            $mode_changed = ($old_mode != $new_mode);
            
            // visits
            $new_visits = null;
            $visits_changed = null;
            if ($new_mode == ilLPObjSettings::LP_MODE_VISITS) {
                $new_visits = (int) $form->getInput('visits');
                $old_visits = $this->obj_settings->getVisits();
                $visits_changed = ($old_visits != $new_visits);
            }
            
            if ($mode_changed) {
                // delete existing collection
                $collection = $this->obj_lp->getCollectionInstance();
                if ($collection) {
                    $collection->delete();
                }
            }
            
            $refresh_lp = ($mode_changed || $visits_changed);
            
            // has to be done before LP refresh!
            $this->obj_lp->resetCaches();
            
            $this->obj_settings->setMode($new_mode);
            $this->obj_settings->setVisits($new_visits);
            $this->obj_settings->update($refresh_lp);
            
            if ($mode_changed &&
                $this->obj_lp->getCollectionInstance() &&
                $new_mode != ilLPObjSettings::LP_MODE_MANUAL_BY_TUTOR) { // #14819
                ilUtil::sendInfo($this->lng->txt('trac_edit_collection'), true);
            }
            ilUtil::sendSuccess($this->lng->txt('trac_settings_saved'), true);
            $this->ctrl->redirect($this, 'show');
        }

        $form->setValuesByPost();
        ilUtil::sendFailure($this->lng->txt('err_check_input'));

        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.lp_obj_settings.html', 'Services/Tracking');
        $this->tpl->setVariable('PROP_FORM', $form->getHTML());
        $this->tpl->setVariable('COLLECTION_TABLE', $this->getTableByMode());
    }

Here is the call graph for this function:

show()

ilLPListOfSettingsGUI::show ( )

protected

Show settings tables.

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

References $DIC, getTableByMode(), handleLPUsageInfo(), initFormSettings(), and ilUtil\sendInfo().

    {
        global $DIC;

        $ilHelp = $DIC['ilHelp'];

        $ilHelp->setSubScreenId("trac_settings");
        
        $info = $this->obj_lp->getSettingsInfo();
        if ($info) {
            ilUtil::sendInfo($info);
        }

        $form = $this->initFormSettings();
        $this->tpl->setContent(
            $this->handleLPUsageInfo() .
            $form->getHTML() .
            $this->getTableByMode()
        );
    }

Here is the call graph for this function:

updateTLT()

ilLPListOfSettingsGUI::updateTLT ( )

protected

Definition at line 340 of file class.ilLPListOfSettingsGUI.php.

References $_POST, ilLPStatusWrapper\_refreshStatus(), and ilLearningProgressBaseGUI\getObjId().

    {
        include_once "Services/MetaData/classes/class.ilMD.php";
        foreach ($_POST['tlt'] as $item_id => $item) {
            $md_obj = new ilMD($this->getObjId(), $item_id, 'st');
            if (!is_object($md_section = $md_obj->getEducational())) {
                $md_section = $md_obj->addEducational();
                $md_section->save();
            }
            $md_section->setPhysicalTypicalLearningTime(
                (int) $item['mo'],
                (int) $item['d'],
                (int) $item['h'],
                (int) $item['m'],
                0
            );
            $md_section->update();
        }
        
        // refresh learning progress
        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");
        ilLPStatusWrapper::_refreshStatus($this->getObjId());
        
        ilUtil::sendSuccess($this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'show');
    }

Here is the call graph for this function:

Field Documentation

$obj_lp

ilLPListOfSettingsGUI::$obj_lp

protected

Definition at line 23 of file class.ilLPListOfSettingsGUI.php.

$obj_settings

ilLPListOfSettingsGUI::$obj_settings

protected

Definition at line 22 of file class.ilLPListOfSettingsGUI.php.

---

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

• Services/Tracking/classes/repository_statistics/class.ilLPListOfSettingsGUI.php