[5.x] Add new 'Settings' CP Nav section (#9857)

statamic · Apr 11, 2024 · 966782f · 966782f
1 parent 32300df
commit 966782f
Show file tree

Hide file tree

Showing 13 changed files with 87 additions and 70 deletions.
diff --git a/resources/svg/icons/light/settings.svg b/resources/svg/icons/light/settings.svg
diff --git a/resources/views/partials/global-header.blade.php b/resources/views/partials/global-header.blade.php
@@ -56,16 +56,6 @@
             </a>
         @endif
 
-        <dropdown-list v-cloak>
-            <template v-slot:trigger>
-                <button class="hidden md:block h-6 w-6 rtl:mr-4 ltr:ml-4 p-1 text-gray hover:text-gray-800" v-tooltip="__('Preferences')" aria-label="{{ __('Manage Preferences') }}">
-                    @cp_svg('icons/light/cog')
-                </button>
-            </template>
-            <dropdown-item :text="__('Preferences')" redirect="{{ route('statamic.cp.preferences.index') }}"></dropdown-item>
-            <dropdown-item :text="__('CP Nav')" redirect="{{ route('statamic.cp.preferences.nav.index') }}"></dropdown-item>
-        </dropdown-list>
-
         <dropdown-list v-cloak>
             <template v-slot:trigger>
                 <button class="hidden md:block h-6 w-6 rtl:mr-4 ltr:ml-4 p-1 text-gray hover:text-gray-800" v-tooltip="__('Useful Links')" aria-label="{{ __('View Useful Links') }}">

diff --git a/routes/cp.php b/routes/cp.php
@@ -324,20 +324,21 @@
         Route::post('js', [PreferenceController::class, 'store'])->name('store');
         Route::delete('js/{key}', [PreferenceController::class, 'destroy'])->name('destroy');
 
-        Route::group(['prefix' => 'nav', 'as' => 'nav.'], function () {
-            Route::get('/', [NavController::class, 'index'])->name('index');
-            Route::get('edit', [UserNavController::class, 'edit'])->name('user.edit');
-            Route::patch('/', [UserNavController::class, 'update'])->name('user.update');
-            Route::delete('/', [UserNavController::class, 'destroy'])->name('user.destroy');
-
-            Route::middleware([RequireStatamicPro::class, 'can:manage preferences'])->group(function () {
-                Route::get('roles/{role}/edit', [RoleNavController::class, 'edit'])->name('role.edit');
-                Route::patch('roles/{role}', [RoleNavController::class, 'update'])->name('role.update');
-                Route::delete('roles/{role}', [RoleNavController::class, 'destroy'])->name('role.destroy');
-                Route::get('default/edit', [DefaultNavController::class, 'edit'])->name('default.edit');
-                Route::patch('default', [DefaultNavController::class, 'update'])->name('default.update');
-                Route::delete('default', [DefaultNavController::class, 'destroy'])->name('default.destroy');
-            });
+    });
+
+    Route::group(['prefix' => 'nav', 'as' => 'preferences.nav.'], function () {
+        Route::get('/', [NavController::class, 'index'])->name('index');
+        Route::get('edit', [UserNavController::class, 'edit'])->name('user.edit');
+        Route::patch('/', [UserNavController::class, 'update'])->name('user.update');
+        Route::delete('/', [UserNavController::class, 'destroy'])->name('user.destroy');
+
+        Route::middleware([RequireStatamicPro::class, 'can:manage preferences'])->group(function () {
+            Route::get('roles/{role}/edit', [RoleNavController::class, 'edit'])->name('role.edit');
+            Route::patch('roles/{role}', [RoleNavController::class, 'update'])->name('role.update');
+            Route::delete('roles/{role}', [RoleNavController::class, 'destroy'])->name('role.destroy');
+            Route::get('default/edit', [DefaultNavController::class, 'edit'])->name('default.edit');
+            Route::patch('default', [DefaultNavController::class, 'update'])->name('default.update');
+            Route::delete('default', [DefaultNavController::class, 'destroy'])->name('default.destroy');
         });
     });
 

diff --git a/src/CP/Navigation/CoreNav.php b/src/CP/Navigation/CoreNav.php
@@ -36,6 +36,7 @@ public static function make()
             ->makeContentSection()
             ->makeFieldsSection()
             ->makeToolsSection()
+            ->makeSettingsSection()
             ->makeUsersSection();
     }
 
@@ -147,11 +148,6 @@ protected function makeContentSection()
                     })->filter();
             });
 
-        Nav::content(Site::multiEnabled() ? 'Sites' : 'Site')
-            ->route('sites.edit')
-            ->icon('/sites')
-            ->can('configure sites');
-
         return $this;
     }
 
@@ -213,7 +209,7 @@ protected function makeToolsSection()
                 ->can('resolve duplicate ids');
         }
 
