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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
|
<?php
/**
* Piwik - Open source web analytics
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
/**
* Manages the global list of reports that can be displayed as dashboard widgets.
*
* Reports are added as dashboard widgets through the {@hook WidgetsList.addWidgets}
* event. Observers for this event should call the {@link add()} method to add reports.
*
* @api
*/
class WidgetsList
{
/**
* List of widgets
*
* @var array
*/
static protected $widgets = null;
/**
* Indicates whether the hook was posted or not
*
* @var bool
*/
static protected $hookCalled = false;
/**
* Returns all available widgets.
*
* @return array Array Mapping widget categories with an array of widget information, eg,
* ```
* array(
* 'Visitors' => array(
* array(...), // info about first widget in this category
* array(...) // info about second widget in this category, etc.
* ),
* 'Visits' => array(
* array(...),
* array(...)
* ),
* )
* ```
*/
static public function get()
{
self::addWidgets();
uksort(self::$widgets, array('Piwik\WidgetsList', '_sortWidgetCategories'));
$widgets = array();
foreach (self::$widgets as $key => $v) {
if (isset($widgets[Piwik::translate($key)])) {
$v = array_merge($widgets[Piwik::translate($key)], $v);
}
$widgets[Piwik::translate($key)] = $v;
}
return $widgets;
}
private static function addWidgets()
{
if (!self::$hookCalled) {
self::$hookCalled = true;
/**
* Used to collect all available dashboard widgets.
*
* Subscribe to this event to make your plugin's reports or other controller actions available
* as dashboard widgets. Event handlers should call the {@link WidgetsList::add()} method for each
* new dashboard widget.
*
* **Example**
*
* public function addWidgets()
* {
* WidgetsList::add('General_Actions', 'General_Pages', 'Actions', 'getPageUrls');
* }
*/
Piwik::postEvent('WidgetsList.addWidgets');
}
}
/**
* Sorting method for widget categories
*
* @param string $a
* @param string $b
* @return bool
*/
protected static function _sortWidgetCategories($a, $b)
{
$order = array(
'VisitsSummary_VisitsSummary',
'Live!',
'General_Visitors',
'UserSettings_VisitorSettings',
'DevicesDetection_DevicesDetection',
'General_Actions',
'Events_Events',
'Actions_SubmenuSitesearch',
'Referrers_Referrers',
'Goals_Goals',
'Goals_Ecommerce',
'_others_',
'Example Widgets',
'ExamplePlugin_exampleWidgets',
);
if (($oa = array_search($a, $order)) === false) {
$oa = array_search('_others_', $order);
}
if (($ob = array_search($b, $order)) === false) {
$ob = array_search('_others_', $order);
}
return $oa > $ob;
}
/**
* Adds a report to the list of dashboard widgets.
*
* @param string $widgetCategory The widget category. This can be a translation token.
* @param string $widgetName The name of the widget. This can be a translation token.
* @param string $controllerName The report's controller name (same as the plugin name).
* @param string $controllerAction The report's controller action method name.
* @param array $customParameters Extra query parameters that should be sent while getting
* this report.
*/
static public function add($widgetCategory, $widgetName, $controllerName, $controllerAction, $customParameters = array())
{
$widgetName = Piwik::translate($widgetName);
$widgetUniqueId = 'widget' . $controllerName . $controllerAction;
foreach ($customParameters as $name => $value) {
if (is_array($value)) {
// use 'Array' for backward compatibility;
// could we switch to using $value[0]?
$value = 'Array';
}
$widgetUniqueId .= $name . $value;
}
self::$widgets[$widgetCategory][] = array(
'name' => $widgetName,
'uniqueId' => $widgetUniqueId,
'parameters' => array('module' => $controllerName,
'action' => $controllerAction
) + $customParameters
);
}
/**
* Removes one or more widgets from the widget list.
*
* @param string $widgetCategory The widget category. Can be a translation token.
* @param string|false $widgetName The name of the widget to remove. Cannot be a
* translation token. If not supplied, the entire category
* will be removed.
*/
static public function remove($widgetCategory, $widgetName = false)
{
if (!isset(self::$widgets[$widgetCategory])) {
return;
}
if (empty($widgetName)) {
unset(self::$widgets[$widgetCategory]);
return;
}
foreach (self::$widgets[$widgetCategory] as $id => $widget) {
if ($widget['name'] == $widgetName || $widget['name'] == Piwik::translate($widgetName)) {
unset(self::$widgets[$widgetCategory][$id]);
return;
}
}
}
/**
* Returns `true` if a report exists in the widget list, `false` if otherwise.
*
* @param string $controllerName The controller name of the report.
* @param string $controllerAction The controller action of the report.
* @return bool
*/
static public function isDefined($controllerName, $controllerAction)
{
$widgetsList = self::get();
foreach ($widgetsList as $widgetCategory => $widgets) {
foreach ($widgets as $widget) {
if ($widget['parameters']['module'] == $controllerName
&& $widget['parameters']['action'] == $controllerAction
) {
return true;
}
}
}
return false;
}
/**
* Method to reset the widget list
* For testing only
* @ignore
*/
public static function _reset()
{
self::$widgets = null;
self::$hookCalled = false;
}
}
|
