blob: a5670902ef0340d902a92b0e587646f7221f137a (
plain)
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
|
<?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\Plugins\ExamplePlugin;
use Piwik\View;
use Piwik\WidgetsList;
/**
* This class allows you to add your own widgets to the Piwik platform. In case you want to remove widgets from another
* plugin please have a look at the "configureWidgetsList()" method.
* To configure a widget simply call the corresponding methods as described in the API-Reference:
* http://developer.piwik.org/api-reference/Piwik/Plugin\Widgets
*/
class Widgets extends \Piwik\Plugin\Widgets
{
/**
* Here you can define the category the widget belongs to. You can reuse any existing widget category or define
* your own category.
* @var string
*/
protected $category = 'Example Category';
/**
* Here you can add one or multiple widgets. You can add a widget by calling the method "addWidget()" and pass the
* name of the widget as well as a method name that should be called 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.
*/
protected function init()
{
// $this->addWidget('Example Widget Name', $method = 'myExampleWidget');
// $this->addWidget('Example Widget 2', $method = 'myExampleWidget', $params = array('myparam' => 'myvalue'));
}
/**
* This method renders a widget as defined in "init()". It's on you how to generate the content of the
* widget. As long as you return a string everything is fine. You can use for instance a "Piwik\View" to render a
* twig template. In such a case don't forget to create a twig template (eg. myViewTemplate.twig) in the
* "templates" directory of your plugin.
*
* @return string
*/
public function myExampleWidget()
{
// $view = new View('@ExamplePlugin/myViewTemplate');
// return $view->render();
return 'My Widget Text';
}
/**
* Here you can remove any widgets defined by any plugin.
*
* @param WidgetsList $widgetsList
*/
public function configureWidgetsList(WidgetsList $widgetsList)
{
// $widgetsList->remove('NameOfWidgetCategory'); // will remove all widgets having this category
// $widgetsList->remove('NameOfWidgetCategory', 'Widget name'); // will only remove a specific widget
}
}
|