-        $this->makeUtilitiesSection();
+        $this->makeUtilitiesItems();
 
         if (config('statamic.graphql.enabled') && Statamic::pro()) {
             Nav::tools('GraphQL')
@@ -226,7 +222,12 @@ protected function makeToolsSection()
         return $this;
     }
 
-    protected function makeUtilitiesSection()
+    /**
+     * Make utilities items.
+     *
+     * @return $this
+     */
+    protected function makeUtilitiesItems()
     {
         $utilities = Utility::authorized()->sortBy->navTitle()->map(function ($utility) {
             return Nav::item($utility->navTitle())->url($utility->url());
@@ -242,6 +243,29 @@ protected function makeUtilitiesSection()
         return $this;
     }
 
+    /**
+     * Make settings section items.
+     *
+     * @return $this
+     */
+    protected function makeSettingsSection()
+    {
+        Nav::settings(Site::multiEnabled() ? 'Sites' : 'Site')
+            ->route('sites.edit')
+            ->icon('/sites')
+            ->can('configure sites');
+
+        Nav::settings('Preferences')
+            ->route('preferences.index')
+            ->icon('/settings')
+            ->children([
+                Nav::item('General')->route('preferences.index'),
+                Nav::item('CP Nav')->route('preferences.nav.index'),
+            ]);
+
+        return $this;
+    }
+
     /**
      * Make users section items.
      *

diff --git a/src/Exceptions/SiteNotFoundException.php b/src/Exceptions/SiteNotFoundException.php
@@ -22,7 +22,7 @@ public function __construct($siteHandle)
     public function getSolution(): Solution
     {
         return BaseSolution::create("The [{$this->siteHandle}] site was not found.")
-            ->setSolutionDescription('Check the spelling of the site handle in your [content/sites.yaml].')
+            ->setSolutionDescription('Check the spelling of the site handle in your [resources/sites.yaml].')
             ->setDocumentationLinks([
                 'Read the multi-site guide' => Statamic::docsUrl('/multi-site#configuration'),
             ]);

diff --git a/src/Sites/Sites.php b/src/Sites/Sites.php
@@ -118,7 +118,7 @@ public function setSiteValue(string $site, string $key, $value): self
 
     public function path(): string
     {
-        return base_path('content/sites.yaml');
+        return resource_path('sites.yaml');
     }
 
     protected function getSavedSites()

diff --git a/src/UpdateScripts/MigrateSitesConfigToYaml.php b/src/UpdateScripts/MigrateSitesConfigToYaml.php
@@ -16,7 +16,7 @@ public function shouldUpdate($newVersion, $oldVersion)
     public function update()
     {
         // Skip if already migrated
-        if (File::exists(base_path('content/sites.yaml'))) {
+        if (File::exists(resource_path('sites.yaml'))) {
             return;
         }
 
@@ -39,7 +39,7 @@ public function update()
             ->ensureMultisiteConfigEnabled($sites)
             ->removeOldSitesConfigFile();
 
-        $this->console->info('Successfully migrated [config/statamic/sites.php] to [content/sites.yaml]!');
+        $this->console->info('Successfully migrated [config/statamic/sites.php] to [resources/sites.yaml]!');
     }
 
     private function migrateSites($path)

diff --git a/tests/CP/Navigation/CoreNavTest.php b/tests/CP/Navigation/CoreNavTest.php
@@ -21,9 +21,10 @@ public function it_can_build_a_default_nav()
     {
         $expected = collect([
             'Top Level' => ['Dashboard', 'Playground'],
-            'Content' => ['Collections', 'Navigation', 'Taxonomies', 'Assets', 'Globals', 'Site'],
+            'Content' => ['Collections', 'Navigation', 'Taxonomies', 'Assets', 'Globals'],
             'Fields' => ['Blueprints', 'Fieldsets'],
             'Tools' => ['Forms', 'Updates', 'Addons', 'Utilities', 'GraphQL'],
+            'Settings' => ['Site', 'Preferences'],
             'Users' => ['Users', 'Groups', 'Permissions'],
         ]);
 
@@ -35,6 +36,7 @@ public function it_can_build_a_default_nav()
         $this->assertEquals($expected->get('Content'), $nav->get('Content')->map->display()->all());
         $this->assertEquals($expected->get('Fields'), $nav->get('Fields')->map->display()->all());
         $this->assertEquals($expected->get('Tools'), $nav->get('Tools')->map->display()->all());
+        $this->assertEquals($expected->get('Settings'), $nav->get('Settings')->map->display()->all());
         $this->assertEquals($expected->get('Users'), $nav->get('Users')->map->display()->all());
     }
 
@@ -48,8 +50,8 @@ public function it_builds_plural_sites_item_when_multisite_is_enabled()
         $nav = $this->build();
 
         $this->assertEquals(
-            ['Collections', 'Navigation', 'Taxonomies', 'Assets', 'Globals', 'Sites'],
-            $nav->get('Content')->map->display()->all()
+            ['Sites', 'Preferences'],
+            $nav->get('Settings')->map->display()->all()
         );
     }