Refs #4202 Menu refactor GO. This one is tricky...

matomo-org · Oct 9, 2013 · 500373c · 500373c
1 parent 88a1d58
commit 500373c
Show file tree

Hide file tree

Showing 48 changed files with 156 additions and 90 deletions.
diff --git a/core/Config.php b/core/Config.php
@@ -13,8 +13,6 @@
 
 use Exception;
 
-require_once PIWIK_INCLUDE_PATH . '/core/functions.php';
-
 /**
  * For general performance (and specifically, the Tracker), we use deferred (lazy) initialization
  * and cache sections.  We also avoid any dependency on Zend Framework's Zend_Config.

diff --git a/core/Controller.php b/core/Controller.php
@@ -13,6 +13,7 @@
 use Exception;
 use Piwik\API\Request;
 use Piwik\DataTable\Filter\CalculateEvolutionFilter;
+use Piwik\Menu\MenuTop;
 use Piwik\Period\Month;
 use Piwik\Period;
 use Piwik\Period\Range;
@@ -423,7 +424,7 @@ protected function setGeneralVariablesView($view)
 
             $this->setBasicVariablesView($view);
 
-            $view->topMenu = Piwik_GetTopMenu();
+            $view->topMenu = MenuTop::getInstance()->getMenu();
         } catch (Exception $e) {
             Piwik_ExitWithMessage($e->getMessage(), $e->getTraceAsString());
         }

diff --git a/core/Controller/Admin.php b/core/Controller/Admin.php
@@ -12,6 +12,8 @@
 
 use Piwik\Config;
 use Piwik\Controller;
+use Piwik\Menu\MenuAdmin;
+use Piwik\Menu\MenuTop;
 use Piwik\Piwik;
 use Piwik\PluginsManager;
 use Piwik\Url;
@@ -52,8 +54,8 @@ static public function setBasicVariablesAdminView(View $view)
             $view->statisticsNotRecorded = true;
         }
 
-        $view->topMenu = Piwik_GetTopMenu();
-        $view->currentAdminMenuName = \Piwik\Menu\Admin::getInstance()->getCurrentAdminMenuName();
+        $view->topMenu = MenuTop::getInstance()->getMenu();
+        $view->currentAdminMenuName = MenuAdmin::getInstance()->getCurrentAdminMenuName();
 
         $view->enableFrames = Config::getInstance()->General['enable_framed_settings'];
         if (!$view->enableFrames) {
@@ -83,7 +85,8 @@ static public function setBasicVariablesAdminView(View $view)
 
         self::checkPhpVersion($view);
 
-        $view->menu = Piwik_GetAdminMenu();
+        $adminMenu = MenuAdmin::getInstance()->getMenu();
+        $view->adminMenu = $adminMenu;
     }
 
     static protected function getPiwikVersion()

diff --git a/core/DataTable.php b/core/DataTable.php
@@ -1509,3 +1509,13 @@ public static function fromSerializedArray($data)
         return $result;
     }
 }
+
+
+// Bridge for when serialized classes were not using namespaces yet (pre Piwik 2.0)
+class Piwik_DataTable_Row_DataTableSummary extends DataTableSummaryRow
+{
+}
+
+class Piwik_DataTable_Row extends Row
+{
+}
diff --git a/core/Menu/MenuAbstract.php b/core/Menu/MenuAbstract.php
@@ -36,7 +36,7 @@ abstract class MenuAbstract
      *
      * @return Array
      */
