diff --git a/core/Menu/MenuAdmin.php b/core/Menu/MenuAdmin.php
index ad4c6c410861102ff1466db9bd63397300aeed2f..7aa358c20604f79b4056b71d549279d851560e1f 100644
--- a/core/Menu/MenuAdmin.php
+++ b/core/Menu/MenuAdmin.php
@@ -49,11 +49,11 @@ class MenuAdmin extends MenuAbstract
}
/**
- * See {@link add()}. Adds a new menu item to the development section.
+ * 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 $tooltip
+ * @param bool|string $tooltip
* @api
*/
public function addDevelopmentItem($menuName, $url, $order = 50, $tooltip = false)
@@ -62,11 +62,11 @@ class MenuAdmin extends MenuAbstract
}
/**
- * See {@link add()}. Adds a new menu item to the development section.
+ * 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 $tooltip
+ * @param bool|string $tooltip
* @api
*/
public function addDiagnosticItem($menuName, $url, $order = 50, $tooltip = false)
@@ -75,11 +75,11 @@ class MenuAdmin extends MenuAbstract
}
/**
- * See {@link add()}. Adds a new menu item to the development section.
+ * 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 $tooltip
+ * @param bool|string $tooltip
* @api
*/
public function addPlatformItem($menuName, $url, $order = 50, $tooltip = false)
@@ -88,11 +88,11 @@ class MenuAdmin extends MenuAbstract
}
/**
- * See {@link add()}. Adds a new menu item to the development section.
+ * See {@link add()}. Adds a new menu item to the settings section of the admin menu.
* @param string $menuName
* @param array $url
* @param int $order
- * @param bool $tooltip
+ * @param bool|string $tooltip
* @api
*/
public function addSettingsItem($menuName, $url, $order = 50, $tooltip = false)
@@ -101,11 +101,11 @@ class MenuAdmin extends MenuAbstract
}
/**
- * See {@link add()}. Adds a new menu item to the development section.
+ * 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 $tooltip
+ * @param bool|string $tooltip
* @api
*/
public function addManageItem($menuName, $url, $order = 50, $tooltip = false)
diff --git a/core/Menu/MenuReporting.php b/core/Menu/MenuReporting.php
index c5a3c1da1e2f096c4f7e56f06d6a025bfff457bc..bb47815305469b39e98ca522321c2037543d4ef6 100644
--- a/core/Menu/MenuReporting.php
+++ b/core/Menu/MenuReporting.php
@@ -33,6 +33,46 @@ use Piwik\Plugin\Report;
*/
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
+ */
+ public function addVisitorsItem($menuName, $url, $order = 50, $tooltip = false)
+ {
+ $this->add('General_Visitors', $menuName, $url, true, $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
+ */
+ public function addActionsItem($menuName, $url, $order = 50, $tooltip = false)
+ {
+ $this->add('General_Actions', $menuName, $url, true, $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
+ */
+ public function addReferrersItem($menuName, $url, $order = 50, $tooltip = false)
+ {
+ $this->add('Referrers_Referrers', $menuName, $url, true, $order, $tooltip);
+ }
+
/**
* Returns if the URL was found in the menu.
*
diff --git a/core/Menu/MenuUser.php b/core/Menu/MenuUser.php
index 318e8b3f0f0bc9462766177510f8769f87ff1137..a174f8692b5ab1329f394cff37738d0ed5655428 100755
--- a/core/Menu/MenuUser.php
+++ b/core/Menu/MenuUser.php
@@ -31,6 +31,32 @@ namespace Piwik\Menu;
class MenuUser 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
+ */
+ public function addManageItem($menuName, $url, $order = 50, $tooltip = false)
+ {
+ $this->add('CoreAdminHome_MenuManage', $menuName, $url, true, $order, $tooltip);
+ }
+
+ /**
+ * See {@link add()}. Adds a new menu item to the platform section of the user menu.
+ * @param string $menuName
+ * @param array $url
+ * @param int $order
+ * @param bool|string $tooltip
+ * @api
+ */
+ public function addPlatformItem($menuName, $url, $order = 50, $tooltip = false)
+ {
+ $this->add('CorePluginsAdmin_MenuPlatform', $menuName, $url, true, $order, $tooltip);
+ }
+
/**
* Triggers the Menu.User.addItems hook and returns the menu.
*
diff --git a/plugins/API/Menu.php b/plugins/API/Menu.php
index 330fdd25199067746e82f1dcef6304d17c12e278..0020ecf1c4cd897ab03371767b0ad57e771eea8c 100644
--- a/plugins/API/Menu.php
+++ b/plugins/API/Menu.php
@@ -29,7 +29,7 @@ class Menu extends \Piwik\Plugin\Menu
$apiUrlParams = array('module' => 'API', 'action' => 'listAllAPI', 'segment' => false);
$tooltip = Piwik::translate('API_TopLinkTooltip');
- $menu->add('CorePluginsAdmin_MenuPlatform', 'General_API', $apiUrlParams, true, 6, $tooltip);
+ $menu->addPlatformItem('General_API', $apiUrlParams, 6, $tooltip);
}
private function addTopMenuMobileApp(MenuTop $menu)
diff --git a/plugins/Actions/Menu.php b/plugins/Actions/Menu.php
index 3e8a113bb23b08d9ca413905f8f9880c4128d347..8804fabe0d0d55de3931951f9c0a05a64d916354 100644
--- a/plugins/Actions/Menu.php
+++ b/plugins/Actions/Menu.php
@@ -19,11 +19,11 @@ class Menu extends \Piwik\Plugin\Menu
'action' => 'menuGetPageUrls'
);
- $menu->add('General_Actions', '', $urlParams, true, 15);
+ $menu->addActionsItem('', $urlParams, 15);
$actions = new Actions();
if ($actions->isSiteSearchEnabled()) {
- $menu->add('General_Actions', 'Actions_SubmenuSitesearch', array('module' => 'Actions', 'action' => 'indexSiteSearch'), true, 5);
+ $menu->addActionsItem('Actions_SubmenuSitesearch', array('module' => 'Actions', 'action' => 'indexSiteSearch'), 5);
}
}
diff --git a/plugins/DevicesDetection/Menu.php b/plugins/DevicesDetection/Menu.php
index b956942d522ac82a01f4bac5e48efe74756f411e..e37c62e75f93894645e96242ba374ca4fedbe82d 100644
--- a/plugins/DevicesDetection/Menu.php
+++ b/plugins/DevicesDetection/Menu.php
@@ -27,6 +27,6 @@ class Menu extends \Piwik\Plugin\Menu
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', 'DevicesDetection_submenu', array('module' => 'DevicesDetection', 'action' => 'index'));
+ $menu->addVisitorsItem('DevicesDetection_submenu', array('module' => 'DevicesDetection', 'action' => 'index'));
}
}
diff --git a/plugins/Events/Menu.php b/plugins/Events/Menu.php
index df171dc48896a081c030e452d7c5654af4d629a5..01c60cabe6490b8b7ee96964a628cc243201e900 100644
--- a/plugins/Events/Menu.php
+++ b/plugins/Events/Menu.php
@@ -16,6 +16,6 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Actions', 'Events_Events', array('module' => 'Events', 'action' => 'index'), true, 30);
+ $menu->addActionsItem('Events_Events', array('module' => 'Events', 'action' => 'index'), 30);
}
}
diff --git a/plugins/ExamplePlugin/Menu.php b/plugins/ExamplePlugin/Menu.php
index 1a4ed8300f2b93263012d33e2b93798cb36dd400..2a3ed266f2dcb15e3b71f3e54a1c60607a6c02a6 100644
--- a/plugins/ExamplePlugin/Menu.php
+++ b/plugins/ExamplePlugin/Menu.php
@@ -22,19 +22,21 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
+ // with custom category 'UI Framework'
// $menu->add('UI Framework', '', array('module' => 'ExamplePlugin', 'action' => ''), true, $orderId = 30);
// $menu->add('UI Framework', 'Report 1', array('module' => 'ExamplePlugin', 'action' => 'report1'), true, $orderId = 30);
+ // or reusing an existing category
+ // $menu->addVisitorsItem('Report 1', array('module' => 'ExamplePlugin', 'action' => 'report1'), $orderId = 30);
+ // $menu->addActionsItem('Report 1', array('module' => 'ExamplePlugin', 'action' => 'report1'), $orderId = 30);
}
public function configureAdminMenu(MenuAdmin $menu)
{
+ // with custom category
// $menu->add('General_Settings', 'My Admin Item', array('module' => 'ExamplePlugin', 'action' => ''), true, $orderId = 30);
- // or
+ // or reusing an existing category
// $menu->addSettingsItem('My Admin Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
- // $menu->addManageItem('My Admin Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
// $menu->addPlatformItem('My Admin Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
- // $menu->addDiagnosticItem('My Admin Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
- // $menu->addDevelopmentItem('My Admin Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
}
public function configureTopMenu(MenuTop $menu)
@@ -44,6 +46,10 @@ class Menu extends \Piwik\Plugin\Menu
public function configureUserMenu(MenuUser $menu)
{
+ // with custom category
// $menu->add('CoreAdminHome_MenuManage', 'My User Item', array('module' => 'ExamplePlugin', 'action' => ''), true, $orderId = 30);
+ // or reusing an existing category
+ // $menu->addManageItem('My User Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
+ // $menu->addPlatformItem('My User Item', array('module' => 'ExamplePlugin', 'action' => ''), $orderId = 30);
}
}
diff --git a/plugins/ExampleUI/Menu.php b/plugins/ExampleUI/Menu.php
index 8714c3eddc2f391e48f88d2b8a6008e1e442b31c..06c4bccf8ef961a0f3e060d71b8be1d0e4c649d1 100644
--- a/plugins/ExampleUI/Menu.php
+++ b/plugins/ExampleUI/Menu.php
@@ -36,7 +36,7 @@ class Menu extends \Piwik\Plugin\Menu
public function configureUserMenu(MenuUser $menu)
{
$urlParams = array('module' => 'ExampleUI', 'action' => 'notifications');
- $menu->add('CorePluginsAdmin_MenuPlatform', 'UI Notifications', $urlParams, $displayedForCurrentUser = true, $order = 3);
+ $menu->addPlatformItem('UI Notifications', $urlParams, $order = 3);
}
diff --git a/plugins/Live/Reports/GetLastVisitsDetails.php b/plugins/Live/Reports/GetLastVisitsDetails.php
index 24ef81d6177de5768d6af16bc245761942b9341a..9c2b4373e3fe7a06ea1b34e3522fe9e8d71820d5 100644
--- a/plugins/Live/Reports/GetLastVisitsDetails.php
+++ b/plugins/Live/Reports/GetLastVisitsDetails.php
@@ -29,9 +29,10 @@ class GetLastVisitsDetails extends Base
public function configureReportingMenu(MenuReporting $menu)
{
- $url = array('module' => $this->module, 'action' => 'indexVisitorLog');
-
- $menu->add('General_Visitors', $this->widgetTitle, $url, $this->isEnabled(), $order = 5);
+ if ($this->isEnabled()) {
+ $url = array('module' => $this->module, 'action' => 'indexVisitorLog');
+ $menu->addVisitorsItem($this->widgetTitle, $url, $order = 5);
+ }
}
public function configureWidget(WidgetsList $widget)
diff --git a/plugins/Referrers/Menu.php b/plugins/Referrers/Menu.php
index fc7aaf5820e4aafa97162a4b00245a79205f2799..60768d7c2f8c8901de100cf8e80c8ae65ecd401e 100644
--- a/plugins/Referrers/Menu.php
+++ b/plugins/Referrers/Menu.php
@@ -14,9 +14,9 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('Referrers_Referrers', '', array('module' => 'Referrers', 'action' => 'index'), true, 20);
- $menu->add('Referrers_Referrers', 'General_Overview', array('module' => 'Referrers', 'action' => 'index'), true, 1);
- $menu->add('Referrers_Referrers', 'Referrers_SubmenuSearchEngines', array('module' => 'Referrers', 'action' => 'getSearchEnginesAndKeywords'), true, 2);
- $menu->add('Referrers_Referrers', 'Referrers_SubmenuWebsites', array('module' => 'Referrers', 'action' => 'indexWebsites'), true, 3);
+ $menu->addReferrersItem('', array('module' => 'Referrers', 'action' => 'index'), 20);
+ $menu->addReferrersItem('General_Overview', array('module' => 'Referrers', 'action' => 'index'), 1);
+ $menu->addReferrersItem('Referrers_SubmenuSearchEngines', array('module' => 'Referrers', 'action' => 'getSearchEnginesAndKeywords'), 2);
+ $menu->addReferrersItem('Referrers_SubmenuWebsites', array('module' => 'Referrers', 'action' => 'indexWebsites'), 3);
}
}
diff --git a/plugins/ScheduledReports/Menu.php b/plugins/ScheduledReports/Menu.php
index afde618614c6bb74d8c9b1ebc7f52ebd40baad7f..26aafad2ad121845adf898676474a1fd0ebd524d 100644
--- a/plugins/ScheduledReports/Menu.php
+++ b/plugins/ScheduledReports/Menu.php
@@ -24,18 +24,10 @@ class Menu extends \Piwik\Plugin\Menu
\Piwik\Plugin\Manager::getInstance()->isPluginActivated('MobileMessaging')
? 'MobileMessaging_TopLinkTooltip' : 'ScheduledReports_TopLinkTooltip');
- $menu->add(
- 'CoreAdminHome_MenuManage',
- null,
- array('module' => '', 'action' => '', 'segment' => false),
- true,
- 10
- );
- $menu->add(
- 'CoreAdminHome_MenuManage',
+ $menu->addManageItem(null, array('module' => '', 'action' => '', 'segment' => false), 10);
+ $menu->addManageItem(
$this->getTopMenuTranslationKey(),
array('module' => 'ScheduledReports', 'action' => 'index', 'segment' => false),
- true,
13,
$tooltip
);
diff --git a/plugins/UserCountry/Menu.php b/plugins/UserCountry/Menu.php
index 505ae68c978872c21277a5510a133bedd3f31c7b..41e259a618b1ec1aa38a5425e2ef0671f5b46c22 100644
--- a/plugins/UserCountry/Menu.php
+++ b/plugins/UserCountry/Menu.php
@@ -25,6 +25,6 @@ class Menu extends \Piwik\Plugin\Menu
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', 'UserCountry_SubmenuLocations', array('module' => 'UserCountry', 'action' => 'index'));
+ $menu->addVisitorsItem('UserCountry_SubmenuLocations', array('module' => 'UserCountry', 'action' => 'index'));
}
}
diff --git a/plugins/UserCountryMap/Menu.php b/plugins/UserCountryMap/Menu.php
index fe7b9791353800370b8d4a079b55aaee384a7caa..298eda1e176d21719bf1890bcf53835389ba5dc3 100644
--- a/plugins/UserCountryMap/Menu.php
+++ b/plugins/UserCountryMap/Menu.php
@@ -14,7 +14,7 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', 'UserCountryMap_RealTimeMap',
- array('module' => 'UserCountryMap', 'action' => 'realtimeWorldMap'), true, $order = 70);
+ $menu->addVisitorsItem('UserCountryMap_RealTimeMap',
+ array('module' => 'UserCountryMap', 'action' => 'realtimeWorldMap'), $order = 70);
}
}
diff --git a/plugins/UserSettings/Menu.php b/plugins/UserSettings/Menu.php
index 00f59f2544fe5e501c612ba89e26bc8ee2156174..5b442e5e09a5b11911d4ae30f8e776d478d3950c 100644
--- a/plugins/UserSettings/Menu.php
+++ b/plugins/UserSettings/Menu.php
@@ -14,6 +14,6 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', 'General_Settings', array('module' => 'UserSettings', 'action' => 'index'));
+ $menu->addVisitorsItem('General_Settings', array('module' => 'UserSettings', 'action' => 'index'));
}
}
diff --git a/plugins/VisitFrequency/Menu.php b/plugins/VisitFrequency/Menu.php
index ad8000bed2c2b7fccded1dca63ba1b710c4a0f25..8759cf751d8202cc485e445e1d24fb94ef915e90 100644
--- a/plugins/VisitFrequency/Menu.php
+++ b/plugins/VisitFrequency/Menu.php
@@ -14,7 +14,7 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', 'VisitFrequency_SubmenuFrequency',
- array('module' => 'VisitFrequency', 'action' => 'index'), true, $order = 55);
+ $menu->addVisitorsItem('VisitFrequency_SubmenuFrequency',
+ array('module' => 'VisitFrequency', 'action' => 'index'), $order = 55);
}
}
diff --git a/plugins/VisitTime/Menu.php b/plugins/VisitTime/Menu.php
index ab3dce5b551edbda69593bef559f95e7ce59638b..db221a4eda3025014b37250964eb8255460d132c 100644
--- a/plugins/VisitTime/Menu.php
+++ b/plugins/VisitTime/Menu.php
@@ -14,7 +14,7 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', 'VisitTime_SubmenuTimes',
- array('module' => 'VisitTime', 'action' => 'index'), true, $order = 65);
+ $menu->addVisitorsItem('VisitTime_SubmenuTimes',
+ array('module' => 'VisitTime', 'action' => 'index'), $order = 65);
}
}
diff --git a/plugins/VisitsSummary/Menu.php b/plugins/VisitsSummary/Menu.php
index e79a338d9cf3000f435677c118096e0cd2b62c79..1b87e46be9cc7b841fbe184f4dce9d32c3884232 100644
--- a/plugins/VisitsSummary/Menu.php
+++ b/plugins/VisitsSummary/Menu.php
@@ -14,7 +14,7 @@ class Menu extends \Piwik\Plugin\Menu
{
public function configureReportingMenu(MenuReporting $menu)
{
- $menu->add('General_Visitors', '', array('module' => 'VisitsSummary', 'action' => 'index'), true, 10);
- $menu->add('General_Visitors', 'General_Overview', array('module' => 'VisitsSummary', 'action' => 'index'), true, 1);
+ $menu->addVisitorsItem('', array('module' => 'VisitsSummary', 'action' => 'index'), 10);
+ $menu->addVisitorsItem('General_Overview', array('module' => 'VisitsSummary', 'action' => 'index'), 1);
}
}
diff --git a/plugins/Widgetize/Menu.php b/plugins/Widgetize/Menu.php
index c4db230565dcdc0daf47a9c391c416e902608135..954df309e5fa571ca71928c9f2047e07ba54b429 100644
--- a/plugins/Widgetize/Menu.php
+++ b/plugins/Widgetize/Menu.php
@@ -18,8 +18,8 @@ class Menu extends \Piwik\Plugin\Menu
$tooltip = Piwik::translate('Widgetize_TopLinkTooltip');
$urlParams = array('module' => 'Widgetize', 'action' => 'index', 'segment' => false);
- $menu->add('CorePluginsAdmin_MenuPlatform', null, $urlParams, true, 50, $tooltip);
- $menu->add('CorePluginsAdmin_MenuPlatform', 'General_Widgets', $urlParams, true, 5, $tooltip);
+ $menu->addPlatformItem(null, $urlParams, 50, $tooltip);
+ $menu->addPlatformItem('General_Widgets', $urlParams, 5, $tooltip);
}
}