class.ilTrObjectUsersPropsTableGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2010 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("./Services/Tracking/classes/class.ilLPTableBaseGUI.php");

class ilTrObjectUsersPropsTableGUI extends ilLPTableBaseGUI
{
    protected $user_fields; // array
    protected $filter; // array
    protected $in_course; // int
    protected $in_group; // int
    protected $has_edit; // bool
    protected $has_collection; // bool
    protected $has_multi; // bool
    
    public function __construct($a_parent_obj, $a_parent_cmd, $a_obj_id, $a_ref_id, $a_print_view = false)
    {
        global $ilCtrl, $ilUser, $tree, $rbacsystem;
        
        $this->setId("troup");
        $this->obj_id = $a_obj_id;
        $this->ref_id = $a_ref_id;
        $this->type = ilObject::_lookupType($a_obj_id);

        $this->in_group = $tree->checkForParentType($this->ref_id, "grp");
        if ($this->in_group) {
            $this->in_group = ilObject::_lookupObjId($this->in_group);
        } else {
            $this->in_course = $tree->checkForParentType($this->ref_id, "crs");
            if ($this->in_course) {
                $this->in_course = ilObject::_lookupObjId($this->in_course);
            }
        }
        
        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->parseTitle($a_obj_id, "trac_participants");

        if ($a_print_view) {
            $this->setPrintMode(true);
        }
        
        if (!$this->getPrintMode()) {
            // see ilObjCourseGUI::addMailToMemberButton()
            include_once "Services/Mail/classes/class.ilMail.php";
            $mail = new ilMail($ilUser->getId());
            if ($rbacsystem->checkAccess("internal_mail", $mail->getMailObjectReferenceId())) {
                $this->addMultiCommand("mailselectedusers", $this->lng->txt("send_mail"));
            }
            $this->lng->loadLanguageModule('user');
            $this->addMultiCommand(
                'addToClipboard',
                $this->lng->txt('clipboard_add_btn')
            );
            $this->addColumn("", "", 1);
            $this->has_multi = true;
        }

        $labels = $this->getSelectableColumns();
        foreach ($this->getSelectedColumns() as $c) {
            $first = $c;
            
            // list cannot be sorted by udf fields (separate query)
            // because of pagination only core fields can be sorted
            $sort_id = (substr($c, 0, 4) == "udf_") ? "" : $c;
            
            $this->addColumn($labels[$c]["txt"], $sort_id);
        }
        
        if (!$this->getPrintMode()) {
            $this->addColumn($this->lng->txt("actions"), "");
        }
        $this->setSelectAllCheckbox('uid');
        $this->setExternalSorting(true);
        $this->setExternalSegmentation(true);
        $this->setEnableHeader(true);
        $this->setFormAction($ilCtrl->getFormActionByClass(get_class($this)));
        $this->setRowTemplate("tpl.object_users_props_row.html", "Services/Tracking");
        $this->setEnableTitle(true);
        $this->setShowTemplates(true);
        $this->setExportFormats(array(self::EXPORT_CSV, self::EXPORT_EXCEL));

        if ($first) {
            $this->setDefaultOrderField($first);
            $this->setDefaultOrderDirection("asc");
        }
        
        $this->initFilter();

        $this->getItems();
        
        // #13807
        include_once './Services/Tracking/classes/class.ilLearningProgressAccess.php';
        $this->has_edit = ilLearningProgressAccess::checkPermission('edit_learning_progress', $this->ref_id);
        
        /* currently not active, needs to be revised
        include_once "Services/Object/classes/class.ilObjectLP.php";
        include_once "Services/Tracking/classes/collection/class.ilLPCollection.php";
        $objlp = ilObjectLP::getInstance($this->obj_id);
        $this->has_collection = in_array($objlp->getCurrentMode(), ilLPCollection::getCollectionModes());
        */
    }
    
    public function getSelectableColumns()
    {
        if ($this->selectable_columns) {
            return $this->selectable_columns;
        }

        $cols = $this->getSelectableUserColumns($this->in_course, $this->in_group);
        $this->user_fields = $cols[1];
        $this->selectable_columns = $cols[0];
        
        return $this->selectable_columns;
    }
    
