[5.x] Support query scopes in navigations (#13509)

Author: el-schneider

resources/js/components/navigation/View.vue

@@ -131,6 +131,7 @@
             ref="selector"
             :site="site"
             :collections="collections"
+            :query-scopes="entryQueryScopes"
             :max-items="maxPagesSelection"
             :can-select-across-sites="canSelectAcrossSites"
             @selected="entriesSelected"
@@ -208,7 +209,8 @@ export default {
         sites: { type: Array, required: true },
         blueprint: { type: Object, required: true },
         canEdit: { type: Boolean, required: true },
-        canSelectAcrossSites: { type: Boolean, required: true }
+        canSelectAcrossSites: { type: Boolean, required: true },
+        entryQueryScopes: { type: Array, default: () => [] },
     },
 
     data() {

resources/js/components/structures/PageSelector.vue

@@ -29,6 +29,10 @@ export default {
         site: String,
         collections: Array,
         canSelectAcrossSites: Boolean,
+        queryScopes: {
+            type: Array,
+            default: () => []
+        },
         maxItems: {
             type: Number,
             required: false,
@@ -41,6 +45,7 @@ export default {
                 type: 'entries',
                 collections: this.collections,
                 select_across_sites: this.canSelectAcrossSites,
+                query_scopes: this.queryScopes,
             },
             columns: [
                 { label: __('Title'), field: 'title' },

resources/views/navigation/show.blade.php

@@ -14,6 +14,7 @@
         site="{{ $site }}"
         :sites="{{ json_encode($sites) }}"
         :collections="{{ json_encode($collections) }}"
+        :entry-query-scopes='@json($collections_query_scopes)'
         :max-depth="{{ $nav->maxDepth() ?? 'Infinity' }}"
         :expects-root="{{ $str::bool($expectsRoot) }}"
         :blueprint="{{ json_encode($blueprint) }}"

src/Http/Controllers/CP/Navigation/NavigationController.php

@@ -6,9 +6,11 @@
 use Statamic\Contracts\Structures\Nav as NavContract;
 use Statamic\Facades\Blueprint;
 use Statamic\Facades\Nav;
+use Statamic\Facades\Scope;
 use Statamic\Facades\Site;
 use Statamic\Facades\User;
 use Statamic\Http\Controllers\CP\CpController;
+use Statamic\Query\Scopes\Filter;
 use Statamic\Rules\Handle;
 use Statamic\Support\Arr;
 
@@ -46,6 +48,7 @@ public function edit($nav)
             'title' => $nav->title(),
             'handle' => $nav->handle(),
             'collections' => $nav->collections()->map->handle()->all(),
+            'collections_query_scopes' => $nav->collectionsQueryScopes(),
             'root' => $nav->expectsRoot(),
             'sites' => $nav->trees()->keys()->all(),
             'max_depth' => $nav->maxDepth(),
@@ -86,6 +89,7 @@ public function show(Request $request, $nav)
             'nav' => $nav,
             'expectsRoot' => $nav->expectsRoot(),
             'collections' => $nav->collections()->map->handle()->all(),
+            'collections_query_scopes' => $nav->collectionsQueryScopes(),
             'sites' => $this->getAuthorizedTreesForNav($nav)->map(function ($tree) {
                 return [
                     'handle' => $tree->locale(),
@@ -120,6 +124,7 @@ public function update(Request $request, $nav)
             ->title($values['title'])
             ->expectsRoot($values['root'])
             ->collections($values['collections'])
+            ->collectionsQueryScopes(Arr::get($values, 'collections_query_scopes', []))
             ->maxDepth($values['max_depth']);
 
         $existingSites = $nav->trees()->keys()->all();
@@ -212,6 +217,16 @@ public function editFormBlueprint($nav)
                         'type' => 'collections',
                         'mode' => 'select',
                     ],
+                    'collections_query_scopes' => [
+                        'display' => __('Query Scopes'),
+                        'instructions' => __('statamic::fieldtypes.entries.config.query_scopes'),
+                        'type' => 'taggable',
+                        'options' => Scope::all()
+                            ->reject(fn ($scope) => $scope instanceof Filter)
+                            ->map->handle()
+                            ->values()
+                            ->all(),
+                    ],
                     'root' => [
                         'display' => __('Expect a root page'),
                         'instructions' => __('statamic::messages.expect_root_instructions'),

src/Stache/Stores/NavigationStore.php

@@ -36,6 +36,7 @@ public function makeItemFromFile($path, $contents)
             ->title($data['title'] ?? null)
             ->maxDepth($data['max_depth'] ?? null)
             ->collections($data['collections'] ?? null)
+            ->collectionsQueryScopes($data['collections_query_scopes'] ?? [])
             ->expectsRoot($data['root'] ?? false)
             ->canSelectAcrossSites($data['select_across_sites'] ?? false)
             ->initialPath($path);

src/Structures/Nav.php

@@ -19,13 +19,15 @@
 use Statamic\Facades\Collection;
 use Statamic\Facades\Site;
 use Statamic\Facades\Stache;
+use Statamic\Support\Str;
 
 class Nav extends Structure implements Contract
 {
     use ExistsAsFile;
 
     protected $collections;
     protected $canSelectAcrossSites = false;
+    protected $collectionsQueryScopes = [];
     private $blueprintCache;
 
     public function save()
@@ -77,6 +79,7 @@ public function fileData()
         return [
             'title' => $this->title,
             'collections' => $this->collections,
+            'collections_query_scopes' => empty($this->collectionsQueryScopes) ? null : $this->collectionsQueryScopes,
             'select_across_sites' => $this->canSelectAcrossSites ? true : null,
             'max_depth' => $this->maxDepth,
             'root' => $this->expectsRoot ?: null,
@@ -165,4 +168,23 @@ public function canSelectAcrossSites($canSelect = null)
             ->fluentlyGetOrSet('canSelectAcrossSites')
             ->args(func_get_args());
     }
+
+    public function collectionsQueryScopes($scopes = null)
+    {
+        return $this
+            ->fluentlyGetOrSet('collectionsQueryScopes')
+            ->setter(function ($scopes) {
+                if (empty($scopes)) {
+                    return [];
+                }
+
+                return collect($scopes)
+                    ->filter()
+                    ->map(fn ($scope) => Str::snake($scope))
+                    ->unique()
+                    ->values()
+                    ->all();
+            })
+            ->args(func_get_args());
+    }
 }

tests/Data/Structures/NavTest.php

@@ -216,6 +216,29 @@ public function collections_can_be_get_and_set()
         $this->assertEquals([$collectionOne, $collectionTwo], $collections->all());
     }
 
+    #[Test]
+    public function collections_query_scopes_can_be_get_and_set()
+    {
+        $nav = $this->structure();
+
+        $this->assertEquals([], $nav->collectionsQueryScopes());
+
+        $return = $nav->collectionsQueryScopes(['scope_one', 'scope_two']);
+
+        $this->assertSame($nav, $return);
+        $this->assertEquals(['scope_one', 'scope_two'], $nav->collectionsQueryScopes());
+    }
+
+    #[Test]
+    public function collections_query_scopes_are_normalized()
+    {
+        $nav = $this->structure();
+
+        $nav->collectionsQueryScopes(['ScopeOne', 'scope_two', '', null, 'ScopeOne']);
+
+        $this->assertEquals(['scope_one', 'scope_two'], $nav->collectionsQueryScopes());
+    }
+
     #[Test]
     public function it_has_cp_urls()
     {

tests/Feature/Fieldtypes/RelationshipFieldtypeTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace Tests\Feature\Fieldtypes;
+
+use PHPUnit\Framework\Attributes\Test;
+use Statamic\Facades\Collection;
+use Statamic\Facades\Entry;
+use Statamic\Facades\User;
+use Statamic\Query\Scopes\Scope;
+use Tests\FakesRoles;
+use Tests\PreventSavingStacheItemsToDisk;
+use Tests\TestCase;
+
+class RelationshipFieldtypeTest extends TestCase
+{
+    use FakesRoles;
+    use PreventSavingStacheItemsToDisk;
+
+    private $collection;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        $this->collection = Collection::make('test')->save();
+
+        app('statamic.scopes')[StartsWithC::handle()] = StartsWithC::class;
+    }
+
+    #[Test]
+    public function it_filters_entries_by_query_scopes()
+    {
+        Entry::make()->collection('test')->slug('apple')->data(['title' => 'Apple'])->save();
+        Entry::make()->collection('test')->slug('carrot')->data(['title' => 'Carrot'])->save();
+        Entry::make()->collection('test')->slug('cherry')->data(['title' => 'Cherry'])->save();
+        Entry::make()->collection('test')->slug('banana')->data(['title' => 'Banana'])->save();
+
+        $this->setTestRoles(['test' => ['access cp']]);
+        $user = User::make()->assignRole('test')->save();
+
+        $config = base64_encode(json_encode([
+            'type' => 'entries',
+            'collections' => ['test'],
+            'query_scopes' => ['starts_with_c'],
+        ]));
+
+        $response = $this
+            ->actingAs($user)
+            ->get("/cp/fieldtypes/relationship?config={$config}&collections[0]=test")
+            ->assertOk();
+
+        $titles = collect($response->json('data'))->pluck('title')->all();
+
+        $this->assertCount(2, $titles);
+        $this->assertContains('Carrot', $titles);
+        $this->assertContains('Cherry', $titles);
+        $this->assertNotContains('Apple', $titles);
+        $this->assertNotContains('Banana', $titles);
+    }
+}
+
+class StartsWithC extends Scope
+{
+    public function apply($query, $params)
+    {
+        $query->where('title', 'like', 'C%');
+    }
+}

tests/Feature/Navigation/MocksStructures.php

@@ -19,6 +19,7 @@ private function createNav($handle)
             $s->shouldReceive('editUrl')->andReturn('/nav-edit-url');
             $s->shouldReceive('deleteUrl')->andReturn('/nav-delete-url');
             $s->shouldReceive('collections')->andReturn(collect());
+            $s->shouldReceive('collectionsQueryScopes')->andReturn([]);
             $s->shouldReceive('expectsRoot')->andReturnFalse();
             $s->shouldReceive('maxDepth')->andReturnNull();
             $s->shouldReceive('canSelectAcrossSites')->andReturnFalse();