ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilLPObjectStatisticsTableGUI.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */
3
4include_once("./Services/Tracking/classes/class.ilLPTableBaseGUI.php");
5
16{
20 function __construct($a_parent_obj, $a_parent_cmd, array $a_preselect = null, $a_load_items = true)
21 {
22 global $ilCtrl, $lng;
23
24 $this->preselected = $a_preselect;
25
26 $this->setId("lpobjstattbl");
27
28 parent::__construct($a_parent_obj, $a_parent_cmd);
29
30 $this->setShowRowsSelector(true);
31 // $this->setLimit(ilSearchSettings::getInstance()->getMaxHits());
32 $this->initFilter();
33
34 $this->addColumn("", "", "1", true);
35 $this->addColumn($lng->txt("trac_title"), "title");
36 $this->addColumn($lng->txt("object_id"), "obj_id");
37 if(strpos($this->filter["yearmonth"], "-") === false)
38 {
39 foreach($this->getMonthsYear($this->filter["yearmonth"]) as $num => $caption)
40 {
41 $this->addColumn($caption, "month_".$num, "", false, "ilRight");
42 }
43 }
44 $this->addColumn($lng->txt("total"), "total", "", false, "ilRight");
45
46 $this->setTitle($this->lng->txt("trac_object_stat_access"));
47
48 // $this->setSelectAllCheckbox("item_id");
49 $this->addMultiCommand("showAccessGraph", $lng->txt("trac_show_graph"));
50 $this->setResetCommand("resetAccessFilter");
51 $this->setFilterCommand("applyAccessFilter");
52
53 $this->setFormAction($ilCtrl->getFormAction($a_parent_obj, $a_parent_cmd));
54 $this->setRowTemplate("tpl.lp_object_statistics_row.html", "Services/Tracking");
55 $this->setEnableHeader(true);
56 $this->setEnableNumInfo(true);
57 $this->setEnableTitle(true);
58 $this->setDefaultOrderField("title");
59 $this->setDefaultOrderDirection("asc");
60
61 $this->setExportFormats(array(self::EXPORT_EXCEL, self::EXPORT_CSV));
62
63 if($a_load_items)
64 {
65 $this->getItems();
66 }
67 }
68
69 public function numericOrdering($a_field)
70 {
71 if($a_field != "title")
72 {
73 return true;
74 }
75 return false;
76 }
77
81 public function initFilter()
82 {
83 global $lng;
84
85 $this->setDisableFilterHiding(true);
86
87 // object type selection
88 include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
89 $si = new ilSelectInputGUI($lng->txt("obj_type"), "type");
90 $si->setOptions($this->getPossibleTypes(true, false, true));
91 $this->addFilterItem($si);
92 $si->readFromSession();
93 if(!$si->getValue())
94 {
95 $si->setValue("crs");
96 }
97 $this->filter["type"] = $si->getValue();
98
99 // title/description
100 include_once("./Services/Form/classes/class.ilTextInputGUI.php");
101 $ti = new ilTextInputGUI($lng->txt("trac_title_description"), "query");
102 $ti->setMaxLength(64);
103 $ti->setSize(20);
104 $this->addFilterItem($ti);
105 $ti->readFromSession();
106 $this->filter["query"] = $ti->getValue();
107
108 // read_count/spent_seconds
109 $si = new ilSelectInputGUI($lng->txt("trac_figure"), "figure");
110 $si->setOptions(array("read_count"=>$lng->txt("trac_read_count"),
111 "spent_seconds"=>$lng->txt("trac_spent_seconds"),
112 "users"=>$lng->txt("users")));
113 $this->addFilterItem($si);
114 $si->readFromSession();
115 if(!$si->getValue())
116 {
117 $si->setValue("read_count");
118 }
119 $this->filter["measure"] = $si->getValue();
120
121 // year/month
122 $si = new ilSelectInputGUI($lng->txt("year")." / ".$lng->txt("month"), "yearmonth");
123 $si->setOptions($this->getMonthsFilter());
124 $this->addFilterItem($si);
125 $si->readFromSession();
126 if(!$si->getValue())
127 {
128 $si->setValue(date("Y-m"));
129 }
130 $this->filter["yearmonth"] = $si->getValue();
131 }
132
133 function getItems()
134 {
135 $data = array();
136
137 $objects = $this->searchObjects(
138 $this->getCurrentFilter(true),
139 "read",
140 null,
141 false
142 );
143 if($objects)
144 {
145 include_once "Services/Tracking/classes/class.ilTrQuery.php";
146
147 $yearmonth = explode("-", $this->filter["yearmonth"]);
148 if(sizeof($yearmonth) == 1)
149 {
150 foreach(ilTrQuery::getObjectAccessStatistics($objects, $yearmonth[0]) as $obj_id => $months)
151 {
152 $data[$obj_id]["obj_id"] = $obj_id;
153 $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
154
155 foreach($months as $month => $values)
156 {
157 $idx = $yearmonth[0]."-".str_pad($month, 2, "0", STR_PAD_LEFT);
158 $data[$obj_id]["month_".$idx] = (int)$values[$this->filter["measure"]];
159 $data[$obj_id]["total"] += (int)$values[$this->filter["measure"]];
160 }
161 }
162 }
163 else
164 {
165 foreach(ilTrQuery::getObjectAccessStatistics($objects, $yearmonth[0], (int)$yearmonth[1]) as $obj_id => $days)
166 {
167 $data[$obj_id]["obj_id"] = $obj_id;
168 $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
169
170 foreach($days as $day => $values)
171 {
172 $data[$obj_id]["day_".$day] = (int)$values[$this->filter["measure"]];
173 $data[$obj_id]["total"] += (int)$values[$this->filter["measure"]];
174 }
175 }
176 }
177
178 // add objects with no usage data
179 foreach(array_keys($objects) as $obj_id)
180 {
181 if(!isset($data[$obj_id]))
182 {
183 $data[$obj_id]["obj_id"] = $obj_id;
184 $data[$obj_id]["title"] = ilObject::_lookupTitle($obj_id);
185 }
186 }
187 }
188
189 $this->setData($data);
190 }
191
195 protected function fillRow($a_set)
196 {
197 global $ilCtrl;
198
199 $type = ilObject::_lookupType($a_set["obj_id"]);
200
201 $this->tpl->setVariable("OBJ_ID", $a_set["obj_id"]);
202 $this->tpl->setVariable("ICON_SRC", ilObject::_getIcon("", "tiny", $type));
203 $this->tpl->setVariable("ICON_ALT", $this->lng->txt($type));
204 $this->tpl->setVariable("TITLE_TEXT", $a_set["title"]);
205
206 if($this->preselected && in_array($a_set["obj_id"], $this->preselected))
207 {
208 $this->tpl->setVariable("CHECKBOX_STATE", " checked=\"checked\"");
209 }
210
211 $sum = 0;
212 if(strpos($this->filter["yearmonth"], "-") === false)
213 {
214 $this->tpl->setCurrentBlock("month");
215 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
216 {
217 $value = (int)$a_set["month_".$num];
218 if($this->filter["measure"] != "spent_seconds")
219 {
220 $value = $this->anonymizeValue($value);
221 }
222 else
223 {
224 $value = $this->formatSeconds($value, true);
225 }
226 $this->tpl->setVariable("MONTH_VALUE", $value);
227 $this->tpl->parseCurrentBlock();
228 }
229 }
230
231 if($this->filter["measure"] == "spent_seconds")
232 {
233 $sum = $this->formatSeconds((int)$a_set["total"], true);
234 }
235 else
236 {
237 $sum = $this->anonymizeValue((int)$a_set["total"]);
238 }
239 $this->tpl->setVariable("TOTAL", $sum);
240 }
241
242 function getGraph(array $a_graph_items)
243 {
244 global $lng;
245
246 include_once "Services/Chart/classes/class.ilChart.php";
248 $chart->setSize(700, 500);
249
250 $legend = new ilChartLegend();
251 $chart->setLegend($legend);
252
253 $max_value = 0;
254 foreach($this->getData() as $object)
255 {
256 if(in_array($object["obj_id"], $a_graph_items))
257 {
258 $series = $chart->getDataInstance(ilChartGrid::DATA_LINES);
259 $series->setLabel(ilObject::_lookupTitle($object["obj_id"]));
260
261 if(strpos($this->filter["yearmonth"], "-") === false)
262 {
263 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $idx => $num)
264 {
265 $value = (int)$object["month_".$num];
266 $max_value = max($max_value, $value);
267 if($this->filter["measure"] != "spent_seconds")
268 {
269 $value = $this->anonymizeValue($value, true);
270 }
271 $series->addPoint($idx, $value);
272 }
273 }
274 else
275 {
276 for($loop = 1; $loop<32; $loop++)
277 {
278 $value = (int)$object["day_".$loop];
279 $max_value = max($max_value, $value);
280 if($this->filter["measure"] != "spent_seconds")
281 {
282 $value = $this->anonymizeValue($value, true);
283 }
284 $series->addPoint($loop, $value);
285 }
286 }
287
288 $chart->addData($series);
289 }
290 }
291
292 $value_ticks = $this->buildValueScale($max_value, ($this->filter["measure"] != "spent_seconds"),
293 ($this->filter["measure"] == "spent_seconds"));
294
295 $labels = array();
296 if(strpos($this->filter["yearmonth"], "-") === false)
297 {
298 foreach(array_values($this->getMonthsYear($this->filter["yearmonth"], true)) as $idx => $caption)
299 {
300 $labels[$idx] = $caption;
301 }
302 }
303 else
304 {
305 for($loop = 1; $loop<32; $loop++)
306 {
307 $labels[$loop] = $loop.".";
308 }
309 }
310 $chart->setTicks($labels, $value_ticks, true);
311
312 return $chart->getHTML();
313 }
314
315 protected function fillMetaExcel()
316 {
317
318 }
319
320 protected function fillRowExcel($a_worksheet, &$a_row, $a_set)
321 {
322 $a_worksheet->write($a_row, 0, ilObject::_lookupTitle($a_set["obj_id"]));
323 $a_worksheet->write($a_row, 1, $a_set["obj_id"]);
324
325 $col = 1;
326 if(strpos($this->filter["yearmonth"], "-") === false)
327 {
328 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
329 {
330 $value = (int)$a_set["month_".$num];
331 if($this->filter["measure"] != "spent_seconds")
332 {
333 $value = $this->anonymizeValue($value);
334 }
335
336 $col++;
337 $a_worksheet->write($a_row, $col, $value);
338 }
339 }
340
341 if($this->filter["measure"] == "spent_seconds")
342 {
343 // keep seconds
344 // $sum = $this->formatSeconds((int)$a_set["total"]);
345 $sum = (int)$a_set["total"];
346 }
347 else
348 {
349 $sum = $this->anonymizeValue((int)$a_set["total"]);
350 }
351 $col++;
352 $a_worksheet->write($a_row, $col, $sum);
353 }
354
355 protected function fillMetaCSV()
356 {
357
358 }
359
360 protected function fillRowCSV($a_csv, $a_set)
361 {
362 $a_csv->addColumn(ilObject::_lookupTitle($a_set["obj_id"]));
363 $a_csv->addColumn($a_set["obj_id"]);
364
365 if(strpos($this->filter["yearmonth"], "-") === false)
366 {
367 foreach(array_keys($this->getMonthsYear($this->filter["yearmonth"])) as $num)
368 {
369 $value = (int)$a_set["month_".$num];
370 if($this->filter["measure"] != "spent_seconds")
371 {
372 $value = $this->anonymizeValue($value);
373 }
374
375 $a_csv->addColumn($value);
376 }
377 }
378
379 if($this->filter["measure"] == "spent_seconds")
380 {
381 // keep seconds
382 // $sum = $this->formatSeconds((int)$a_set["total"]);
383 $sum = (int)$a_set["total"];
384 }
385 else
386 {
387 $sum = $this->anonymizeValue((int)$a_set["total"]);
388 }
389 $a_csv->addColumn($sum);
390
391 $a_csv->addRow();
392 }
393}
394
395?>
static getInstanceByType($a_type, $a_id)
Get type instance.
const TYPE_GRID
TableGUI class for learning progress.
__construct($a_parent_obj, $a_parent_cmd, array $a_preselect=null, $a_load_items=true)
Constructor.
fillRowCSV($a_csv, $a_set)
CSV Version of Fill Row.
numericOrdering($a_field)
Should this field be sorted numeric?
fillRowExcel($a_worksheet, &$a_row, $a_set)
Excel Version of Fill Row.
TableGUI class for learning progress.
formatSeconds($seconds, $a_shorten_zero=false)
getCurrentFilter($as_query=false)
getMonthsYear($a_year=null, $a_short=false)
buildValueScale($a_max_value, $a_anonymize=false, $a_format_seconds=false)
anonymizeValue($a_value, $a_force_number=false)
getMonthsFilter($a_short=false)
getPossibleTypes($a_split_learning_resources=false, $a_include_digilib=false, $a_allow_undefined_lp=false)
Get possible subtypes.
searchObjects(array $filter, $permission, array $preset_obj_ids=null, $a_check_lp_activation=true)
Search objects that match current filters.
static _lookupTitle($a_id)
lookup object title
static _getIcon($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
Get icon for repository item.
static _lookupType($a_id, $a_reference=false)
lookup object type
This class represents a selection list property in a property form.
setEnableHeader($a_enableheader)
Set Enable Header.
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setExportFormats(array $formats)
Set available export formats.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setData($a_data)
set table data @access public
setResetCommand($a_val, $a_caption=null)
Set reset filter command.
setEnableTitle($a_enabletitle)
Set Enable Title.
setEnableNumInfo($a_val)
Set enable num info.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setFilterCommand($a_val, $a_caption=null)
Set filter command.
This class represents a text property in a property form.
static getObjectAccessStatistics(array $a_ref_ids, $a_year, $a_month=null)
$legend
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:40