File: GetTemperatures.php

package info (click to toggle)
matomo 5.5.1%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 73,596 kB
  • sloc: php: 231,041; javascript: 102,286; python: 202; xml: 189; sh: 172; makefile: 20; sql: 10
file content (87 lines) | stat: -rw-r--r-- 3,373 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<?php

/**
 * Matomo - free/libre analytics platform
 *
 * @link    https://matomo.org
 * @license https://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
 */

namespace Piwik\Plugins\ExampleUI\Reports;

use Piwik\Piwik;
use Piwik\Plugin\ViewDataTable;
use Piwik\Plugins\CoreVisualizations\Visualizations\JqplotGraph\Bar;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\Report\ReportWidgetFactory;
use Piwik\Widget\WidgetsList;

/**
 * This class defines a new report.
 *
 * See {@link https://developer.matomo.org/api-reference/Piwik/Plugin/Report} for more information.
 */
class GetTemperatures extends Base
{
    protected function init()
    {
        parent::init();

        $this->name = Piwik::translate('ExampleUI_GetTemperaturesDataTable');
        $this->documentation = 'This is an example documentation of a report.';
        $this->subcategoryId = 'ExampleUI_GetTemperaturesDataTable';
        $this->order = 110;
    }

    public function configureWidgets(WidgetsList $widgetsList, ReportWidgetFactory $factory)
    {
        // this will render the default view, in this case an Html Table
        $widgetsList->addWidgetConfig($factory->createWidget());

        $widgetsList->addWidgetConfig(
            $factory->createWidget()
                    ->forceViewDataTable(Bar::ID)
                    ->setSubcategoryId('Bar graph')
        );

        if (PluginManager::getInstance()->isPluginActivated('TreemapVisualization')) {
            $widgetsList->addWidgetConfig(
                $factory->createWidget()
                        ->setName('Treemap example')
                        ->setSubcategoryId('Treemap')
                        ->forceViewDataTable('infoviz-treemap')
            );
        }
    }

    public function configureView(ViewDataTable $view)
    {
        if ($view->isViewDataTableId(Bar::ID)) {
            $view->config->y_axis_unit = '°C';
            $view->config->show_footer = false;
            $view->config->translations['value'] = "Temperature";
            $view->config->selectable_columns = array("value");
            $view->config->max_graph_elements = 24;
        } elseif ($view->isViewDataTableId('infoviz-treemap')) {
            $view->config->translations['value'] = "Temperature";
            $view->config->columns_to_display = array("label", "value");
            $view->config->selectable_columns = array("value");
            $view->config->show_evolution_values = 0;
        } else {
            // for default view datatable, eg HtmlTable

            $view->config->translations['value'] = 'Temperature in °C';
            $view->config->translations['label'] = 'Hour of day';
            $view->requestConfig->filter_sort_column = 'label';
            $view->requestConfig->filter_sort_order = 'asc';
            $view->requestConfig->filter_limit = 24;
            $view->config->columns_to_display  = array('label', 'value');
            $view->config->y_axis_unit = '°C'; // useful if the user requests the bar graph
            $view->config->show_exclude_low_population = false;
            $view->config->show_table_all_columns = false;
            $view->config->disable_row_evolution  = true;
            $view->config->max_graph_elements = 24;
            $view->config->metrics_documentation = array('value' => 'Documentation for temperature metric');
        }
    }
}