class.ilLPObjectStatisticsLPTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=0);

class ilLPObjectStatisticsLPTableGUI extends ilLPTableBaseGUI
{
    protected array $types = array("min", "avg", "max");
    protected array $status = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM,
                                    ilLPStatus::LP_STATUS_IN_PROGRESS_NUM,
                                    ilLPStatus::LP_STATUS_COMPLETED_NUM,
                                    ilLPStatus::LP_STATUS_FAILED_NUM
    );
    protected bool $is_chart = false;
    protected bool $is_details = false;
    protected array $chart_data = array();
    protected ?array $preselected;
    protected array $status_map = [];

    public function __construct(
        ?object $a_parent_obj,
        string $a_parent_cmd,
        array $a_preselect = null,
        bool $a_is_chart = false,
        bool $a_is_details = false
    ) {
        $this->preselected = $a_preselect;
        $this->is_chart = $a_is_chart;
        $this->is_details = $a_is_details;

        $this->setId("lpobjstatlptbl");
        parent::__construct($a_parent_obj, $a_parent_cmd);
    }

    public function init(): void
    {
        if (!$this->is_details) {
            $this->setShowRowsSelector(true);
            $this->addColumn("", "", "1%", true);
            $this->addColumn($this->lng->txt("trac_title"), "title");
            $all_columns = $this->getSelectableColumns();
            foreach ($this->getSelectedColumns() as $col_name => $col_info) {
                $column_definition = $all_columns[$col_name];
                $this->addColumn(
                    $column_definition['txt'],
                    $column_definition['sortable'] ? $column_definition['field'] : '',
                    $column_definition['width']
                );
            }
        } else {
            $this->setLimit(20);
            $this->setShowRowsSelector(false);     // see #35492
            $this->addColumn($this->lng->txt("trac_figure"));
        }
        $this->initFilter();

        if (strpos($this->filter["yearmonth"], "-") === false) {
            foreach ($this->getMonthsYear(
                $this->filter["yearmonth"]
            ) as $num => $caption) {
                if ($this->is_details) {
                    $this->addColumn($caption);     // see #35492
                } else {
                    $this->addColumn($caption, "month_" . $num);
                }
            }
        } else {
            foreach ($this->types as $type) {
                if ($type != "avg") {
                    $caption = " " . $this->lng->txt(
                        "trac_object_stat_lp_" . $type
                    );
                } else {
                    $caption = " &#216;";
                }
                $this->addColumn(
                    $this->lng->txt("trac_members_short") . $caption,
                    "mem_cnt_" . $type
                );
            }

            $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT);

            foreach ($this->status as $status) {
                $icon = $icons->renderIconForStatus($status);

                foreach ($this->types as $type) {
                    if ($type != "avg") {
                        $caption = $icon . " " . $this->lng->txt(
                            "trac_object_stat_lp_" . $type
                        );
                    } else {
                        $caption = $icon . " &#216;";
                    }
                    $this->addColumn($caption, $status . "_" . $type);
                }
            }
        }

        if (!$this->is_details) {
            $this->setTitle($this->lng->txt("trac_object_stat_lp"));

            // $this->setSelectAllCheckbox("item_id");
            $this->addMultiCommand(
                "showLearningProgressGraph",
                $this->lng->txt("trac_show_graph")
            );
            $this->setResetCommand("resetLearningProgressFilter");
            $this->setFilterCommand("applyLearningProgressFilter");
        }

        $this->setFormAction(
            $this->ctrl->getFormAction(
                $this->getParentObject(),
                $this->getParentCmd()
            )
        );
        $this->setRowTemplate(
            "tpl.lp_object_statistics_lp_row.html",
            "Services/Tracking"
        );
        $this->setEnableHeader(true);
        $this->setEnableNumInfo(true);
        $this->setEnableTitle(true);
        $this->setDefaultOrderField("title");
        $this->setDefaultOrderDirection("asc");

        $this->status_map = array(ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => "not_attempted",
                                  ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => "in_progress",
                                  ilLPStatus::LP_STATUS_COMPLETED_NUM => "completed",
                                  ilLPStatus::LP_STATUS_FAILED_NUM => "failed"
        );
    }

    public function loadItems(): void
    {
        if ($this->is_details) {
            $this->getDetailItems($this->preselected[0]);
        } else {
            $this->initLearningProgressDetailsLayer();
            $this->getItems();
        }
    }
    public function getSelectableColumns(): array
    {
        if ($this->is_details) {
            return [];
        }
        $columns = [];
        $columns['obj_id'] = [
            'field' => 'obj_id',
            'txt' => $this->lng->txt('object_id'),
            'default' => false,
            'optional' => true,
            'sortable' => true,
            'width' => '5%'
        ];
        $columns['reference_ids'] = [
            'field' => 'reference_ids',
            'txt' => $this->lng->txt('trac_reference_ids_column'),
            'default' => false,
            'optional' => true,
            'sortable' => true,
            'width' => '5%'
        ];
        $columns['paths'] = [
            'field' => 'paths',
            'txt' => $this->lng->txt('trac_paths'),
            'default' => false,
            'optional' => true,
            'sortable' => false,
            'width' => '25%'
        ];
        return $columns;
    }


    public function numericOrdering(string $a_field): bool
    {
        $alphabetic_ordering = [
            'title'
        ];
        if (!in_array($a_field, $alphabetic_ordering)) {
            return true;
        }
        return false;
    }

    protected function isForwardingToFormDispatcher(): bool
    {
        return true;
    }


    public function initFilter(): void
    {
        $this->setDisableFilterHiding(true);

        // object type selection
        $this->filter["type"] = "crs";

        // title/description
        $ti = new ilTextInputGUI(
            $this->lng->txt("trac_title_description"),
            "query"
        );
        $ti->setMaxLength(64);
        $ti->setSize(20);
        $this->addFilterItem($ti);
        $ti->readFromSession();
        $this->filter["query"] = $ti->getValue();

        // year/month
        $si = new ilSelectInputGUI(
            $this->lng->txt("year") . " / " . $this->lng->txt("month"),
            "yearmonth"
        );
        $si->setOptions($this->getMonthsFilter());
        $this->addFilterItem($si);
        $si->readFromSession();
        if (!$si->getValue()) {
            $si->setValue(date("Y-m"));
        }
        $this->filter["yearmonth"] = $si->getValue();

        if (!strpos($this->filter["yearmonth"], "-")) {
            $si = new ilSelectInputGUI(
                $this->lng->txt("trac_figure"),
                "figure"
            );
            $options = array(
                "mem_cnt_max" => $this->lng->txt(
                    "members"
                ) . " " . $this->lng->txt("trac_object_stat_lp_max"),
                "mem_cnt_avg" => $this->lng->txt("members") . " &#216;",
                // we are using the db column names here (not the lp constants)!
                "in_progress_max" => ilLearningProgressBaseGUI::_getStatusText(
                    ilLPStatus::LP_STATUS_IN_PROGRESS_NUM
                ) . " " . $this->lng->txt("trac_object_stat_lp_max"),
                "in_progress_avg" => ilLearningProgressBaseGUI::_getStatusText(
                    ilLPStatus::LP_STATUS_IN_PROGRESS_NUM
                ) . " &#216;"
            );
            $si->setOptions($options);
            $this->addFilterItem($si);
            $si->readFromSession();
            if (!$si->getValue()) {
                $si->setValue("mem_cnt_max");
            }
            $this->filter["measure"] = $si->getValue();
        }

        $this->filter = $this->initRepositoryFilter($this->filter);

        if ($this->is_details) {
            $this->filters = array();
        }
    }

    public function getItems()
    {
        $data = array();
        $all_status = array_merge(array("mem_cnt"), $this->status);

        $objects = $this->searchObjects(
            $this->getCurrentFilter(true),
            "read",
            null,
            false
        );
        if ($objects) {
            $objects = array_keys($objects);

            $yearmonth = explode("-", $this->filter["yearmonth"]);
            if (sizeof($yearmonth) == 1) {
                foreach (ilTrQuery::getObjectLPStatistics(
                    $objects,
                    $yearmonth[0]
                ) as $item) {
                    $obj_id = $item["obj_id"];
                    if (!isset($data[$obj_id])) {
                        $data[$obj_id]["obj_id"] = $obj_id;
                        $data[$obj_id]["title"] = ilObject::_lookupTitle(
                            $obj_id
                        );
                        $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                    }
                    $measure_type = substr($this->filter["measure"], -3);
                    $measure_field = substr($this->filter["measure"], 0, -4);
                    $value = $item[$measure_field . "_" . $measure_type];
                    $idx = $item["yyyy"] . "-" . str_pad(
                        $item["mm"],
                        2,
                        "0",
                        STR_PAD_LEFT
                    );
                    $data[$obj_id]["month_" . $idx] = $value;
                }

                if ($this->is_chart) {
                    // get data for single days (used in chart display)
                    foreach (array_keys(
                        $this->getMonthsYear($yearmonth[0])
                    ) as $num) {
                        $num_string = explode('-', $num);
                        $num = (int) array_pop($num_string);
                        foreach (ilTrQuery::getObjectLPStatistics(
                            $objects,
                            $yearmonth[0],
                            $num,
                            true
                        ) as $item) {
                            $idx = $yearmonth[0] .
                                "-" . str_pad(
                                    (string) $num,
                                    2,
                                    "0",
                                    STR_PAD_LEFT
                                ) .
                                "-" . str_pad(
                                    $item["dd"],
                                    2,
                                    "0",
                                    STR_PAD_LEFT
                                );
                            $this->chart_data[$item["obj_id"]][$idx] = $item;
                        }
                    }
                }
            } else {
                // get data aggregated for month
                foreach (ilTrQuery::getObjectLPStatistics(
                    $objects,
                    $yearmonth[0],
                    (int) $yearmonth[1]
                ) as $item) {
                    $obj_id = $item["obj_id"];
                    if (!isset($data[$obj_id])) {
                        $data[$obj_id]["obj_id"] = $obj_id;
                        $data[$obj_id]["title"] = ilObject::_lookupTitle(
                            $obj_id
                        );
                        $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                        $this->initRow($data[$obj_id]);
                    }

                    foreach ($all_status as $status) {
                        // status-id to field name
                        if (is_numeric($status)) {
                            $field = $this->status_map[$status];
                        } else {
                            $field = $status;
                        }

                        // aggregated fields
                        foreach ($this->types as $type) {
                            $value = $item[$field . "_" . $type];
                            $data[$obj_id][$status . "_" . $type] = $value;
                        }
                    }
                }

                if ($this->is_chart) {
                    // get data for single days (used in chart display)
                    foreach (ilTrQuery::getObjectLPStatistics(
                        $objects,
                        $yearmonth[0],
                        (int) $yearmonth[1],
                        true
                    ) as $item) {
                        $this->chart_data[$item["obj_id"]][$item["dd"]] = $item;
                    }
                }
            }

            // add objects with no usage data
            foreach ($objects as $obj_id) {
                if (!isset($data[$obj_id])) {
                    $data[$obj_id]["obj_id"] = $obj_id;
                    $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                    $data[$obj_id]['reference_ids'] = $this->findReferencesForObjId($obj_id);
                }
            }
        }
        $this->setData($data);
    }

    protected function getDetailItems(int $a_obj_id): void
    {
        $data = array();
        $all_status = array_merge(array("mem_cnt"), $this->status);

        foreach (ilTrQuery::getObjectLPStatistics(
            array($a_obj_id),
            $this->filter["yearmonth"]
        ) as $item) {
            $month = "month_" . $item["yyyy"] . "-" . str_pad(
                $item["mm"],
                2,
                "0",
                STR_PAD_LEFT
            );

            foreach ($all_status as $status) {
                // status-id to field name
                if ($status != "mem_cnt") {
                    $field = $this->status_map[$status];
                } else {
                    $field = $status;
                }
                // aggregated fields
                foreach ($this->types as $type) {
                    $value = $item[$field . "_" . $type];
                    $idx = $item["yyyy"] . "-" . str_pad(
                        $item["mm"],
                        2,
                        "0",
                        STR_PAD_LEFT
                    );
                    $data[$status . "_" . $type]["month_" . $idx] = $value;
                }
            }
        }

        $icons = ilLPStatusIcons::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG);

        // add captions
        foreach (array_keys($data) as $figure) {
            $status = substr($figure, 0, -4);
            $type = substr($figure, -3);

            if ($status != "mem_cnt") {
                $text = ilLearningProgressBaseGUI::_getStatusText(
                    (int) $status
                );
                $icon = $icons->renderIconForStatus((int) $status);
                $text = $icon . " " . $text;
            } else {
                $text = $this->lng->txt("members");
            }
            if ($type != "avg") {
                $caption = $text . " " . $this->lng->txt(
                    "trac_object_stat_lp_" . $type
                );
            } else {
                $caption = $text . " &#216;";
            }
            $data[$figure]["figure"] = $caption;
        }

        $this->setData($data);
    }

    protected function initRow(array &$a_row): void
    {
        foreach ($this->types as $type) {
            $a_row["mem_cnt_" . $type] = null;
        }
        foreach ($this->status as $status) {
            foreach ($this->types as $type) {
                $a_row[$status . "_" . $type] = null;
            }
        }
    }

    protected function fillRow(array $a_set): void
    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];

        if (!$this->is_details) {
            $type = ilObject::_lookupType($a_set["obj_id"]);

            // ajax details layer link
            if (strpos($this->filter["yearmonth"], "-") === false) {
                $this->ctrl->setParameter(
                    $this->parent_obj,
                    "item_id",
                    $a_set["obj_id"]
                );
                $url = $this->ctrl->getLinkTarget(
                    $this->parent_obj,
                    "showLearningProgressDetails"
                );
                $a_set["title"] .= " (<a href=\"#\" onclick=\"ilObjStat.showLPDetails(event, '" . $url . "');\">Details</a>)";
                $this->ctrl->setParameter($this->parent_obj, "item_id", "");
            }

            // optional columns before parsing outer "checkbox" block
            if ($this->isColumnSelected('obj_id')) {
                $this->tpl->setVariable('OBJ_ID_COL_VALUE', (string) $a_set['obj_id']);
            }
            if ($this->isColumnSelected('reference_ids')) {
                $this->tpl->setVariable('REF_IDS', implode(', ', $a_set['reference_ids']));
            }
            if ($this->isColumnSelected('paths')) {
                $paths = [];
                foreach ($a_set['reference_ids'] as $reference_id) {
                    $path_gui = new ilPathGUI();
                    $path_gui->enableTextOnly(false);
                    $path_gui->enableHideLeaf(false);
                    $path_gui->setUseImages(true);
                    $paths[] = $path_gui->getPath(ROOT_FOLDER_ID, $reference_id);
                }
                $this->tpl->setVariable('PATHS', implode('<br />', $paths));
            }
            $this->tpl->setCurrentBlock("checkbox");
            $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
            $this->tpl->setVariable(
                "ICON_SRC",
                ilObject::_getIcon(0, "tiny", $type)
            );
            $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
            $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
            if ($this->preselected && in_array(
                $a_set["obj_id"],
                $this->preselected
            )) {
                $this->tpl->setVariable(
                    "CHECKBOX_STATE",
                    " checked=\"checked\""
                );
            }
            $this->tpl->parseCurrentBlock();
        } else {
            $this->tpl->setCurrentBlock("details");
            $this->tpl->setVariable("TXT_FIGURE", $a_set["figure"]);
            $this->tpl->parseCurrentBlock();
        }

        $this->tpl->setCurrentBlock("item");

        if (strpos($this->filter["yearmonth"], "-") === false) {
            foreach (array_keys(
                $this->getMonthsYear($this->filter["yearmonth"])
            ) as $num) {
                $value = $this->anonymizeValue((int) ($a_set["month_" . $num] ?? 0));
                $this->tpl->setVariable("ITEM_VALUE", $value);
                $this->tpl->parseCurrentBlock();
            }
        } else {
            foreach ($this->types as $type) {
                $this->tpl->setVariable(
                    "ITEM_VALUE",
                    $this->anonymizeValue(
                        (int) ($a_set["mem_cnt_" . $type] ?? 0)
                    )
                );
                $this->tpl->parseCurrentBlock();
            }
            foreach ($this->status as $status) {
                foreach ($this->types as $type) {
                    $this->tpl->setVariable(
                        "ITEM_VALUE",
                        $this->anonymizeValue(
                            (int) ($a_set[$status . "_" . $type] ?? 0)
                        )
                    );
                    $this->tpl->parseCurrentBlock();
                }
            }
        }
    }

    public function getGraph(array $a_graph_items): string
    {
        $a_graph_items = array(array_pop($a_graph_items));

        $chart = ilChart::getInstanceByType(ilChart::TYPE_GRID, "objstlp");
        $chart->setSize("700", "500");

        $legend = new ilChartLegend();
        $chart->setLegend($legend);

        // needed for correct stacking
        $custom_order = array(
            ilLPStatus::LP_STATUS_IN_PROGRESS_NUM => array("#f7d408",
                                                           "#fffa00"
            ),
            ilLPStatus::LP_STATUS_FAILED_NUM => array("#cf0202", "#f15b5b"),
            ilLPStatus::LP_STATUS_COMPLETED_NUM => array("#17aa0e", "#6ce148"),
            ilLPStatus::LP_STATUS_NOT_ATTEMPTED_NUM => array("#a4a4a4",
                                                             "#c4c4c4"
            )
        );

        $chart->setColors(array());

        $max_value = 0;
        foreach ($this->chart_data as $object_id => $days) {
            if (in_array($object_id, $a_graph_items)) {
                $series = array();
                foreach ($custom_order as $status => $colors) {
                    $series[$status] = $chart->getDataInstance(
                        ilChartGrid::DATA_LINES
                    );
                    $series[$status]->setLabel(
                        ilLearningProgressBaseGUI::_getStatusText($status)
                    );
                    $chart_colors[] = $colors[0];
                }
                $chart->setColors($chart_colors);

                if (strpos($this->filter["yearmonth"], "-") === false) {
                    $x_axis = $this->lng->txt("month");

                    $counter = 0;
                    foreach (array_keys(
                        $this->getMonthsYear(
                            $this->filter["yearmonth"]
                        )
                    ) as $month) {
                        for ($loop = 1; $loop < 32; $loop++) {
                            $item_day = $month . "-" . str_pad(
                                (string) $loop,
                                2,
                                "0",
                                STR_PAD_LEFT
                            );
                            foreach (array_keys($custom_order) as $status) {
                                if (isset($days[$item_day])) {
                                    // as there is only 1 entry per day, avg == sum
                                    $value = (int) $days[$item_day][$this->status_map[$status] . "_avg"];
                                } else {
                                    $value = 0;
                                }
                                $max_value = max($max_value, $value);
                                $value = $this->anonymizeValue($value, true);
                                $series[$status]->addPoint($counter, $value);
                            }
                            $counter++;
                        }
                    }
                } else {
                    $x_axis = $this->lng->txt("day");
                    for ($loop = 1; $loop < 32; $loop++) {
                        foreach (array_keys($custom_order) as $status) {
                            if (isset($days[$loop])) {
                                // as there is only 1 entry per day, avg == sum
                                $value = (int) $days[$loop][$this->status_map[$status] . "_avg"];
                            } else {
                                $value = 0;
                            }
                            $max_value = max($max_value, $value);
                            $value = $this->anonymizeValue($value, true);
                            $series[$status]->addPoint($loop, $value);
                        }
                    }
                }

                foreach (array_keys($custom_order) as $status) {
                    $chart->addData($series[$status]);
                }
            }
        }

        $value_ticks = $this->buildValueScale($max_value, true);

        $labels = array();
        if (strpos($this->filter["yearmonth"], "-") === false) {
            $counter = 0;
            foreach ($this->getMonthsYear(
                $this->filter["yearmonth"],
                true
            ) as $caption) {
                $labels[$counter] = $caption;
                $counter += 31;
            }
        } else {
            for ($loop = 1; $loop < 32; $loop++) {
                $labels[$loop] = $loop . ".";
            }
        }
        $chart->setTicks($labels, $value_ticks, true);

        return $chart->getHTML();
    }

    protected function initLearningProgressDetailsLayer(): void
    {
        global $DIC;

        $tpl = $DIC['tpl'];

        ilYuiUtil::initOverlay();
        iljQueryUtil::initjQuery();

        $tpl->addJavascript("./Services/Tracking/js/ilObjStat.js");
    }
}