-    public function get()
+    public function getMenu()
     {
         $this->buildMenu();
         $this->applyEdits();
@@ -55,7 +55,7 @@ public function get()
      * @param int $order
      * @param bool|string $tooltip Tooltip to display.
      */
-    public function add($menuName, $subMenuName, $url, $displayedForCurrentUser, $order = 50, $tooltip = false)
+    public function add($menuName, $subMenuName, $url, $displayedForCurrentUser = true, $order = 50, $tooltip = false)
     {
         if ($displayedForCurrentUser) {
             // make sure the idSite value used is numeric (hack-y fix for #3426)

diff --git a/core/Menu/MenuAdmin.php b/core/Menu/MenuAdmin.php
@@ -20,7 +20,7 @@ class MenuAdmin extends MenuAbstract
     static private $instance = null;
 
     /**
-     * @return \Piwik\Menu\MenuAdmin
+     * @return MenuAdmin
      */
     static public function getInstance()
     {
@@ -63,7 +63,7 @@ public function getMenu()
              * ```
              * public function addMenuItems()
              * {
-             *     \Piwik\Menu\MenuAdmin::getInstance()->add(
+             *     MenuAdmin::getInstance()->add(
              *         'MenuName',
              *         'SubmenuName',
              *         array('module' => 'MyPlugin', 'action' => 'index'),
@@ -73,7 +73,7 @@ public function getMenu()
              * }
              * ```
              */
-            Piwik::postEvent('Menu.MenuAdmin.addItems');
+            Piwik::postEvent('Menu.Admin.addItems');
         }
         return parent::getMenu();
     }
@@ -85,7 +85,7 @@ public function getMenu()
      */
     function getCurrentAdminMenuName()
     {
-        $menu = \Piwik\Menu\MenuAdmin::getInstance();
+        $menu = MenuAdmin::getInstance()->getMenu();
         $currentModule = Piwik::getModule();
         $currentAction = Piwik::getAction();
         foreach ($menu as $submenu) {

diff --git a/core/Menu/MenuTop.php b/core/Menu/MenuTop.php
@@ -20,7 +20,7 @@ class MenuTop extends MenuAbstract
     static private $instance = null;
 
     /**
-     * @return \Piwik\Menu\MenuTop
+     * @return MenuTop
      */
     static public function getInstance()
     {
@@ -30,6 +30,28 @@ static public function getInstance()
         return self::$instance;
     }
 
+
+    /**
+     * Adds a new entry to the TopMenu.
+     *
+     * @param string $topMenuName
+     * @param string $data
+     * @param boolean $displayedForCurrentUser
+     * @param int $order
+     * @param bool $isHTML
+     * @param bool|string $tooltip Tooltip to display.
+     * @api
+     */
+    public static function addEntry($topMenuName, $data, $displayedForCurrentUser = true, $order = 10, $isHTML = false, $tooltip = false)
+    {
+        if ($isHTML) {
+            MenuTop::getInstance()->addHtml($topMenuName, $data, $displayedForCurrentUser, $order, $tooltip);
+        } else {
+            MenuTop::getInstance()->add($topMenuName, null, $data, $displayedForCurrentUser, $order, $tooltip);
+        }
+    }
+
+
     /**
      * Directly adds a menu entry containing html.
      *
@@ -52,7 +74,7 @@ public function addHtml($menuName, $data, $displayedForCurrentUser, $order, $too
     }
 
     /**
-     * Triggers the Menu.MenuTop.addItems hook and returns the menu.
+     * Triggers the Menu.Top.addItems hook and returns the menu.
      *
      * @return Array
      */
@@ -71,7 +93,7 @@ public function getMenu()
              * ```
              * public function addMenuItems()
              * {
-             *     Piwik_AddTopMenu(
+             *     MenuTop::addEntry(
              *         'TopMenuName',
              *         array('module' => 'MyPlugin', 'action' => 'index'),
              *         Piwik::isUserIsSuperUser(),
@@ -80,7 +102,7 @@ public function getMenu()
              * }
              * ```
              */
-            Piwik::postEvent('Menu.MenuTop.addItems');
+            Piwik::postEvent('Menu.Top.addItems');
         }
         return parent::getMenu();
     }

diff --git a/core/Url.php b/core/Url.php
@@ -343,6 +343,7 @@ static function getArrayFromCurrentQueryString()
      */
     static function getCurrentQueryStringWithParametersModified($params)
     {
+        var_dump($params);
         $urlValues = self::getArrayFromCurrentQueryString();
         foreach ($params as $key => $value) {
             $urlValues[$key] = $value;

diff --git a/index.php b/index.php
@@ -38,7 +38,6 @@
 @date_default_timezone_set('UTC');
 require_once PIWIK_INCLUDE_PATH . '/vendor/autoload.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Loader.php';
-require_once PIWIK_INCLUDE_PATH . '/core/functions.php';
 
 if(!defined('PIWIK_PRINT_ERROR_BACKTRACE')) {
     define('PIWIK_PRINT_ERROR_BACKTRACE', false);

diff --git a/js/index.php b/js/index.php
@@ -25,7 +25,6 @@
 define('PIWIK_USER_PATH', '..');
 
 require_once PIWIK_INCLUDE_PATH . '/libs/upgradephp/upgrade.php';
-require_once PIWIK_INCLUDE_PATH . '/core/functions.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Loader.php';
 
 $file = '../piwik.js';

diff --git a/piwik.php b/piwik.php
@@ -36,7 +36,6 @@
 @ignore_user_abort(true);
 
 require_once PIWIK_INCLUDE_PATH . '/libs/upgradephp/upgrade.php';
-require_once PIWIK_INCLUDE_PATH . '/core/functions.php';
 require_once PIWIK_INCLUDE_PATH . '/core/PluginsManager.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Plugin.php';
 require_once PIWIK_INCLUDE_PATH . '/core/Common.php';

diff --git a/plugins/API/API.php b/plugins/API/API.php
@@ -18,6 +18,7 @@
 use Piwik\DataTable;
 use Piwik\Date;
 use Piwik\Filesystem;
+use Piwik\Menu\MenuTop;
 use Piwik\Metrics;
 use Piwik\Piwik;
 use Piwik\SettingsPiwik;
@@ -666,7 +667,7 @@ public function addTopMenu()
         $apiUrlParams = array('module' => 'API', 'action' => 'listAllAPI', 'segment' => false);
         $tooltip = Piwik::translate('API_TopLinkTooltip');
 
-        Piwik_AddTopMenu('General_API', $apiUrlParams, true, 7, $isHTML = false, $tooltip);
+        MenuTop::addEntry('General_API', $apiUrlParams, true, 7, $isHTML = false, $tooltip);
 
         $this->addTopMenuMobileApp();
     }
@@ -679,7 +680,7 @@ protected function addTopMenuMobileApp()
         require_once PIWIK_INCLUDE_PATH . '/libs/UserAgentParser/UserAgentParser.php';
         $os = \UserAgentParser::getOperatingSystem($_SERVER['HTTP_USER_AGENT']);
         if ($os && in_array($os['id'], array('AND', 'IPD', 'IPA', 'IPH'))) {
-            Piwik_AddTopMenu('Piwik Mobile App', array('module' => 'Proxy', 'action' => 'redirect', 'url' => 'http://piwik.org/mobile/'), true, 4);
+            MenuTop::addEntry('Piwik Mobile App', array('module' => 'Proxy', 'action' => 'redirect', 'url' => 'http://piwik.org/mobile/'), true, 4);
         }
     }
 

diff --git a/plugins/Actions/Actions.php b/plugins/Actions/Actions.php
@@ -14,6 +14,7 @@
 use Piwik\ArchiveProcessor;
 use Piwik\Common;
 use Piwik\Db;
+use Piwik\Menu\MenuMain;
 use Piwik\MetricsFormatter;
 use Piwik\Piwik;
 use Piwik\SegmentExpression;
@@ -565,16 +566,16 @@ function addWidgets()
 
     function addMenus()
     {
-        Piwik_AddMenu('General_Actions', '', array('module' => 'Actions', 'action' => 'indexPageUrls'), true, 15);
-        Piwik_AddMenu('General_Actions', 'General_Pages', array('module' => 'Actions', 'action' => 'indexPageUrls'), true, 1);
-        Piwik_AddMenu('General_Actions', 'Actions_SubmenuPagesEntry', array('module' => 'Actions', 'action' => 'indexEntryPageUrls'), true, 2);
-        Piwik_AddMenu('General_Actions', 'Actions_SubmenuPagesExit', array('module' => 'Actions', 'action' => 'indexExitPageUrls'), true, 3);
-        Piwik_AddMenu('General_Actions', 'Actions_SubmenuPageTitles', array('module' => 'Actions', 'action' => 'indexPageTitles'), true, 4);
-        Piwik_AddMenu('General_Actions', 'General_Outlinks', array('module' => 'Actions', 'action' => 'indexOutlinks'), true, 6);
-        Piwik_AddMenu('General_Actions', 'General_Downloads', array('module' => 'Actions', 'action' => 'indexDownloads'), true, 7);
+        MenuMain::getInstance()->add('General_Actions', '', array('module' => 'Actions', 'action' => 'indexPageUrls'), true, 15);
+        MenuMain::getInstance()->add('General_Actions', 'General_Pages', array('module' => 'Actions', 'action' => 'indexPageUrls'), true, 1);
+        MenuMain::getInstance()->add('General_Actions', 'Actions_SubmenuPagesEntry', array('module' => 'Actions', 'action' => 'indexEntryPageUrls'), true, 2);
+        MenuMain::getInstance()->add('General_Actions', 'Actions_SubmenuPagesExit', array('module' => 'Actions', 'action' => 'indexExitPageUrls'), true, 3);
+        MenuMain::getInstance()->add('General_Actions', 'Actions_SubmenuPageTitles', array('module' => 'Actions', 'action' => 'indexPageTitles'), true, 4);
+        MenuMain::getInstance()->add('General_Actions', 'General_Outlinks', array('module' => 'Actions', 'action' => 'indexOutlinks'), true, 6);
+        MenuMain::getInstance()->add('General_Actions', 'General_Downloads', array('module' => 'Actions', 'action' => 'indexDownloads'), true, 7);
 
         if ($this->isSiteSearchEnabled()) {
-            Piwik_AddMenu('General_Actions', 'Actions_SubmenuSitesearch', array('module' => 'Actions', 'action' => 'indexSiteSearch'), true, 5);
+            MenuMain::getInstance()->add('General_Actions', 'Actions_SubmenuSitesearch', array('module' => 'Actions', 'action' => 'indexSiteSearch'), true, 5);
         }
     }
 

diff --git a/plugins/CoreAdminHome/Controller.php b/plugins/CoreAdminHome/Controller.php
@@ -15,6 +15,7 @@
 use Piwik\ArchiveProcessor\Rules;
 use Piwik\Common;
 use Piwik\Config;
+use Piwik\Menu\MenuTop;
 use Piwik\Nonce;
 use Piwik\Piwik;
 use Piwik\Plugins\LanguagesManager\API as APILanguagesManager;
@@ -144,7 +145,7 @@ public function trackingCodeGenerator()
     {
         $view = new View('@CoreAdminHome/trackingCodeGenerator');
         $this->setBasicVariablesView($view);
-        $view->topMenu = Piwik_GetTopMenu();
+        $view->topMenu = MenuTop::getInstance()->getMenu();
 
         $viewableIdSites = APISitesManager::getInstance()->getSitesIdWithAtLeastViewAccess();
 

diff --git a/plugins/CoreAdminHome/CoreAdminHome.php b/plugins/CoreAdminHome/CoreAdminHome.php
@@ -14,6 +14,7 @@
 use Piwik\DataAccess\ArchiveTableCreator;
 use Piwik\Date;
 use Piwik\Db;
+use Piwik\Menu\MenuAdmin;
 use Piwik\Piwik;
 use Piwik\ScheduledTask;
 use Piwik\ScheduledTime\Daily;
@@ -80,14 +81,14 @@ public function getJsFiles(&$jsFiles)
 
     function addMenu()
     {
-        Piwik_AddAdminSubMenu('CoreAdminHome_MenuManage', null, "", Piwik::isUserHasSomeAdminAccess(), $order = 1);
-        Piwik_AddAdminSubMenu('CoreAdminHome_MenuDiagnostic', null, "", Piwik::isUserHasSomeAdminAccess(), $order = 6);
-        Piwik_AddAdminSubMenu('General_Settings', null, "", Piwik::isUserHasSomeAdminAccess(), $order = 5);
-        Piwik_AddAdminSubMenu('General_Settings', 'CoreAdminHome_MenuGeneralSettings',
+        MenuAdmin::getInstance()->add('CoreAdminHome_MenuManage', null, "", Piwik::isUserHasSomeAdminAccess(), $order = 1);
+        MenuAdmin::getInstance()->add('CoreAdminHome_MenuDiagnostic', null, "", Piwik::isUserHasSomeAdminAccess(), $order = 6);
+        MenuAdmin::getInstance()->add('General_Settings', null, "", Piwik::isUserHasSomeAdminAccess(), $order = 5);
+        MenuAdmin::getInstance()->add('General_Settings', 'CoreAdminHome_MenuGeneralSettings',
             array('module' => 'CoreAdminHome', 'action' => 'generalSettings'),
             Piwik::isUserHasSomeAdminAccess(),
             $order = 6);
-        Piwik_AddAdminSubMenu('CoreAdminHome_MenuManage', 'CoreAdminHome_TrackingCode',
+        MenuAdmin::getInstance()->add('CoreAdminHome_MenuManage', 'CoreAdminHome_TrackingCode',
             array('module' => 'CoreAdminHome', 'action' => 'trackingCodeGenerator'),
             Piwik::isUserHasSomeAdminAccess(),
             $order = 4);

diff --git a/plugins/CoreAdminHome/templates/_menu.twig b/plugins/CoreAdminHome/templates/_menu.twig
@@ -1,7 +1,7 @@
-{% if menu|length > 1 %}
+{% if adminMenu|length > 1 %}
     <div class="Menu Menu--admin">
         <ul class="Menu-tabList">
-        {% for name,submenu in menu %}
+        {% for name,submenu in adminMenu %}
             {% if submenu._hasSubmenu %}
             <li>
                 <span>{{ name|translate }}</span>

diff --git a/plugins/CoreHome/Controller.php b/plugins/CoreHome/Controller.php
@@ -15,6 +15,7 @@
 use Piwik\Common;
 use Piwik\Date;
 use Piwik\FrontController;
+use Piwik\Menu\MenuMain;
 use Piwik\Piwik;
 use Piwik\Plugins\CoreHome\DataTableRowAction\MultiRowEvolution;
 use Piwik\Plugins\CoreHome\DataTableRowAction\RowEvolution;
@@ -72,7 +73,7 @@ protected function getDefaultIndexView()
     {
         $view = new View('@CoreHome/getDefaultIndexView');
         $this->setGeneralVariablesView($view);
-        $view->menu = Piwik_GetMenu();
+        $view->menu = MenuMain::getInstance()->getMenu();
         $view->content = '';
         return $view;
     }

diff --git a/plugins/CorePluginsAdmin/CorePluginsAdmin.php b/plugins/CorePluginsAdmin/CorePluginsAdmin.php
@@ -10,6 +10,7 @@
  */
 namespace Piwik\Plugins\CorePluginsAdmin;
 
+use Piwik\Menu\MenuAdmin;
 use Piwik\Piwik;
 use Piwik\ScheduledTask;
 use Piwik\ScheduledTime\Daily;
@@ -71,16 +72,16 @@ function addMenu()
             }
         }
 
-        Piwik_AddAdminSubMenu('CorePluginsAdmin_MenuPlatform', null, "", !Piwik::isUserIsAnonymous(), $order = 15);
-        Piwik_AddAdminSubMenu('CorePluginsAdmin_MenuPlatform', Piwik::translate('General_Plugins') . $pluginsUpdateMessage,
+        MenuAdmin::getInstance()->add('CorePluginsAdmin_MenuPlatform', null, "", !Piwik::isUserIsAnonymous(), $order = 15);
+        MenuAdmin::getInstance()->add('CorePluginsAdmin_MenuPlatform', Piwik::translate('General_Plugins') . $pluginsUpdateMessage,
             array('module' => 'CorePluginsAdmin', 'action' => 'plugins', 'activated' => ''),
             Piwik::isUserIsSuperUser(),
             $order = 1);
-        Piwik_AddAdminSubMenu('CorePluginsAdmin_MenuPlatform', Piwik::translate('CorePluginsAdmin_Themes') . $themesUpdateMessage,
+        MenuAdmin::getInstance()->add('CorePluginsAdmin_MenuPlatform', Piwik::translate('CorePluginsAdmin_Themes') . $themesUpdateMessage,
             array('module' => 'CorePluginsAdmin', 'action' => 'themes', 'activated' => ''),
             Piwik::isUserIsSuperUser(),
             $order = 3);
-        Piwik_AddAdminSubMenu('CorePluginsAdmin_MenuPlatform', 'CorePluginsAdmin_MenuExtend',
+        MenuAdmin::getInstance()->add('CorePluginsAdmin_MenuPlatform', 'CorePluginsAdmin_MenuExtend',
             array('module' => 'CorePluginsAdmin', 'action' => 'extend', 'activated' => ''),
             !Piwik::isUserIsAnonymous(),
             $order = 5);

diff --git a/plugins/CoreVisualizations/JqplotDataGenerator/Evolution.php b/plugins/CoreVisualizations/JqplotDataGenerator/Evolution.php
@@ -14,6 +14,7 @@
 use Piwik\Common;
 use Piwik\DataTable;
 use Piwik\DataTable\Row;
+use Piwik\Menu\MenuMain;
 use Piwik\Plugins\CoreVisualizations\JqplotDataGenerator;
 use Piwik\Url;
 use Piwik\ViewDataTable;
@@ -168,7 +169,7 @@ private function getQueryStringAsHash()
         foreach ($piwikParameters as $parameter) {
             unset($queryString[$parameter]);
         }
-        if (\Piwik\Menu\Main::getInstance()->isUrlFound($queryString)) {
+        if (MenuMain::getInstance()->isUrlFound($queryString)) {
             return $queryString;
         }
         return false;