Changed injection of structured data

Author: kevinmeijer97

README.md

@@ -25,6 +25,12 @@ You can install this addon via Composer:
 composer require justbetter/statamic-structured-data
 ```
 
+After installing make sure to load the Structured Data tag in your head.
+
+``` blade
+{!! Statamic::tag('structured-data:head')->fetch() !!}
+```
+
 ## Configuration
 
 Make sure to publish the config by running:

src/Actions/InjectStructuredDataAction.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace Justbetter\StatamicStructuredData\Actions;
+
+use Justbetter\StatamicStructuredData\Services\StructuredDataService;
+use Statamic\Entries\Entry;
+use Statamic\Facades\Entry as EntryFacade;
+use Statamic\Facades\Site;
+use Statamic\Facades\Term;
+use Statamic\Facades\URL;
+use Statamic\Structures\Page;
+use Statamic\Taxonomies\LocalizedTerm;
+
+class InjectStructuredDataAction
+{
+    public function __construct(protected StructuredDataService $structuredDataService) {}
+
+    public function execute(): ?string
+    {
+        $entry = $this->getCurrentEntry();
+
+        if ($entry) {
+            return $this->handleEntry($entry);
+        }
+
+        $term = $this->getCurrentTerm();
+
+        if ($term) {
+            return $this->handleTaxonomy($term);
+        }
+
+        return null;
+    }
+
+    protected function handleEntry(Entry|Page $entry): ?string
+    {
+        if ($entry instanceof Page) {
+            $entry = $entry->entry();
+        }
+
+        $enabledCollections = config('justbetter.structured-data.collections', []);
+
+        if (! in_array($entry?->collection()?->handle(), $enabledCollections)) {
+            return null;
+        }
+
+        return $this->handleScripts($entry);
+    }
+
+    protected function handleTaxonomy(LocalizedTerm $term): ?string
+    {
+        $enabledTaxonomies = config('justbetter.structured-data.taxonomies', []);
+
+        if (! in_array($term?->taxonomy()?->handle(), $enabledTaxonomies)) {
+            return null;
+        }
+
+        return $this->handleScripts($term);
+    }
+
+    protected function handleScripts(mixed $item): ?string
+    {
+        $scripts = $this->structuredDataService->getJsonLdScripts($item);
+
+        if (! $scripts ?? false) {
+            return null;
+        }
+
+        return implode("\n", $scripts);
+    }
+
+    protected function getCurrentEntry(): Page|Entry|null
+    {
+        $url = URL::getCurrent();
+
+        return EntryFacade::findByUri($url, Site::current()->handle());
+    }
+
+    protected function getCurrentTerm(): ?LocalizedTerm
+    {
+        $url = URL::getCurrent();
+
+        return Term::findByUri($url, Site::current()->handle());
+    }
+}

src/Http/Middleware/InjectStructuredData.php

@@ -6,7 +6,7 @@
 use Statamic\Events\TermBlueprintFound;
 use Statamic\Fields\Blueprint;
 
-class AddStructuredDataTab
+class AddStructuredDataTabListener
 {
     public function handle(EntryBlueprintFound|TermBlueprintFound $event): void
     {

src/Listeners/AddStructuredDataTab.php renamed to src/Listeners/AddStructuredDataTabListener.php

@@ -8,8 +8,8 @@
 use Justbetter\StatamicStructuredData\Fieldtypes\StructuredDataBuilder;
 use Justbetter\StatamicStructuredData\Fieldtypes\StructuredDataObjectBuilder;
 use Justbetter\StatamicStructuredData\Fieldtypes\StructuredDataPreview;
-use Justbetter\StatamicStructuredData\Http\Middleware\InjectStructuredData;
-use Justbetter\StatamicStructuredData\Listeners\AddStructuredDataTab;
+use Justbetter\StatamicStructuredData\Listeners\AddStructuredDataTabListener;
+use Justbetter\StatamicStructuredData\Tags\StructuredData;
 use Statamic\Events\EntryBlueprintFound;
 use Statamic\Events\TermBlueprintFound;
 use Statamic\Facades\Blueprint;
@@ -29,36 +29,35 @@ class ServiceProvider extends AddonServiceProvider
         'publicDirectory' => 'resources/dist',
     ];
 
+    protected $tags = [
+        StructuredData::class,
+    ];
+
     protected $fieldtypes = [
         StructuredDataBuilder::class,
         StructuredDataPreview::class,
         StructuredDataObjectBuilder::class,
         AvailableVariablesFieldtype::class,
     ];
 
-    protected $middlewareGroups = [
-        'web' => [
-            InjectStructuredData::class,
-        ],
-    ];
-
-    public function bootAddon()
+    public function bootAddon(): void
     {
         $this->bootCollections()
             ->bootTaxonomies()
             ->bootConfig()
+            ->bootActions()
             ->bootEvents();
     }
 
-    public function bootEvents()
+    public function bootEvents(): self
     {
-        Event::listen(EntryBlueprintFound::class, AddStructuredDataTab::class);
-        Event::listen(TermBlueprintFound::class, AddStructuredDataTab::class);
+        Event::listen(EntryBlueprintFound::class, AddStructuredDataTabListener::class);
+        Event::listen(TermBlueprintFound::class, AddStructuredDataTabListener::class);
 
         return $this;
     }
 
-    public function bootCollections()
+    public function bootCollections(): self
     {
         if ($this->app->runningInConsole() || Collection::find('structured_data_templates')) {
             return $this;
@@ -80,7 +79,7 @@ public function bootCollections()
         return $this;
     }
 
-    public function bootTaxonomies()
+    public function bootTaxonomies(): self
     {
         if ($this->app->runningInConsole() || Taxonomy::find('structured_data_objects')) {
             return $this;
@@ -102,7 +101,7 @@ public function bootTaxonomies()
         return $this;
     }
 
-    protected function bootConfig()
+    protected function bootConfig(): self
     {
         $this->publishes([
             __DIR__.'/../config/structured-data.php' => config_path('justbetter/structured-data.php'),

src/ServiceProvider.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Justbetter\StatamicStructuredData\Tags;
+
+use Justbetter\StatamicStructuredData\Actions\InjectStructuredDataAction;
+use Statamic\Tags\Tags;
+
+class StructuredData extends Tags
+{
+    protected static $handle = 'structured-data';
+
+    protected $action;
+
+    public function __construct(InjectStructuredDataAction $action)
+    {
+        $this->action = $action;
+    }
+
+    public function head(): ?string
+    {
+        return $this->action->execute();
+    }
+}