Merge remote-tracking branch 'origin/8.x'

Author: duncanmcclean

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v8.6.0 (2025-08-11)
+
+### What's new
+* Allow programmatic registration of resources #707 by @Pluuk
+* Update RoutingModel `model` property to be publicly accessible #706 by @jamesmpigott
+
+### What's fixed
+* Fix error when searching via fieldtype #699 #709 by @duncanmcclean
+* Refactor `BaseFieldtype::getIndexItems` #708 by @duncanmcclean
+* Delete `php-cs-fixer.phar` #704 by @duncanmcclean
+
+
+
 ## v8.5.2 (2025-07-10)
 
 ### What's fixed

php-cs-fixer.phar

@@ -12,9 +12,12 @@
 use Statamic\CP\Column;
 use Statamic\Facades\Blink;
 use Statamic\Facades\Scope;
+use Statamic\Facades\Search;
 use Statamic\Fieldtypes\Relationship;
-use Statamic\Query\Builder as BaseStatamicBuilder;
+use Statamic\Http\Requests\FilteredRequest;
 use Statamic\Query\Scopes\Filter;
+use Statamic\Search\Index;
+use Statamic\Search\QueryBuilder as SearchQueryBuilder;
 use Statamic\Search\Result;
 use StatamicRadPack\Runway\Http\Resources\CP\FieldtypeModel;
 use StatamicRadPack\Runway\Http\Resources\CP\FieldtypeModels;
@@ -99,6 +102,11 @@ protected function configFieldItems(): array
                 'type' => 'text',
                 'width' => 50,
             ],
+            'search_index' => [
+                'display' => __('Search Index'),
+                'instructions' => __('An appropriate search index will be used automatically where possible, but you may define an explicit one.'),
+                'type' => 'text',
+            ],
             'query_scopes' => [
                 'display' => __('Query Scopes'),
                 'instructions' => __('Select which query fields should be applied when retrieving selectable models.'),
@@ -162,44 +170,68 @@ public function process($data)
 
     public function getIndexItems($request)
     {
-        $resource = $this->resource();
-
         $query = $this->getIndexQuery($request);
 
-        $searchQuery = $request->search ?? false;
+        $this->applyOrderingToIndexQuery($query, $request);
+
+        $results = ($paginate = $request->boolean('paginate', true)) ? $query->paginate() : $query->get();
+
+        $items = $results->map(fn ($item) => $item instanceof Result ? $item->getSearchable()->model() : $item);
 
-        $query = $this->applySearch($resource, $query, $searchQuery);
+        return $paginate ? $results->setCollection($items) : $items;
+    }
 
-        $query->when(method_exists($query, 'getQuery') && $query->getQuery()->orders, function ($query) use ($request, $resource) {
+    private function applyOrderingToIndexQuery(Builder|SearchQueryBuilder $query, FilteredRequest $request): void
+    {
+        $query->when(method_exists($query, 'getQuery') && $query->getQuery()->orders, function ($query) use ($request) {
             if ($orderBy = $request->input('sort')) {
                 // The stack selector always uses `title` as the default sort column, but
-                // the "title field" for the model might be a different column so we need to convert it.
-                $sortColumn = $orderBy === 'title' ? $resource->titleField() : $orderBy;
+                // the "title field" for the model might be a different column, so we need to convert it.
+                $sortColumn = $orderBy === 'title' ? $this->resource()->titleField() : $orderBy;
 
                 $query->reorder($sortColumn, $request->input('order'));
             }
-        }, fn ($query) => $query->orderBy($resource->orderBy(), $resource->orderByDirection()));
+        }, fn ($query) => $query->orderBy($this->resource()->orderBy(), $this->resource()->orderByDirection()));
+    }
 
-        $results = ($paginate = $request->boolean('paginate', true)) ? $query->paginate() : $query->get();
+    protected function getIndexQuery(FilteredRequest $request): Builder|SearchQueryBuilder
+    {
+        $query = $this->resource()->newEloquentQuery();
 
-        if ($searchQuery && $resource->hasSearchIndex()) {
-            $results->setCollection($results->getCollection()->map(fn ($item) => $item->getSearchable()->model()));
-        }
+        $query = $this->toSearchQuery($query, $request);
 
-        $items = $results->map(fn ($item) => $item instanceof Result ? $item->getSearchable() : $item);
+        $query->when($query instanceof Builder && $query->hasNamedScope('runwayListing'), fn ($query) => $query->runwayListing());
 
-        return $paginate ? $results->setCollection($items) : $items;
+        $this->applyIndexQueryScopes($query, $request->all());
+
+        return $query;
     }
 
-    protected function getIndexQuery($request)
+    private function toSearchQuery(Builder $query, FilteredRequest $request): Builder|SearchQueryBuilder
     {
-        $query = $this->resource()->newEloquentQuery();
+        if (! $search = $request->search) {
+            return $query;
+        }
 
-        $query->when($query->hasNamedScope('runwayListing'), fn ($query) => $query->runwayListing());
+        if ($index = $this->getSearchIndex()) {
+            return $index->search($search);
+        }
 
-        $this->applyIndexQueryScopes($query, $request->all());
+        return $query->runwaySearch($search);
+    }
 
-        return $query;
+    private function getSearchIndex(): ?Index
+    {
+        $index = $this->getExplicitSearchIndex() ?? $this->resource()->searchIndex();
+
+        return $index?->ensureExists();
+    }
+
+    private function getExplicitSearchIndex(): ?Index
+    {
+        return ($explicit = $this->config('search_index'))
+            ? Search::in($explicit)
+            : null;
     }
 
     public function getResourceCollection($request, $items)
@@ -370,19 +402,6 @@ protected function statusIcons()
         return $resource->hasPublishStates();
     }
 
