Merge branch 'v5' into v5.0.11

Author: BenParizek

CHANGELOG/CHANGELOG-CORE.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 5.0.10 - 2026-02-16
+
+### Changed
+
+- Updated `BarrelStrength\Sprout\core\modules\CpNavHelper` to improve support for nav item positioning
+
+## 5.0.8 - 2026-02-14
+
+### Fixed
+
+- Fixed module nav items positioning in Craft 5.9 ([#372])
+
+[#372]: https://github.com/barrelstrength/sprout/issues/372
+
 ## 5.0.3 - 2025-03-07
 
 ### Fixed

CHANGELOG/CHANGELOG-DATA-STUDIO.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 5.0.9 - 2025-02-16
+
+### Fixed
+
+- Fixed settings field layout type assignment ([#373])
+
+[#373]: https://github.com/barrelstrength/sprout/issues/373
+
 ## 5.0.4 - 2025-03-09
 
 ### Fixed

CHANGELOG/CHANGELOG-REDIRECTS.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 5.0.9 - 2025-02-16
+
+- Fixed settings field layout type assignment ([#362])
+
+[#362]: https://github.com/barrelstrength/sprout/issues/362
+
 ## 5.0.6 - 2025-03-21
 
 ### Fixed

composer.json

@@ -2,7 +2,7 @@
     "name": "barrelstrength/sprout",
     "description": "The Sprout Framework module",
     "type": "craft-module",
-    "version": "5.0.6",
+    "version": "5.0.10",
     "license": "proprietary",
     "authors": [
         {

src/core/modules/CpNavHelper.php

@@ -2,53 +2,43 @@
 
 namespace BarrelStrength\Sprout\core\modules;
 
+use BarrelStrength\Sprout\core\db\SproutPluginMigrationInterface;
 use BarrelStrength\Sprout\core\Sprout;
+use Craft;
+use Illuminate\Support\Collection;
 
 class CpNavHelper
 {
     /**
      * Updates Craft's CP sidebar navigation to include nav items for Sprout modules
+     *
+     * Add $hasCpSection to any Sprout plugin that uses modules that should be added to the CP sidebar navigation.
      */
     public static function getUpdatedCpNavItems(array $cpNavItems): array
     {
-        $beforePluginNavItemKeys = [
-            'dashboard',
-            'entries',
-            'globals',
-            'categories',
-            'assets',
-            'users',
-        ];
-
-        $afterPluginNavItemKeys = [
-            'graphql',
-            'utilities',
-            'settings',
-            'plugin-store',
-        ];
-
-        $newCpNavItems = [];
-        $afterCpNavItems = [];
-        $otherCpNavItems = [];
-
-        // Break out the current nav into multiple arrays that we can re-assemble later
-        // 1. Craft defaults at the top of the nav
-        // 2. Plugins and stuff
-        // 3. Craft defaults and settings at bottom of nav
-        foreach ($cpNavItems as $cpNavItem) {
-            switch (true) {
-                case in_array($cpNavItem['url'], $beforePluginNavItemKeys, true):
-                    $newCpNavItems[] = $cpNavItem;
-                    break;
-
-                case in_array($cpNavItem['url'], $afterPluginNavItemKeys, true):
-                    $afterCpNavItems[] = $cpNavItem;
-                    break;
-                default:
-                    $otherCpNavItems[] = $cpNavItem;
-                    break;
+        $plugins = Craft::$app->getPlugins()->getAllPlugins();
+
+        $pluginsWithCpSections = array_filter($plugins, static function($plugin) {
+            return $plugin->hasCpSection;
+        });
+
+        // We have to enable $hasCpSection in each plugin then remove the default output just in case no other plugins with CP sections are installed
+        $cpNavSproutPluginNavKeys = array_keys(array_filter($pluginsWithCpSections, static function($plugin) {
+            return $plugin instanceof SproutPluginMigrationInterface;
+        }));
+
+        // get the nav items of the plugins with cp sections from the $cpNavItems based on the $pluginsWithCpSections matching the url to the plugin handle
+        $cpNavOldPluginNavItems = array_filter($cpNavItems, static function($navItem) use ($pluginsWithCpSections) {
+            foreach ($pluginsWithCpSections as $plugin) {
+                if ($navItem['url'] === $plugin->handle) {
+                    return true;
+                }
             }
-        }
+
+            return false;
+        });
+
+        $cpNavSproutModuleNavItems = [];
 
         $sproutNavGroupsInfo = Sprout::getInstance()->coreSettings->getCraftCpSidebarNavItems();
         $sproutNavGroups = [];
@@ -100,31 +90,55 @@ public static function getUpdatedCpNavItems(array $cpNavItems): array
                 unset($sproutNavGroup['subnav']);
             }
 
-            $otherCpNavItems[] = $sproutNavGroup;
+            $cpNavSproutModuleNavItems[] = $sproutNavGroup;
         }
 
-        // Sort custom nav items alphabetically by label
-        uasort($otherCpNavItems, static fn($a, $b) => $a['label'] <=> $b['label']);
+        $cpNavNewPluginNavItems = array_merge($cpNavOldPluginNavItems, $cpNavSproutModuleNavItems);
 
-        // Add the custom nav items back to the nav
-        foreach ($otherCpNavItems as $otherCpNavItem) {
-            $newCpNavItems[] = $otherCpNavItem;
-        }
+        $cpNavNewPluginNavItems = array_filter($cpNavNewPluginNavItems, static function($navItem) use ($cpNavSproutPluginNavKeys) {
+            foreach ($cpNavSproutPluginNavKeys as $sproutNavKey) {
+                if ($navItem['url'] === $sproutNavKey) {
+                    return false;
+                }
+            }
+
+            return true;
+        });
 
-        // Add the Craft defaults back to the bottom of the nav
-        foreach ($afterCpNavItems as $afterCpNavItem) {
-            $newCpNavItems[] = $afterCpNavItem;
+        uasort($cpNavNewPluginNavItems, static fn($a, $b) => $a['label'] <=> $b['label']);
+
+        // Remove all the Sprout Plugin hasCpSection nav items
+        $newCpNavItems = array_filter($cpNavItems, static function($navItem) use ($pluginsWithCpSections) {
+            foreach ($pluginsWithCpSections as $plugin) {
+                if ($navItem['url'] === $plugin->handle) {
+                    return false;
+                }
+            }
+
+            return true;
+        });
+
+        // If no other plugins are installed and no modules are enabled, this will be the Sprout plugin and just get removed later
+        $cpNavFirstPluginItemKey = array_key_first($pluginsWithCpSections);
+        $cpNavFirstPluginItemIndex = Collection::make($cpNavItems)->search(fn(array $item) => $item['url'] === $cpNavFirstPluginItemKey);
+
+        // If we don't find any plugins with CP sections (a Sprout Plugin should always be there), we'll just add the Sprout Modules to the end of the nav
+        if ($cpNavFirstPluginItemIndex === false) {
+            $cpNavFirstPluginItemIndex = count($newCpNavItems);
         }
 
+        // Insert the Sprout Module nav items
+        array_splice($newCpNavItems, $cpNavFirstPluginItemIndex, 0, $cpNavNewPluginNavItems);
+
         return $newCpNavItems;
     }
 
     /**
      * Adds nav items for a give module to the Sprout settings sidebar navigation
      */
     public static function mergeSproutCpSettingsNavItems(
-        array  $oldNavItems,
-        array  $newNavItems,
+        array $oldNavItems,
+        array $newNavItems,
         string $groupName,
     ): array {
         $navItems = $oldNavItems;

src/datastudio/DataStudioSettings.php

@@ -35,6 +35,9 @@ public function getFieldLayout(): FieldLayout
     {
         // If there is a field layout, it's saved with a UID key and we just need the first value
         if ($fieldLayout = reset($this->fieldLayouts)) {
+            // @todo - this `type` value should be saved to the project config with the correct type but appears to be missing per one ticket. fix this in upgrade migrations
+            $fieldLayout['type'] = DataSetElement::class;
+
             return FieldLayout::createFromConfig($fieldLayout);
         }
 

src/redirects/RedirectsSettings.php

@@ -153,6 +153,9 @@ public function getFieldLayout(): FieldLayout
     {
         // If there is a field layout, it's saved with a UID key and we just need the first value
         if ($fieldLayout = reset($this->fieldLayouts)) {
+            // @todo - this `type` value should be saved to the project config with the correct type but appears to be missing per one ticket. fix this in upgrade migrations
+            $fieldLayout['type'] = RedirectElement::class;
+
             return FieldLayout::createFromConfig($fieldLayout);
         }