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
|
<?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\Menu;
use Piwik\Piwik;
use Piwik\Plugin\Report;
/**
* Contains menu entries for the Reporting menu (the menu displayed under the Piwik logo).
* Plugins can implement the `configureReportingMenu()` method of the `Menu` plugin class to add, rename of remove
* items. If your plugin does not have a `Menu` class yet you can create one using `./console generate:menu`.
*
* **Example**
*
* public function configureReportingMenu(MenuReporting $menu)
* {
* $menu->add(
* 'MyPlugin_MyTranslatedMenuCategory',
* 'MyPlugin_MyTranslatedMenuName',
* array('module' => 'MyPlugin', 'action' => 'index'),
* Piwik::isUserHasSomeAdminAccess(),
* $order = 2
* );
* }
*
* @api
* @method static \Piwik\Menu\MenuReporting getInstance()
*/
class MenuReporting extends MenuAbstract
{
/**
* See {@link add()}. Adds a new menu item to the visitors section of the reporting menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addVisitorsItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('General_Visitors', $menuName, $url, $order, $tooltip);
}
/**
* See {@link add()}. Adds a new menu item to the actions section of the reporting menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addActionsItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('General_Actions', $menuName, $url, $order, $tooltip);
}
/**
* Should not be a public API yet. We probably have to change the API once we have another use case.
* @ignore
*/
public function addGroup($menuName, $defaultTitle, Group $group, $order = 50, $tooltip = false)
{
$this->menuEntries[] = array(
$menuName,
$defaultTitle,
$group,
$order,
$tooltip
);
}
/**
* See {@link add()}. Adds a new menu item to the referrers section of the reporting menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addReferrersItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('Referrers_Referrers', $menuName, $url, $order, $tooltip);
}
/**
* Returns if the URL was found in the menu.
*
* @param string $url
* @return boolean
*/
public function isUrlFound($url)
{
$menu = $this->getMenu();
foreach ($menu as $subMenus) {
foreach ($subMenus as $subMenuName => $menuUrl) {
if (strpos($subMenuName, '_') !== 0 && $menuUrl['_url'] == $url) {
return true;
}
}
}
return false;
}
/**
* Triggers the Menu.Reporting.addItems hook and returns the menu.
*
* @return Array
*/
public function getMenu()
{
if (!$this->menu) {
/**
* @ignore
* @deprecated
*/
Piwik::postEvent('Menu.Reporting.addItems', array());
foreach (Report::getAllReports() as $report) {
if ($report->isEnabled()) {
$report->configureReportingMenu($this);
}
}
foreach ($this->getAllMenus() as $menu) {
$menu->configureReportingMenu($this);
}
}
return parent::getMenu();
}
}
|
