class.ilLPObjectStatisticsDailyTableGUI.php

Go to the documentation of this file.

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

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

class ilLPObjectStatisticsDailyTableGUI extends ilLPTableBaseGUI
{
        function __construct($a_parent_obj, $a_parent_cmd, array $a_preselect = null, $a_load_items = true)
        {
                global $ilCtrl, $lng;
                
                $this->preselected = $a_preselect;

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

                $this->setShowRowsSelector(true);
                // $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
                $this->initFilter();

                $this->addColumn("", "", "1", true);
                $this->addColumn($lng->txt("trac_title"), "title");
                for($loop = 0; $loop<24; $loop+=2)
                {
                        $this->addColumn(str_pad($loop, 2, "0", STR_PAD_LEFT).":00-<br />".
                                str_pad($loop+2, 2, "0", STR_PAD_LEFT).":00 ", "hour".$loop, "", false, "ilRight");
                }
                $this->addColumn($lng->txt("total"), "sum", "", false, "ilRight");

                $this->setTitle($this->lng->txt("trac_object_stat_daily"));

                // $this->setSelectAllCheckbox("item_id");
                $this->addMultiCommand("showDailyGraph", $lng->txt("trac_show_graph"));
                $this->setResetCommand("resetDailyFilter");
                $this->setFilterCommand("applyDailyFilter");
                
                $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
                $this->setRowTemplate("tpl.lp_object_statistics_daily_row.html", "Services/Tracking");
                $this->setEnableHeader(true);
                $this->setEnableNumInfo(true);
                $this->setEnableTitle(true);
                $this->setDefaultOrderField("title");
                $this->setDefaultOrderDirection("asc");
                
                $this->setExportFormats(array(self::EXPORT_EXCEL, self::EXPORT_CSV));
                
                include_once("./Services/Tracking/classes/class.ilLPObjSettings.php");
                include_once "Services/Tracking/classes/class.ilTrQuery.php";
                
                $info = ilTrQuery::getObjectStatisticsLogInfo();
                $info_date = ilDatePresentation::formatDate(new ilDateTime($info["tstamp"], IL_CAL_UNIX));
                $link = " <a href=\"".$ilCtrl->getLinkTarget($a_parent_obj, "admin")."\">&raquo;".
                        $lng->txt("trac_log_info_link")."</a>";
                ilUtil::sendInfo(sprintf($lng->txt("trac_log_info"), $info_date, $info["counter"]).$link);

                if($a_load_items)
                {
                        $this->getItems();
                }
        }
        
        public function numericOrdering($a_field) 
        {
                $fields = array();
                $fields[] = "sum";
                for($loop = 0; $loop<24; $loop+=2)
                {
                        $fields[] = "hour".$loop;
                }
                
                if(in_array($a_field, $fields))
                {
                        return true;
                }
                return false;
        }

        public function initFilter()
        {
                global $lng;

                $this->setDisableFilterHiding(true);

                // object type selection
                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                $si = new ilSelectInputGUI($lng->txt("obj_type"), "type");
                $si->setOptions($this->getPossibleTypes(true, false, true));
                $this->addFilterItem($si);
                $si->readFromSession();
                if(!$si->getValue())
                {
                        $si->setValue("crs");
                }
                $this->filter["type"] = $si->getValue();

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

                // read_count/spent_seconds
                $si = new ilSelectInputGUI($lng->txt("trac_figure"), "figure");
                $si->setOptions(array("read_count"=>$lng->txt("trac_read_count"),
                        "spent_seconds"=>$lng->txt("trac_spent_seconds")));
                $this->addFilterItem($si);
                $si->readFromSession();
                if(!$si->getValue())
                {
                        $si->setValue("read_count");
                }
                $this->filter["measure"] = $si->getValue();

                // year/month
                $si = new ilSelectInputGUI($lng->txt("year")." / ".$lng->txt("month"), "yearmonth");
                $options = array();
                for($loop = 0; $loop < 10; $loop++)
                {
                        $year = date("Y")-$loop;
                        $options[$year] = $year;
                        for($loop2 = 12; $loop2 > 0; $loop2--)
                        {
                                $month = str_pad($loop2, 2, "0", STR_PAD_LEFT);
                                if($year.$month <= date("Ym"))
                                {
                                        $options[$year."-".$month] = $year." / ".
                                                $lng->txt("month_".$month."_long");
                                }
                        }
                }
                $si->setOptions($options);
                $this->addFilterItem($si);
                $si->readFromSession();
                if(!$si->getValue())
                {
                        $si->setValue(date("Y-m"));
                }
                $this->filter["yearmonth"] = $si->getValue();
        }

        function getItems()
        {
                $data = array();
                
                $objects = $this->searchObjects($this->getCurrentFilter(true), "read");
                if($objects)
                {                                               
                        include_once "Services/Tracking/classes/class.ilTrQuery.php";
                        
                        $yearmonth = explode("-", $this->filter["yearmonth"]);
                        if(sizeof($yearmonth) == 1)
                        {
                                $stat_objects = ilTrQuery::getObjectDailyStatistics($objects, $yearmonth[0]);
                        }
                        else
                        {
                                $stat_objects = ilTrQuery::getObjectDailyStatistics($objects, $yearmonth[0], (int)$yearmonth[1]);
                        }

                        foreach($stat_objects as $obj_id => $hours)
                        {
                                $data[$obj_id]["obj_id"] = $obj_id;
                                $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                                
                                foreach($hours as $hour => $values)
                                {                                       
                                        // table data
                                        $data[$obj_id]["hour".floor($hour/2)*2] += (int)$values[$this->filter["measure"]];
                                        $data[$obj_id]["sum"] += (int)$values[$this->filter["measure"]];
                                        
                                        // graph data
                                        $data[$obj_id]["graph"]["hour".$hour] = $values[$this->filter["measure"]];
                                }
                        }
                        
                        // add objects with no usage data
                        foreach($objects as $obj_id => $ref_ids)
                        {
                                if(!isset($data[$obj_id]))
                                {
                                        $data[$obj_id]["obj_id"] = $obj_id;
                                        $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
                                }
                        }                                               
                }
                
                $this->setData($data);
        }
        
