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
|
<?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;
/**
* Contains menu entries for the Top menu (the menu at the very top of the page).
* Plugins can implement the `configureTopMenu()` 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 configureTopMenu(MenuTop $menu)
* {
* $menu->add(
* 'MyPlugin_MyTranslatedMenuCategory',
* 'MyPlugin_MyTranslatedMenuName',
* array('module' => 'MyPlugin', 'action' => 'index'),
* Piwik::isUserHasSomeAdminAccess(),
* $order = 2
* );
* }
*
* @method static \Piwik\Menu\MenuTop getInstance()
*/
class MenuTop extends MenuAbstract
{
/**
* Adds a new entry to the TopMenu.
*
* @param string $topMenuName The menu item name. Can be a translation token.
* @param string|array $url The URL the admin menu entry should link to, or an array of query parameters
* that can be used to build the URL. If `$isHTML` is true, this can be a string with
* HTML that is simply embedded.
* @param boolean $displayedForCurrentUser Whether this menu entry should be displayed for the
* current user. If false, the entry will not be added.
* @param int $order The order hint.
* @param bool $isHTML Whether `$url` is an HTML string or a URL that will be rendered as a link.
* @param bool|string $tooltip Optional tooltip to display.
* @deprecated since version 2.4.0. See {@link Piwik\Plugin\Menu} for new implementation.
*/
public static function addEntry($topMenuName, $url, $displayedForCurrentUser = true, $order = 10, $isHTML = false, $tooltip = false)
{
if ($isHTML) {
MenuTop::getInstance()->addHtml($topMenuName, $url, $displayedForCurrentUser, $order, $tooltip);
} else {
MenuTop::getInstance()->add($topMenuName, null, $url, $displayedForCurrentUser, $order, $tooltip);
}
}
/**
* @deprecated since version 2.4.0. See {@link Piwik\Plugin\Menu} for new implementation.
*/
public static function removeEntry($menuName, $subMenuName = false)
{
MenuTop::getInstance()->remove($menuName, $subMenuName);
}
/**
* Directly adds a menu entry containing html.
*
* @param string $menuName
* @param string $data
* @param boolean $displayedForCurrentUser
* @param int $order
* @param string $tooltip Tooltip to display.
* @api
*/
public function addHtml($menuName, $data, $displayedForCurrentUser, $order, $tooltip)
{
if ($displayedForCurrentUser) {
if (!isset($this->menu[$menuName])) {
$this->menu[$menuName]['_name'] = $menuName;
$this->menu[$menuName]['_html'] = $data;
$this->menu[$menuName]['_order'] = $order;
$this->menu[$menuName]['_hasSubmenu'] = false;
$this->menu[$menuName]['_tooltip'] = $tooltip;
}
}
}
/**
* Triggers the Menu.Top.addItems hook and returns the menu.
*
* @return Array
*/
public function getMenu()
{
if (!$this->menu) {
/**
* @ignore
* @deprecated
*/
Piwik::postEvent('Menu.Top.addItems', array());
foreach ($this->getAllMenus() as $menu) {
$menu->configureTopMenu($this);
}
}
return parent::getMenu();
}
}
|
