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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
* @category Piwik_Plugins
* @package ExampleUI
*/
namespace Piwik\Plugins\ExampleUI;
use Piwik\Common;
use Piwik\Notification;
use Piwik\Piwik;
use Piwik\View;
use Piwik\ViewDataTable\Factory as ViewDataTableFactory;
/**
* @package ExampleUI
*/
class Controller extends \Piwik\Plugin\Controller
{
public function dataTables()
{
$controllerAction = $this->pluginName . '.' . __FUNCTION__;
$apiAction = 'ExampleUI.getTemperatures';
$view = ViewDataTableFactory::build('table', $apiAction, $controllerAction);
$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');
echo $view->render();
}
public function evolutionGraph()
{
$view = new View('@ExampleUI/evolutiongraph');
$this->setPeriodVariablesView($view);
$view->evolutionGraph = $this->getEvolutionGraph(true, array('server1', 'server2'));
echo $view->render();
}
public function notifications()
{
$notification = new Notification('Lorem ipsum dolor sit amet, consectetur adipiscing elit.');
Notification\Manager::notify('ExampleUI_InfoSimple', $notification);
$notification = new Notification('Neque porro quisquam est qui dolorem ipsum quia dolor sit amet.');
$notification->title = 'Warning:';
$notification->context = Notification::CONTEXT_WARNING;
$notification->flags = null;
Notification\Manager::notify('ExampleUI_warningWithClose', $notification);
$notification = new Notification('Phasellus tincidunt arcu at justo faucibus, et lacinia est accumsan. ');
$notification->title = 'Well done';
$notification->context = Notification::CONTEXT_SUCCESS;
$notification->type = Notification::TYPE_TOAST;
Notification\Manager::notify('ExampleUI_successToast', $notification);
$notification = new Notification('Phasellus tincidunt arcu at justo <a href="#">faucibus</a>, et lacinia est accumsan. ');
$notification->raw = true;
$notification->context = Notification::CONTEXT_ERROR;
Notification\Manager::notify('ExampleUI_error', $notification);
$view = new View('@ExampleUI/notifications');
$this->setGeneralVariablesView($view);
echo $view->render();
}
public function getEvolutionGraph($fetch = false, array $columns = array())
{
if (empty($columns)) {
$columns = Common::getRequestVar('columns');
$columns = Piwik::getArrayFromApiParameter($columns);
}
$view = $this->getLastUnitGraphAcrossPlugins($this->pluginName, __FUNCTION__, $columns,
$selectableColumns = array('server1', 'server2'), 'My documentation', 'ExampleUI.getTemperaturesEvolution');
$view->requestConfig->filter_sort_column = 'label';
return $this->renderView($view, $fetch);
}
public function barGraph()
{
$view = ViewDataTableFactory::build(
'graphVerticalBar', 'ExampleUI.getTemperatures', $controllerAction = 'ExampleUI.barGraph');
$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;
echo $view->render();
}
public function pieGraph()
{
$view = ViewDataTableFactory::build(
'graphPie', 'ExampleUI.getPlanetRatios', $controllerAction = 'ExampleUI.pieGraph');
$view->config->columns_to_display = array('value');
$view->config->translations['value'] = "times the diameter of Earth";
$view->config->show_footer_icons = false;
$view->config->selectable_columns = array("value");
$view->config->max_graph_elements = 10;
echo $view->render();
}
public function tagClouds()
{
echo "<h2>Simple tag cloud</h2>";
$this->echoSimpleTagClouds();
echo "<br /><br /><h2>Advanced tag cloud: with logos and links</h2>
<ul style='list-style-type:disc;margin-left:50px'>
<li>The logo size is proportional to the value returned by the API</li>
<li>The logo is linked to a specific URL</li>
</ul><br /><br />";
$this->echoAdvancedTagClouds();
}
public function echoSimpleTagClouds()
{
$view = ViewDataTableFactory::build(
'cloud', 'ExampleUI.getPlanetRatios', $controllerAction = 'ExampleUI.echoSimpleTagClouds');
$view->config->columns_to_display = array('label', 'value');
$view->config->translations['value'] = "times the diameter of Earth";
$view->config->show_footer = false;
echo $view->render();
}
public function echoAdvancedTagClouds()
{
$view = ViewDataTableFactory::build(
'cloud', 'ExampleUI.getPlanetRatiosWithLogos', $controllerAction = 'ExampleUI.echoAdvancedTagClouds');
$view->config->display_logo_instead_of_label = true;
$view->config->columns_to_display = array('label', 'value');
$view->config->translations['value'] = "times the diameter of Earth";
echo $view->render();
}
public function sparklines()
{
$view = new View('@ExampleUI/sparklines');
$view->urlSparkline1 = $this->getUrlSparkline('generateSparkline', array('server' => 'server1', 'rand' => mt_rand()));
$view->urlSparkline2 = $this->getUrlSparkline('generateSparkline', array('server' => 'server2', 'rand' => mt_rand()));
echo $view->render();
}
public function generateSparkline()
{
$view = ViewDataTableFactory::build(
'sparkline', 'ExampleUI.getTemperaturesEvolution', $controllerAction = 'ExampleUI.generateSparkline');
$serverRequested = Common::getRequestVar('server', false);
if (false !== $serverRequested) {
$view->config->columns_to_display = array($serverRequested);
}
echo $view->render();
}
}
|
