Differentiate between page title and opengraph title (#55)

* Add migration stub to have an opengraph title column * Add opengraph title to SEO data and the model * Add og:title special handling * Add usage of openGraphTitle in tags * Add tests for opengraph_title column * Drop use of migration for opengraph title
ralphjsmit · Dec 20, 2023 · eebd11c · eebd11c
1 parent 27fe4c0
commit eebd11c
Show file tree

Hide file tree

Showing 7 changed files with 49 additions and 3 deletions.
diff --git a/src/Models/SEO.php b/src/Models/SEO.php
@@ -47,6 +47,7 @@ public function prepareForUsage(): SEOData
             locale: $overrides->locale ?? null,
             robots: $overrides->robots ?? $this->robots,
             canonical_url: $overrides->canonical_url ?? $this->canonical_url,
+            openGraphTitle: $overrides->openGraphTitle ?? null,
         );
     }
 }
diff --git a/src/Support/SEOData.php b/src/Support/SEOData.php
@@ -32,6 +32,7 @@ public function __construct(
         public ?string $locale = null,
         public ?string $robots = null,
         public ?string $canonical_url = null,
+        public ?string $openGraphTitle = null,
     ) {
         if ( $this->locale === null ) {
             $this->locale = app()->getLocale();

diff --git a/src/TagManager.php b/src/TagManager.php
@@ -45,6 +45,10 @@ public function fillSEOData(SEOData $SEOData = null): SEOData
 
         if ( $SEOData->enableTitleSuffix ) {
             $SEOData->title .= config('seo.title.suffix');
+
+            if ($SEOData->openGraphTitle) {
+                $SEOData->openGraphTitle .= config('seo.title.suffix');
+            }
         }
 
         if ( $SEOData->image && ! filter_var($SEOData->image, FILTER_VALIDATE_URL) ) {

diff --git a/src/Tags/OpenGraphTags.php b/src/Tags/OpenGraphTags.php
@@ -17,7 +17,9 @@ public static function initialize(SEOData $SEOData): static
     {
         $collection = new static();
 
-        if ( $SEOData->title ) {
+        if ( $SEOData->openGraphTitle ) {
+            $collection->push(new OpenGraphTag('title', $SEOData->openGraphTitle));
+        } else if ( $SEOData->title ) {
             $collection->push(new OpenGraphTag('title', $SEOData->title));
         }
 

diff --git a/src/Tags/TwitterCardTags.php b/src/Tags/TwitterCardTags.php
@@ -31,7 +31,9 @@ public static function initialize(SEOData $SEOData): ?static
             $collection->push(new TwitterCardTag('card', 'summary'));
         }
 
-        if ( $SEOData->title ) {
+        if ( $SEOData->openGraphTitle ) {
+            $collection->push(new TwitterCardTag('title', $SEOData->openGraphTitle));
+        } else if ( $SEOData->title ) {
             $collection->push(new TwitterCardTag('title', $SEOData->title));
         }
 

diff --git a/tests/Feature/Tags/OpenGraphTagsTest.php b/tests/Feature/Tags/OpenGraphTagsTest.php
@@ -122,3 +122,20 @@
     get(route('seo.test-plain'))
         ->assertSee('<meta property="og:locale" content="en_GB">', false);
 });
+
+it('uses openGraphTitle over title', function() {
+    config()->set('seo.title.suffix', ' | Laravel SEO');
+
+    $page = Page::create();
+    $page::$overrides = [
+        'openGraphTitle' => 'My OG title',
+    ];
+    $page->seo->update([
+        'title' => 'My page title',
+    ]);
+
+    $page->refresh();
+
+    get(route('seo.test-page', ['page' => $page]))
+        ->assertSee('<meta property="og:title" content="My OG title | Laravel SEO">', false);
+});
diff --git a/tests/Feature/Tags/TwitterCardSummaryTagsTest.php b/tests/Feature/Tags/TwitterCardSummaryTagsTest.php
@@ -91,4 +91,23 @@
 })->with([
     ['images/twitter-72x72.jpg'],
     ['images/twitter-4721x4721.jpg'],
-]);
+]);
+
+
+
+it('uses openGraphTitle over title', function() {
+    config()->set('seo.title.suffix', ' | Laravel SEO');
+
+    $page = Page::create();
+    $page::$overrides = [
+        'openGraphTitle' => 'My OG title',
+    ];
+    $page->seo->update([
+        'title' => 'My page title',
+    ]);
+
+    $page->refresh();
+
+    get(route('seo.test-page', ['page' => $page]))
+        ->assertSee('<meta name="twitter:title" content="My OG title | Laravel SEO">', false);
+});