Improves canonical

happycog · May 18, 2024 · 168b6d6 · 168b6d6
1 parent 1ca44d6
commit 168b6d6
Show file tree

Hide file tree

Showing 5 changed files with 55 additions and 21 deletions.
diff --git a/CHANGELOG/CHANGELOG-META.md b/CHANGELOG/CHANGELOG-META.md
@@ -2,10 +2,15 @@
 
 ## 4.2.4 - UNRELEASED
 
+### Added
+
+- Added Canonical URL Meta Type
+
 ### Fixed
 
 - Fixed metadata field template paths for case sensitive systems ([#323])
 - Fixed optimized title and description fallback logic when template is null
+- Fixed bug where canonical URL was not respected as an override
 
 [#323]: https://github.com/barrelstrength/sprout/issues/323
 

diff --git a/src/meta/components/meta/CanonicalUrlMetaType.php b/src/meta/components/meta/CanonicalUrlMetaType.php
@@ -0,0 +1,44 @@
+<?php
+
+namespace BarrelStrength\Sprout\meta\components\meta;
+
+use BarrelStrength\Sprout\meta\metadata\MetaType;
+use Craft;
+use craft\base\Field;
+
+class CanonicalUrlMetaType extends MetaType
+{
+    protected ?string $canonical = null;
+
+    public static function displayName(): string
+    {
+        return Craft::t('sprout-module-meta', 'Canonical URL');
+    }
+
+    public function attributes(): array
+    {
+        $attributes = parent::attributes();
+        $attributes[] = 'canonical';
+
+        return $attributes;
+    }
+
+    public function getCanonical(): ?string
+    {
+        if ($this->canonical || $this->metadata->getRawDataOnly()) {
+            return $this->canonical ?? $this->metadata->getCanonical();
+        }
+
+        return $this->metadata->getCanonical();
+    }
+
+    public function setCanonical(?string $value): void
+    {
+        $this->canonical = $value;
+    }
+
+    public function getHandle(): string
+    {
+        return 'canonical';
+    }
+}
diff --git a/src/meta/components/meta/RobotsMetaType.php b/src/meta/components/meta/RobotsMetaType.php
@@ -9,8 +9,6 @@
 
 class RobotsMetaType extends MetaType
 {
-    protected ?string $canonical = null;
-
     protected string|array|null $robots = null;
 
     public static function displayName(): string
@@ -21,27 +19,11 @@ public static function displayName(): string
     public function attributes(): array
     {
         $attributes = parent::attributes();
-        $attributes[] = 'canonical';
         $attributes[] = 'robots';
 
         return $attributes;
     }
 
-    public function getCanonical(): ?string
-    {
-        if ($this->canonical || $this->metadata->getRawDataOnly()) {
-
-            return $this->canonical;
-        }
-
-        return $this->metadata->getCanonical();
-    }
-
-    public function setCanonical(?string $value): void
-    {
-        $this->canonical = $value;
-    }
-
     public function getRobots()
     {
         if ($this->robots || $this->metadata->getRawDataOnly()) {

diff --git a/src/meta/metadata/Metadata.php b/src/meta/metadata/Metadata.php
@@ -2,6 +2,7 @@
 
 namespace BarrelStrength\Sprout\meta\metadata;
 
+use BarrelStrength\Sprout\meta\components\meta\CanonicalUrlMetaType;
 use BarrelStrength\Sprout\meta\components\meta\GeoMetaType;
 use BarrelStrength\Sprout\meta\components\meta\OpenGraphMetaType;
 use BarrelStrength\Sprout\meta\components\meta\RobotsMetaType;
@@ -132,6 +133,7 @@ protected function setMetaTypes(array &$config = []): void
             new TwitterMetaType([], $this),
             new GeoMetaType([], $this),
             new RobotsMetaType([], $this),
+            new CanonicalUrlMetaType([], $this),
         ];
 
         foreach ($metaTypes as $metaType) {

diff --git a/src/meta/schema/Schema.php b/src/meta/schema/Schema.php
@@ -3,6 +3,7 @@
 namespace BarrelStrength\Sprout\meta\schema;
 
 use BarrelStrength\Sprout\forms\components\formfields\PhoneFormFieldData;
+use BarrelStrength\Sprout\meta\components\meta\CanonicalUrlMetaType;
 use BarrelStrength\Sprout\meta\components\meta\OpenGraphMetaType;
 use BarrelStrength\Sprout\meta\components\meta\RobotsMetaType;
 use BarrelStrength\Sprout\meta\components\schema\ContactPointSchema;
@@ -478,15 +479,15 @@ public function addMainEntityOfPage(): void
         $meta = $this->prioritizedMetadataModel;
 
         /** the prioritizedMetadataModel only has raw data, so we want the specific MetaType before we get our data */
-        $robots = $meta->getMetaType('robots');
+        $metaType = $meta->getMetaType('canonical');
 
-        if (!$robots instanceof RobotsMetaType) {
+        if (!$metaType instanceof CanonicalUrlMetaType) {
             return;
         }
 
         $mainEntity = new MainEntityOfPageSchema();
         $mainEntity->type = 'WebPage';
-        $mainEntity->id = $robots->getCanonical();
+        $mainEntity->id = $metaType->getCanonical();
 
         $mainEntity->prioritizedMetadataModel = $this->prioritizedMetadataModel;