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
|
<?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
* @package PluginsFunctions
*/
namespace Piwik;
/**
* @package PluginsFunctions
*/
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
* The event WidgetsList.add is used to create the list
*
* @return array
*/
static public function get()
{
self::addWidgets();
Piwik_PostEvent('WidgetsList.get');
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;
Piwik_PostEvent('WidgetsList.add');
}
}
/**
* 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',
'Actions_Actions',
'Actions_SubmenuSitesearch',
'Referers_Referers',
'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 an widget to the list
*
* @param string $widgetCategory
* @param string $widgetName
* @param string $controllerName
* @param string $controllerAction
* @param array $customParameters
*/
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
);
}
static public function remove($widgetCategory, $widgetName = false)
{
if (empty($widgetName)) {
unset(self::$widgets[$widgetCategory]);
return;
}
foreach (self::$widgets[$widgetCategory] as $id => $widget) {
if ($widget['name'] == $widgetName) {
unset(self::$widgets[$widgetCategory][$id]);
return;
}
}
}
/**
* Checks if the widget with the given parameters exists in der widget list
*
* @param string $controllerName
* @param string $controllerAction
* @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
*/
public static function _reset()
{
self::$widgets = null;
self::$hookCalled = false;
}
}
|
