Automatically build mobile menus from navigation, and clean up external ProfileMenu API

Summary:
Depends on D20355. Ref T13275. Ref T13247. Currently, "Hamburger" menus are not automatically built from navigation menus. However, this is (I'm almost completely sure?) a reasonable and appropriate default behavior, and saves us some code around profile menus.

With this rule in place, we can remove `setApplicationMenu()` and `getApplicationMenu()` from `StandardPageView`, since they have no callers.

This also updates a lot of profile menu callsites to a new API which is added in the next change.

Test Plan: See the next two changes.

Reviewers: amckinley

Reviewed By: amckinley

Maniphest Tasks: T13275, T13247

Differential Revision: https://secure.phabricator.com/D20356

Author: epriestley

src/applications/favorites/engineextension/PhabricatorFavoritesMainMenuBarExtension.php

@@ -20,7 +20,7 @@ public function buildMainMenus() {
 
     $dropdown = $this->newDropdown($viewer);
     if (!$dropdown) {
-      return null;
+      return array();
     }
 
     $favorites_menu = id(new PHUIButtonView())
@@ -59,7 +59,8 @@ private function newDropdown(PhabricatorUser $viewer) {
       $menu_engine->setController($controller);
     }
 
-    $filter_view = $menu_engine->buildNavigation();
+    $filter_view = $menu_engine->newProfileMenuItemViewList()
+      ->newNavigationView();
 
     $menu_view = $filter_view->getMenu();
     $item_views = $menu_view->getItems();

src/applications/home/controller/PhabricatorHomeController.php

@@ -1,44 +1,4 @@
 <?php
 
-abstract class PhabricatorHomeController extends PhabricatorController {
-
-  private $home;
-  private $profileMenu;
-
-  public function buildApplicationMenu() {
-    $menu = $this->newApplicationMenu();
-
-    $profile_menu = $this->getProfileMenu();
-    if ($profile_menu) {
-      $menu->setProfileMenu($profile_menu);
-    }
-
-    return $menu;
-  }
-
-  protected function getProfileMenu() {
-    if (!$this->profileMenu) {
-      $viewer = $this->getViewer();
-      $applications = id(new PhabricatorApplicationQuery())
-        ->setViewer($viewer)
-        ->withClasses(array('PhabricatorHomeApplication'))
-        ->withInstalled(true)
-        ->execute();
-      $home = head($applications);
-      if (!$home) {
-        return null;
-      }
-
-      $engine = id(new PhabricatorHomeProfileMenuEngine())
-        ->setViewer($viewer)
-        ->setController($this)
-        ->setProfileObject($home)
-        ->setCustomPHID($viewer->getPHID());
-
-      $this->profileMenu = $engine->buildNavigation();
-    }
-
-    return $this->profileMenu;
-  }
-
-}
+abstract class PhabricatorHomeController
+  extends PhabricatorController {}

src/applications/people/controller/PhabricatorPeopleProfileBadgesController.php

@@ -30,8 +30,9 @@ public function handleRequest(AphrontRequest $request) {
     $crumbs->addTextCrumb(pht('Badges'));
     $crumbs->setBorder(true);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorPeopleProfileMenuEngine::ITEM_BADGES);
+    $nav = $this->newNavigation(
+      $user,
+      PhabricatorPeopleProfileMenuEngine::ITEM_BADGES);
 
     // Best option?
     $badges = id(new PhabricatorBadgesQuery())

src/applications/people/controller/PhabricatorPeopleProfileCommitsController.php

@@ -32,8 +32,9 @@ public function handleRequest(AphrontRequest $request) {
     $crumbs->addTextCrumb(pht('Recent Commits'));
     $crumbs->setBorder(true);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorPeopleProfileMenuEngine::ITEM_COMMITS);
+    $nav = $this->newNavigation(
+      $user,
+      PhabricatorPeopleProfileMenuEngine::ITEM_COMMITS);
 
     $view = id(new PHUITwoColumnView())
       ->setHeader($header)

src/applications/people/controller/PhabricatorPeopleProfileController.php

@@ -4,7 +4,6 @@ abstract class PhabricatorPeopleProfileController
   extends PhabricatorPeopleController {
 
   private $user;
-  private $profileMenu;
 
   public function shouldRequireAdmin() {
     return false;
@@ -19,34 +18,6 @@ public function getUser() {
     return $this->user;
   }
 
-  public function buildApplicationMenu() {
-    $menu = $this->newApplicationMenu();
-
-    $profile_menu = $this->getProfileMenu();
-    if ($profile_menu) {
-      $menu->setProfileMenu($profile_menu);
-    }
-
-    return $menu;
-  }
-
-  protected function getProfileMenu() {
-    if (!$this->profileMenu) {
-      $user = $this->getUser();
-      if ($user) {
-        $viewer = $this->getViewer();
-
-        $engine = id(new PhabricatorPeopleProfileMenuEngine())
-          ->setViewer($viewer)
-          ->setProfileObject($user);
-
-        $this->profileMenu = $engine->buildNavigation();
-      }
-    }
-
-    return $this->profileMenu;
-  }
-
   protected function buildApplicationCrumbs() {
     $crumbs = parent::buildApplicationCrumbs();
 
@@ -138,4 +109,24 @@ public function buildProfileHeader() {
     return $header;
   }
 
+  final protected function newNavigation(
+    PhabricatorUser $user,
+    $item_identifier) {
+
+    $viewer = $this->getViewer();
+
+    $engine = id(new PhabricatorPeopleProfileMenuEngine())
+      ->setViewer($viewer)
+      ->setController($this)
+      ->setProfileObject($user);
+
+    $view_list = $engine->newProfileMenuItemViewList();
+
+    $view_list->setSelectedViewWithItemIdentifier($item_identifier);
+
+    $navigation = $view_list->newNavigationView();
+
+    return $navigation;
+  }
+
 }

src/applications/people/controller/PhabricatorPeopleProfileManageController.php

@@ -29,8 +29,9 @@ public function handleRequest(AphrontRequest $request) {
     $properties = $this->buildPropertyView($user);
     $name = $user->getUsername();
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorPeopleProfileMenuEngine::ITEM_MANAGE);
+    $nav = $this->newNavigation(
+      $user,
+      PhabricatorPeopleProfileMenuEngine::ITEM_MANAGE);
 
     $crumbs = $this->buildApplicationCrumbs();
     $crumbs->addTextCrumb(pht('Manage'));

src/applications/people/controller/PhabricatorPeopleProfileRevisionsController.php

@@ -32,8 +32,9 @@ public function handleRequest(AphrontRequest $request) {
     $crumbs->addTextCrumb(pht('Recent Revisions'));
     $crumbs->setBorder(true);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorPeopleProfileMenuEngine::ITEM_REVISIONS);
+    $nav = $this->newNavigation(
+      $user,
+      PhabricatorPeopleProfileMenuEngine::ITEM_REVISIONS);
 
     $view = id(new PHUITwoColumnView())
       ->setHeader($header)

src/applications/people/controller/PhabricatorPeopleProfileTasksController.php

@@ -32,8 +32,9 @@ public function handleRequest(AphrontRequest $request) {
     $crumbs->addTextCrumb(pht('Assigned Tasks'));
     $crumbs->setBorder(true);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorPeopleProfileMenuEngine::ITEM_TASKS);
+    $nav = $this->newNavigation(
+      $user,
+      PhabricatorPeopleProfileMenuEngine::ITEM_TASKS);
 
     $view = id(new PHUITwoColumnView())
       ->setHeader($header)

src/applications/people/controller/PhabricatorPeopleProfileViewController.php

@@ -64,15 +64,16 @@ public function handleRequest(AphrontRequest $request) {
           $calendar,
         ));
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorPeopleProfileMenuEngine::ITEM_PROFILE);
+    $navigation = $this->newNavigation(
+      $user,
+      PhabricatorPeopleProfileMenuEngine::ITEM_PROFILE);
 
     $crumbs = $this->buildApplicationCrumbs();
     $crumbs->setBorder(true);
 
     return $this->newPage()
       ->setTitle($user->getUsername())
-      ->setNavigation($nav)
+      ->setNavigation($navigation)
       ->setCrumbs($crumbs)
       ->setPageObjectPHIDs(
         array(

src/applications/project/controller/PhabricatorProjectBoardViewController.php

@@ -172,7 +172,9 @@ public function handleRequest(AphrontRequest $request) {
         return $content;
       }
 
-      $nav = $this->newWorkboardProfileMenu();
+      $nav = $this->newNavigation(
+        $project,
+        PhabricatorProject::ITEM_WORKBOARD);
 
       $crumbs = $this->buildApplicationCrumbs();
       $crumbs->addTextCrumb(pht('Workboard'));
@@ -719,7 +721,9 @@ public function handleRequest(AphrontRequest $request) {
       ->appendChild($board)
       ->addClass('project-board-wrapper');
 
-    $nav = $this->newWorkboardProfileMenu();
+    $nav = $this->newNavigation(
+      $project,
+      PhabricatorProject::ITEM_WORKBOARD);
 
     $divider = id(new PHUIListItemView())
       ->setType(PHUIListItemView::TYPE_DIVIDER);
@@ -1503,15 +1507,4 @@ private function buildDisabledContent(PhabricatorProject $project) {
       ->addCancelButton($profile_uri);
   }
 
-  private function newWorkboardProfileMenu() {
-    $default_item = id(new PhabricatorProfileMenuItemConfiguration())
-      ->setBuiltinKey(PhabricatorProject::ITEM_WORKBOARD);
-
-    $menu = parent::getProfileMenu($default_item);
-
-    $menu->addClass('project-board-nav');
-
-    return $menu;
-  }
-
 }

src/applications/project/controller/PhabricatorProjectController.php

@@ -84,30 +84,6 @@ protected function loadProject() {
     return null;
   }
 
-  public function buildApplicationMenu() {
-    $menu = $this->newApplicationMenu();
-
-    $profile_menu = $this->getProfileMenu();
-    if ($profile_menu) {
-      $menu->setProfileMenu($profile_menu);
-    }
-
-    $menu->setSearchEngine(new PhabricatorProjectSearchEngine());
-
-    return $menu;
-  }
-
-  protected function getProfileMenu($default_item = null) {
-    if (!$this->profileMenu) {
-      $engine = $this->getProfileMenuEngine();
-      if ($engine) {
-        $this->profileMenu = $engine->buildNavigation($default_item);
-      }
-    }
-
-    return $this->profileMenu;
-  }
-
   protected function buildApplicationCrumbs() {
     return $this->newApplicationCrumbs('profile');
   }
@@ -207,4 +183,23 @@ public function renderHashtags(array $tags) {
     return implode(', ', $result);
   }
 
+  final protected function newNavigation(
+    PhabricatorProject $project,
+    $item_identifier) {
+
+    $engine = $this->getProfileMenuEngine();
+
+    $view_list = $engine->newProfileMenuItemViewList();
+
+    $view_list->setSelectedViewWithItemIdentifier($item_identifier);
+
+    $navigation = $view_list->newNavigationView();
+
+    if ($item_identifier === PhabricatorProject::ITEM_WORKBOARD) {
+      $navigation->addClass('project-board-nav');
+    }
+
+    return $navigation;
+  }
+
 }

src/applications/project/controller/PhabricatorProjectManageController.php

@@ -37,8 +37,9 @@ public function handleRequest(AphrontRequest $request) {
       new PhabricatorProjectTransactionQuery());
     $timeline->setShouldTerminate(true);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorProject::ITEM_MANAGE);
+    $nav = $this->newNavigation(
+      $project,
+      PhabricatorProject::ITEM_MANAGE);
 
     $crumbs = $this->buildApplicationCrumbs();
     $crumbs->addTextCrumb(pht('Manage'));

src/applications/project/controller/PhabricatorProjectMembersViewController.php

@@ -36,8 +36,9 @@ public function handleRequest(AphrontRequest $request) {
       ->setUserPHIDs($project->getWatcherPHIDs())
       ->setShowNote(true);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorProject::ITEM_MEMBERS);
+    $nav = $this->newNavigation(
+      $project,
+      PhabricatorProject::ITEM_MEMBERS);
 
     $crumbs = $this->buildApplicationCrumbs();
     $crumbs->addTextCrumb(pht('Members'));

src/applications/project/controller/PhabricatorProjectProfileController.php

@@ -74,8 +74,9 @@ public function handleRequest(AphrontRequest $request) {
       ->setBackground(PHUIObjectBoxView::BLUE_PROPERTY)
       ->setUserPHIDs($project->getWatcherPHIDs());
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorProject::ITEM_PROFILE);
+    $nav = $this->newNavigation(
+      $project,
+      PhabricatorProject::ITEM_PROFILE);
 
     $stories = id(new PhabricatorFeedQuery())
       ->setViewer($viewer)

src/applications/project/controller/PhabricatorProjectSubprojectsController.php

@@ -77,8 +77,9 @@ public function handleRequest(AphrontRequest $request) {
       $milestones,
       $subprojects);
 
-    $nav = $this->getProfileMenu();
-    $nav->selectFilter(PhabricatorProject::ITEM_SUBPROJECTS);
+    $nav = $this->newNavigation(
+      $project,
+      PhabricatorProject::ITEM_SUBPROJECTS);
 
     $crumbs = $this->buildApplicationCrumbs();
     $crumbs->addTextCrumb(pht('Subprojects'));

src/applications/project/controller/PhabricatorProjectViewController.php

@@ -18,7 +18,7 @@ public function handleRequest(AphrontRequest $request) {
     $project = $this->getProject();
 
     $engine = $this->getProfileMenuEngine();
-    $default = $engine->getDefaultItem();
+    $default = $engine->getDefaultMenuItemConfiguration();
 
     // If defaults are broken somehow, serve the manage page. See T13033 for
     // discussion.

src/applications/search/controller/PhabricatorApplicationSearchController.php

@@ -387,7 +387,6 @@ private function processSearchRequest() {
     require_celerity_resource('application-search-view-css');
 
     return $this->newPage()
-      ->setApplicationMenu($this->buildApplicationMenu())
       ->setTitle(pht('Query: %s', $title))
       ->setCrumbs($crumbs)
       ->setNavigation($nav)
@@ -611,7 +610,6 @@ private function processEditRequest() {
       ->setFooter($lists);
 
     return $this->newPage()
-      ->setApplicationMenu($this->buildApplicationMenu())
       ->setTitle(pht('Saved Queries'))
       ->setCrumbs($crumbs)
       ->setNavigation($nav)