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
|
<?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\Development;
use Piwik\Piwik;
/**
* Contains menu entries for the Admin menu.
* Plugins can implement the `configureAdminMenu()` 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 configureAdminMenu(MenuAdmin $menu)
* {
* $menu->add(
* 'MyPlugin_MyTranslatedAdminMenuCategory',
* 'MyPlugin_MyTranslatedAdminPageName',
* array('module' => 'MyPlugin', 'action' => 'index'),
* Piwik::isUserHasSomeAdminAccess(),
* $order = 2
* );
* }
*
* @method static \Piwik\Menu\MenuAdmin getInstance()
*/
class MenuAdmin extends MenuAbstract
{
/**
* See {@link add()}. Adds a new menu item to the manage section of the user menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addPersonalItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('UsersManager_MenuPersonal', $menuName, $url, $order, $tooltip);
}
/**
* See {@link add()}. Adds a new menu item to the development section of the admin menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addDevelopmentItem($menuName, $url, $order = 50, $tooltip = false)
{
if (Development::isEnabled()) {
$this->addItem('CoreAdminHome_MenuDevelopment', $menuName, $url, $order, $tooltip);
}
}
/**
* See {@link add()}. Adds a new menu item to the diagnostic section of the admin menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addDiagnosticItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('CoreAdminHome_MenuDiagnostic', $menuName, $url, $order, $tooltip);
}
/**
* See {@link add()}. Adds a new menu item to the platform section of the admin menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addPlatformItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('CorePluginsAdmin_MenuPlatform', $menuName, $url, $order, $tooltip);
}
/**
* See {@link add()}. Adds a new menu item to the manage section of the admin menu.
* @param string $menuName
* @param array $url
* @param int $order
* @param bool|string $tooltip
* @api
* @since 2.5.0
*/
public function addManageItem($menuName, $url, $order = 50, $tooltip = false)
{
$this->addItem('CoreAdminHome_MenuManage', $menuName, $url, $order, $tooltip);
}
/**
* Triggers the Menu.MenuAdmin.addItems hook and returns the admin menu.
*
* @return Array
*/
public function getMenu()
{
if (!$this->menu) {
/**
* @ignore
* @deprecated
*/
Piwik::postEvent('Menu.Admin.addItems', array());
foreach ($this->getAllMenus() as $menu) {
$menu->configureAdminMenu($this);
}
}
return parent::getMenu();
}
}
|