-    private function applySearch(Resource $resource, Builder $query, string $searchQuery): Builder|BaseStatamicBuilder
-    {
-        if (! $searchQuery) {
-            return $query;
-        }
-
-        if ($resource->hasSearchIndex() && ($index = $resource->searchIndex())) {
-            return $index->ensureExists()->search($searchQuery);
-        }
-
-        return $query->runwaySearch($searchQuery);
-    }
-
     private function resource(): Resource
     {
         return Runway::findResource($this->config('resource'));

src/Fieldtypes/BaseFieldtype.php

@@ -7,6 +7,7 @@
 use Statamic\Contracts\Data\Augmentable;
 use Statamic\Data\ContainsSupplementalData;
 use Statamic\Data\HasAugmentedData;
+use StatamicRadPack\Runway\Resource;
 use StatamicRadPack\Runway\Runway;
 
 class RoutingModel implements Augmentable, Responsable
@@ -51,14 +52,19 @@ public function toResponse($request)
             ->toResponse($request);
     }
 
+    public function resource(): ?Resource
+    {
+        return Runway::findResourceByModel($this->model);
+    }
+
     public function template(): string
     {
-        return Runway::findResourceByModel($this->model)->template();
+        return $this->resource()->template();
     }
 
     public function layout(): string
     {
-        return Runway::findResourceByModel($this->model)->layout();
+        return $this->resource()->layout();
     }
 
     public function id()

src/Routing/RoutingModel.php

@@ -11,10 +11,12 @@
 class Runway
 {
     protected static array $resources = [];
+    protected static array $registeredResources = [];
 
     public static function discoverResources(): self
     {
         static::$resources = collect(config('runway.resources'))
+            ->merge(static::$registeredResources)
             ->mapWithKeys(function ($config, $model) {
                 $config = collect($config);
                 $handle = $config->get('handle', Str::snake(class_basename($model)));
@@ -66,6 +68,15 @@ public static function findResourceByModel(object $model): ?Resource
         return $resource;
     }
 
+    public static function registerResource(string $model, array $config): self
+    {
+        static::$registeredResources[$model] = $config;
+
+        static::discoverResources();
+
+        return new static;
+    }
+
     public static function usesRouting(): bool
     {
         return static::allResources()->filter->hasRouting()->count() >= 1;

src/Runway.php

@@ -6,6 +6,7 @@
 use Illuminate\Http\Response;
 use Illuminate\Support\Facades\Config;
 use PHPUnit\Framework\Attributes\Test;
+use StatamicRadPack\Runway\Resource;
 use StatamicRadPack\Runway\Routing\RoutingModel;
 use StatamicRadPack\Runway\Runway;
 use StatamicRadPack\Runway\Tests\Fixtures\Models\Post;
@@ -84,6 +85,18 @@ public function can_get_response()
         $this->assertStringContainsString("<article>{$post->body}</article>", $response->getContent());
     }
 
+    #[Test]
+    public function can_get_resource()
+    {
+        Runway::discoverResources();
+
+        $post = Post::factory()->createQuietly();
+
+        $routingModel = new RoutingModel($post);
+
+        $this->assertInstanceOf(Resource::class, $routingModel->resource());
+    }
+
     #[Test]
     public function can_get_template()
     {

tests/Routing/RoutingModelTest.php

@@ -8,6 +8,7 @@
 use Statamic\Fields\Blueprint;
 use StatamicRadPack\Runway\Resource;
 use StatamicRadPack\Runway\Runway;
+use StatamicRadPack\Runway\Tests\Fixtures\Models\Author;
 
 class RunwayTest extends TestCase
 {
@@ -49,4 +50,20 @@ public function can_find_resource()
         $this->assertTrue($find->model() instanceof Model);
         $this->assertTrue($find->blueprint() instanceof Blueprint);
     }
+
+    #[Test]
+    public function can_register_resource()
+    {
+        config()->set('runway.resources', []);
+
+        Runway::discoverResources();
+
+        $this->assertFalse(Runway::allResources()->has('author'));
+
+        Runway::registerResource(Author::class, [
+            'name' => 'Authors',
+        ]);
+
+        $this->assertTrue(Runway::allResources()->has('author'));
+    }
 }