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
|
<?php
/**
* Piwik - free/libre analytics platform
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik\Plugin;
use Piwik\Development;
use Piwik\Plugin\Manager as PluginManager;
use Piwik\WidgetsList;
/**
* Base class of all plugin widget providers. Plugins that define their own widgets can extend this class to easily
* add new widgets or to remove widgets defined by other plugins.
*
* For an example, see the {@link https://github.com/piwik/piwik/blob/master/plugins/ExamplePlugin/Widgets.php} plugin.
*
* @api
*/
class Widgets
{
protected $category = '';
protected $widgets = array();
private $module = '';
/**
* @ignore
*/
public function __construct()
{
$this->module = $this->getModule();
}
/**
* @ignore
*/
public function getCategory()
{
return $this->category;
}
private function getModule()
{
$className = get_class($this);
$className = explode('\\', $className);
return $className[2];
}
/**
* Adds a widget. You can add a widget by calling this method and passing the name of the widget as well as a method
* name that will be executed to render the widget. The method can be defined either directly here in this widget
* class or in the controller in case you want to reuse the same action for instance in the menu etc.
* @api
*/
protected function addWidget($name, $method, $parameters = array())
{
$this->addWidgetWithCustomCategory($this->category, $name, $method, $parameters);
}
/**
* Adds a widget with a custom category. By default all widgets that you define in your class will be added under
* the same category which is defined in the {@link $category} property. Sometimes you may have a widget that
* belongs to a different category where this method comes handy. It does the same as {@link addWidget()} but
* allows you to define the category name as well.
* @api
*/
protected function addWidgetWithCustomCategory($category, $name, $method, $parameters = array())
{
$this->checkIsValidWidget($name, $method);
$this->widgets[] = array('category' => $category,
'name' => $name,
'params' => $parameters,
'method' => $method,
'module' => $this->module);
}
/**
* Here you can add one or multiple widgets. To do so call the method {@link addWidget()} or
* {@link addWidgetWithCustomCategory()}.
* @api
*/
protected function init()
{
}
/**
* @ignore
*/
public function getWidgets()
{
$this->widgets = array();
$this->init();
return $this->widgets;
}
/**
* Allows you to configure previously added widgets.
* For instance you can remove any widgets defined by any plugin by calling the
* {@link \Piwik\WidgetsList::remove()} method.
*
* @param WidgetsList $widgetsList
* @api
*/
public function configureWidgetsList(WidgetsList $widgetsList)
{
}
/**
* @return \Piwik\Plugin\Widgets[]
* @ignore
*/
public static function getAllWidgets()
{
return PluginManager::getInstance()->findComponents('Widgets', 'Piwik\\Plugin\\Widgets');
}
/**
* @ignore
*/
public static function factory($module, $action)
{
if (empty($module) || empty($action)) {
return;
}
$pluginManager = PluginManager::getInstance();
try {
if (!$pluginManager->isPluginActivated($module)) {
return;
}
$plugin = $pluginManager->getLoadedPlugin($module);
} catch (\Exception $e) {
// we are not allowed to use possible widgets, plugin is not active
return;
}
/** @var Widgets $widgetContainer */
$widgetContainer = $plugin->findComponent('Widgets', 'Piwik\\Plugin\\Widgets');
if (empty($widgetContainer)) {
// plugin does not define any widgets, we cannot do anything
return;
}
if (!is_callable(array($widgetContainer, $action))) {
// widget does not implement such a method, we cannot do anything
return;
}
// the widget class implements such an action, but we have to check whether it is actually exposed and whether
// it was maybe disabled by another plugin, this is only possible by checking the widgetslist, unfortunately
if (!WidgetsList::isDefined($module, $action)) {
return;
}
return $widgetContainer;
}
private function checkIsValidWidget($name, $method)
{
if (!Development::isEnabled()) {
return;
}
if (empty($name)) {
Development::error('No name is defined for added widget having method "' . $method . '" in ' . get_class($this));
}
if (Development::isCallableMethod($this, $method)) {
return;
}
$controllerClass = '\\Piwik\\Plugins\\' . $this->module . '\\Controller';
if (!Development::methodExists($this, $method) &&
!Development::methodExists($controllerClass, $method)) {
Development::error('The added method "' . $method . '" neither exists in "' . get_class($this) . '" nor "' . $controllerClass . '". Make sure to define such a method.');
}
$definedInClass = get_class($this);
if (Development::methodExists($controllerClass, $method)) {
if (Development::isCallableMethod($controllerClass, $method)) {
return;
}
$definedInClass = $controllerClass;
}
Development::error('The method "' . $method . '" is not callable on "' . $definedInClass . '". Make sure the method is public.');
}
}
|