    public function getItems()
    {
        global $lng;
        
        $this->determineOffsetAndOrder();
        
        include_once("./Services/Tracking/classes/class.ilTrQuery.php");
        
        $additional_fields = $this->getSelectedColumns();

        // only if object is [part of] course/group
        $check_agreement = false;
        if ($this->in_course) {
            // privacy (if course agreement is activated)
            include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
            $privacy = ilPrivacySettings::_getInstance();
            if ($privacy->courseConfirmationRequired()) {
                $check_agreement = $this->in_course;
            }
        } elseif ($this->in_group) {
            // privacy (if group agreement is activated)
            include_once "Services/PrivacySecurity/classes/class.ilPrivacySettings.php";
            $privacy = ilPrivacySettings::_getInstance();
            if ($privacy->groupConfirmationRequired()) {
                $check_agreement = $this->in_group;
            }
        }

        $tr_data = ilTrQuery::getUserDataForObject(
            $this->ref_id,
            ilUtil::stripSlashes($this->getOrderField()),
            ilUtil::stripSlashes($this->getOrderDirection()),
            ilUtil::stripSlashes($this->getOffset()),
            ilUtil::stripSlashes($this->getLimit()),
            $this->getCurrentFilter(),
            $additional_fields,
            $check_agreement,
            $this->user_fields
        );
        
        if (count($tr_data["set"]) == 0 && $this->getOffset() > 0) {
            $this->resetOffset();
            $tr_data = ilTrQuery::getUserDataForObject(
                $this->ref_id,
                ilUtil::stripSlashes($this->getOrderField()),
                ilUtil::stripSlashes($this->getOrderDirection()),
                ilUtil::stripSlashes($this->getOffset()),
                ilUtil::stripSlashes($this->getLimit()),
                $this->getCurrentFilter(),
                $additional_fields,
                $check_agreement,
                $this->user_fields
            );
        }

        $this->setMaxCount($tr_data["cnt"]);
        $this->setData($tr_data["set"]);
    }
    
    
    public function initFilter()
    {
        global $lng;

        foreach ($this->getSelectableColumns() as $column => $meta) {
            // no udf!
            switch ($column) {
                case "firstname":
                case "lastname":
                case "mark":
                case "u_comment":
                case "institution":
                case "department":
                case "title":
                case "street":
                case "zipcode":
                case "city":
                case "country":
                case "email":
                case "matriculation":
                case "login":
                    if ($column != "mark" ||
                        ilObjectLP::supportsMark($this->type)) {
                        $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_TEXT, true, $meta["txt"]);
                        $this->filter[$column] = $item->getValue();
                    }
                    break;

                case "first_access":
                case "last_access":
                case "create_date":
                case 'status_changed':
                    $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_DATETIME_RANGE, true, $meta["txt"]);
                    $this->filter[$column] = $item->getDate();
                    break;
                
                case "birthday":
                    $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_DATE_RANGE, true, $meta["txt"]);
                    $this->filter[$column] = $item->getDate();
                    break;

                case "read_count":
                case "percentage":
                    $item = $this->addFilterItemByMetaType($column, ilTable2GUI::FILTER_NUMBER_RANGE, true, $meta["txt"]);
                    $this->filter[$column] = $item->getValue();
                    break;