        protected function fillRow($a_set)
        {
                global $ilCtrl;

                $type = ilObject::_lookupType($a_set["obj_id"]);                                

                $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
                $this->tpl->setVariable("ICON_SRC", ilUtil::getTypeIconPath($type, $a_set["obj_id"], "tiny"));
                $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->setCurrentBlock("hour");
                for($loop = 0; $loop<24; $loop+=2)
                {
                        $value = (int)$a_set["hour".$loop];
                        if($this->filter["measure"] == "read_count")
                        {
                                $value = $this->anonymizeValue($value);
                        }       
                        else if($this->filter["measure"] == "spent_seconds")
                        {
                                $value = $this->formatSeconds($value, true);
                        }
                        $this->tpl->setVariable("HOUR_VALUE", $value);
                        $this->tpl->parseCurrentBlock();
                }

                if($this->filter["measure"] == "spent_seconds")
                {
                        $sum = $this->formatSeconds((int)$a_set["sum"], true);
                }
                else
                {
                        $sum = $this->anonymizeValue((int)$a_set["sum"]);
                }       
                $this->tpl->setVariable("TOTAL", $sum);
        }

        function getGraph(array $a_graph_items)
        {
                global $lng;
                
                include_once "Services/Chart/classes/class.ilChart.php";
                $chart = new ilChart("objstdly", 700, 500);

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

                $max_value = 0;
                foreach($this->getData() as $object)
                {
                        if(in_array($object["obj_id"], $a_graph_items))
                        {
                                $series = new ilChartData("lines");
                                $series->setLabel(ilObject::_lookupTitle($object["obj_id"]));

                                for($loop = 0; $loop<24; $loop++)
                                {
                                        $value = (int)$object["graph"]["hour".$loop];
                                        $max_value = max($max_value, $value);
                                        if($this->filter["measure"] == "read_count")
                                        {
                                                $value = $this->anonymizeValue($value, true);
                                        }       
                                        $series->addPoint($loop, $value);
                                }

                                $chart->addData($series);
                        }
                }
                
                $value_ticks = $this->buildValueScale($max_value, ($this->filter["measure"] == "read_count"),
                        ($this->filter["measure"] == "spent_seconds"));

                $labels = array();
                for($loop = 0; $loop<24; $loop++)
                {
                        $labels[$loop] = str_pad($loop, 2, "0", STR_PAD_LEFT);
                }
                $chart->setTicks($labels, $value_ticks, true);

                return $chart->getHTML();
        }
        
        protected function fillMetaExcel()
        {
                
        }
        
        protected function fillRowExcel($a_worksheet, &$a_row, $a_set)
        {
                $a_worksheet->write($a_row, 0, ilObject::_lookupTitle($a_set["obj_id"]));
                        
                $col = 0;
                for($loop = 0; $loop<24; $loop+=2)
                {
                        $value = (int)$a_set["hour".$loop];
                        if($this->filter["measure"] == "read_count")
                        {
                                $value = $this->anonymizeValue($value);
                        }       
                        else if($this->filter["measure"] == "spent_seconds")
                        {
                                // keep seconds
                                // $value = $this->formatSeconds($value);
                        }
                        
                        $col++;
                        $a_worksheet->write($a_row, $col, $value);
                }
                
                if($this->filter["measure"] == "spent_seconds")
                {
                        // keep seconds
                        // $sum = $this->formatSeconds((int)$a_set["sum"]);
                        $sum = (int)$a_set["sum"];
                }
                else
                {
                        $sum = $this->anonymizeValue((int)$a_set["sum"]);
                }                       
                $col++;
                $a_worksheet->write($a_row, $col, $sum);
        }
        
        protected function fillMetaCSV()
        {
                
        }
        
        protected function fillRowCSV($a_csv, $a_set)
        {
                $a_csv->addColumn(ilObject::_lookupTitle($a_set["obj_id"]));
                        
                for($loop = 0; $loop<24; $loop+=2)
                {
                        $value = (int)$a_set["hour".$loop];
                        if($this->filter["measure"] == "read_count")
                        {
                                $value = $this->anonymizeValue($value);
                        }       
                        else if($this->filter["measure"] == "spent_seconds")
                        {
                                // keep seconds
                                // $value = $this->formatSeconds($value);
                        }
                        
                        $a_csv->addColumn($value);
                }
                
                if($this->filter["measure"] == "spent_seconds")
                {
                        // keep seconds                 
                        // $sum = $this->formatSeconds((int)$a_set["sum"]);
                        $sum = (int)$a_set["sum"];
                }               
                else
                {
                        $sum = $this->anonymizeValue((int)$a_set["sum"]);
                }       
                $a_csv->addColumn($sum);
                
                $a_csv->addRow();
        }
}

?>