                case "gender":
                    $item = $this->addFilterItemByMetaType("gender", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
                    $item->setOptions(array(
                        "" => $lng->txt("trac_all"),
                        "n" => $lng->txt("gender_n"),
                        "m" => $lng->txt("gender_m"),
                        "f" => $lng->txt("gender_f"),
                    ));
                    $this->filter["gender"] = $item->getValue();
                    break;

                case "sel_country":
                    $item = $this->addFilterItemByMetaType("sel_country", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);

                    $options = array();
                    include_once("./Services/Utilities/classes/class.ilCountry.php");
                    foreach (ilCountry::getCountryCodes() as $c) {
                        $options[$c] = $lng->txt("meta_c_" . $c);
                    }
                    asort($options);
                    $item->setOptions(array("" => $lng->txt("trac_all"))+$options);

                    $this->filter["sel_country"] = $item->getValue();
                    break;

                case "status":
                    include_once "Services/Tracking/classes/class.ilLPStatus.php";
                    $item = $this->addFilterItemByMetaType("status", ilTable2GUI::FILTER_SELECT, true, $meta["txt"]);
                    $item->setOptions(array("" => $lng->txt("trac_all"),
                        ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_NOT_ATTEMPTED),
                        ilLPStatus::LP_STATUS_IN_PROGRESS_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_IN_PROGRESS),
                        ilLPStatus::LP_STATUS_COMPLETED_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_COMPLETED),
                        ilLPStatus::LP_STATUS_FAILED_NUM+1 => $lng->txt(ilLPStatus::LP_STATUS_FAILED)));
                    $this->filter["status"] = $item->getValue();
                    if (is_numeric($this->filter["status"])) {
                        $this->filter["status"]--;
                    }
                    break;

                case "language":
                    $item = $this->addFilterItemByMetaType("language", ilTable2GUI::FILTER_LANGUAGE, true);
                    $this->filter["language"] = $item->getValue();
                    break;

                case "spent_seconds":
                    if (ilObjectLP::supportsSpentSeconds($this->type)) {
                        $item = $this->addFilterItemByMetaType("spent_seconds", ilTable2GUI::FILTER_DURATION_RANGE, true, $meta["txt"]);
                        $this->filter["spent_seconds"]["from"] = $item->getCombinationItem("from")->getValueInSeconds();
                        $this->filter["spent_seconds"]["to"] = $item->getCombinationItem("to")->getValueInSeconds();
                    }
                    break;
            }
        }
    }
    
    protected function fillRow($data)
    {
        global $ilCtrl, $lng, $objDefinition;
        
        if ($this->has_multi) {
            $this->tpl->setVariable("USER_ID", $data["usr_id"]);
        }
        
        foreach ($this->getSelectedColumns() as $c) {
            if (!(bool) $data["privacy_conflict"]) {
                if ($c == 'status' && $data[$c] != ilLPStatus::LP_STATUS_COMPLETED_NUM) {
                    $timing = $this->showTimingsWarning($this->ref_id, $data["usr_id"]);
                    if ($timing) {
                        if ($timing !== true) {
                            $timing = ": " . ilDatePresentation::formatDate(new ilDate($timing, IL_CAL_UNIX));
                        } else {
                            $timing = "";
                        }
                        $this->tpl->setCurrentBlock('warning_img');
                        $this->tpl->setVariable('WARNING_IMG', ilUtil::getImagePath('time_warn.svg'));
                        $this->tpl->setVariable('WARNING_ALT', $this->lng->txt('trac_time_passed') . $timing);
                        $this->tpl->parseCurrentBlock();
                    }
                }

                // #7694
                if ($c == 'login' && !$data["active"]) {
                    $this->tpl->setCurrentBlock('inactive_bl');
                    $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("inactive"));
                    $this->tpl->parseCurrentBlock();
                }
                
                $val = $this->parseValue($c, $data[$c], $this->type);
            } else {
                if ($c == 'login') {
                    $this->tpl->setCurrentBlock('inactive_bl');
                    $this->tpl->setVariable('TXT_INACTIVE', $lng->txt("status_no_permission"));
                    $this->tpl->parseCurrentBlock();
                }
                
                $val = "&nbsp;";
            }

            $this->tpl->setCurrentBlock("user_field");
            $this->tpl->setVariable("VAL_UF", $val);
            $this->tpl->parseCurrentBlock();
        }
        
        $ilCtrl->setParameterByClass("illplistofobjectsgui", "user_id", $data["usr_id"]);
        
        if (!$this->getPrintMode() && !(bool) $data["privacy_conflict"]) {
            // details for containers and collections
            if ($this->has_collection ||
                $objDefinition->isContainer($this->type)) {
                $this->tpl->setCurrentBlock("item_command");
                $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", "userdetails"));
                $this->tpl->setVariable("TXT_COMMAND", $lng->txt('details'));
                $this->tpl->parseCurrentBlock();
            }

            if ($this->has_edit) {
                $this->tpl->setCurrentBlock("item_command");
                $this->tpl->setVariable("HREF_COMMAND", $ilCtrl->getLinkTargetByClass("illplistofobjectsgui", "edituser"));
                $this->tpl->setVariable("TXT_COMMAND", $lng->txt('edit'));
                $this->tpl->parseCurrentBlock();
            }
        }

        $ilCtrl->setParameterByClass("illplistofobjectsgui", 'user_id', '');
    }

    protected function fillHeaderExcel(ilExcel $a_excel, &$a_row)
    {
        $labels = $this->getSelectableColumns();
        $cnt = 0;
        foreach ($this->getSelectedColumns() as $c) {
            $a_excel->setCell($a_row, $cnt++, $labels[$c]["txt"]);
        }
        
        $a_excel->setBold("A" . $a_row . ":" . $a_excel->getColumnCoord($cnt-1) . $a_row);
    }

    protected function fillRowExcel(ilExcel $a_excel, &$a_row, $a_set)
    {
        $cnt = 0;
        foreach ($this->getSelectedColumns() as $c) {
            if ($c != 'status') {
                $val = $this->parseValue($c, $a_set[$c], $this->type);
            } else {
                $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
            }
            $a_excel->setCell($a_row, $cnt++, $val);
        }
    }

    protected function fillHeaderCSV($a_csv)
    {
        $labels = $this->getSelectableColumns();
        foreach ($this->getSelectedColumns() as $c) {
            $a_csv->addColumn($labels[$c]["txt"]);
        }

        $a_csv->addRow();
    }

    protected function fillRowCSV($a_csv, $a_set)
    {
        foreach ($this->getSelectedColumns() as $c) {
            if ($c != 'status') {
                $val = $this->parseValue($c, $a_set[$c], $this->type);
            } else {
                $val = ilLearningProgressBaseGUI::_getStatusText((int) $a_set[$c]);
            }
            $a_csv->addColumn($val);
        }
        
        $a_csv->addRow();
    }
}