Support x-default locale code for SEO

Sortable Locales
tractorcow-farm · Feb 14, 2020 · f55a0ea · f55a0ea
1 parent d864f5b
commit f55a0ea
Show file tree

Hide file tree

Showing 7 changed files with 93 additions and 26 deletions.
diff --git a/src/Control/LocaleAdmin.php b/src/Control/LocaleAdmin.php
@@ -3,9 +3,11 @@
 namespace TractorCow\Fluent\Control;
 
 use SilverStripe\Admin\ModelAdmin;
+use SilverStripe\Forms\GridField\GridField;
 use SilverStripe\Security\Member;
 use SilverStripe\Security\Security;
 use SilverStripe\View\Requirements;
+use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
 use TractorCow\Fluent\Extension\FluentDirectorExtension;
 use TractorCow\Fluent\Extension\FluentMemberExtension;
 use TractorCow\Fluent\Model\Domain;
@@ -36,6 +38,21 @@ protected function init()
         Requirements::css("tractorcow/silverstripe-fluent:client/dist/styles/fluent.css");
     }
 
+    public function getEditForm($id = null, $fields = null)
+    {
+        $form = parent::getEditForm($id, $fields);
+
+        // Add sortable field to locales
+        if ($this->modelClass === Locale::class) {
+            /** @var GridField $listField */
+            $listField = $form->Fields()->dataFieldByName($this->sanitiseClassName($this->modelClass));
+            $config = $listField->getConfig();
+            $config->addComponent(new GridFieldOrderableRows('Sort'));
+        }
+
+        return $form;
+    }
+
     public function getClientConfig()
     {
         /** @var Member|FluentMemberExtension $member */

diff --git a/src/Model/Locale.php b/src/Model/Locale.php
@@ -35,6 +35,7 @@
  * @property string $URLSegment
  * @property bool $IsGlobalDefault
  * @property int $DomainID
+ * @property bool $UseDefaultCode
  * @method HasManyList|FallbackLocale[] FallbackLocales()
  * @method ManyManyList|Locale[] Fallbacks()
  * @method Domain Domain() Raw SQL Domain (unfiltered by domain mode)
@@ -62,6 +63,13 @@ class Locale extends DataObject implements PermissionProvider
 
     private static $plural_name = 'Locales';
 
+    /**
+     * hreflang for default landing pages.
+     * Note: PHP's ext-intl doesn't support this code, so only use it
+     * in templates.
+     */
+    const X_DEFAULT = 'x-default';
+
     private static $summary_fields = [
         'Title'           => 'Title',
         'Locale'          => 'Locale',
@@ -79,9 +87,11 @@ class Locale extends DataObject implements PermissionProvider
         'Locale'          => 'Varchar(10)',
         'URLSegment'      => 'Varchar(100)',
         'IsGlobalDefault' => 'Boolean',
+        'UseDefaultCode'  => 'Boolean',
+        'Sort'            => 'Int',
     ];
 
-    private static $default_sort = '"Fluent_Locale"."Locale" ASC';
+    private static $default_sort = '"Fluent_Locale"."Sort" ASC, "Fluent_Locale"."Locale" ASC';
 
     /**
      * @config
@@ -203,6 +213,19 @@ public function getBadgeLabel()
         return (string)$badgeLabel;
     }
 
+    /**
+     * RFC 1766 hreflang
+     *
+     * @return string
+     */
+    public function getHrefLang()
+    {
+        if ($this->UseDefaultCode) {
+            return self::X_DEFAULT;
+        }
+        return i18n::convert_rfc1766($this->Locale);
+    }
+
     /**
      * Get URLSegment for this locale
      *
@@ -250,6 +273,14 @@ public function getCMSFields()
                         'Note: Per-domain specific locale can be assigned on the Locales tab'
                         . ' and will override this value for specific domains.'
                     )),
+                CheckboxField::create(
+                    'UseDefaultCode',
+                    _t(__CLASS__ . '.USE_X_DEFAULT', 'Use {code} as hreflang', ['code' => self::X_DEFAULT])
+                )
+                    ->setDescription(_t(
+                        __CLASS__ . '.USE_X_DEFAULT_DESCRIPTION',
+                        'Use of this code indicates to search engine that this is a non-localised global landing page'
+                    )),
                 DropdownField::create(
                     'DomainID',
                     _t(__CLASS__ . '.DOMAIN', 'Domain'),

diff --git a/src/Model/RecordLocale.php b/src/Model/RecordLocale.php
@@ -40,7 +40,7 @@ class RecordLocale extends ViewableData
      * FluentLocale constructor.
      *
      * @param DataObject $record
-     * @param Locale     $locale
+     * @param Locale $locale
      */
     public function __construct(DataObject $record, Locale $locale)
     {
@@ -114,7 +114,18 @@ public function getLocale()
      */
     public function getLocaleRFC1766()
     {
-        return i18n::convert_rfc1766($this->getLocale());
+        return $this->getHrefLang();
+    }
+
+    /**
+     * Get hreflang field
+     *
+     * @return string
+     */
+    public function getHrefLang()
+    {
+        $locale = $this->getLocaleObject();
+        return $locale->getHrefLang();
     }
 
     /**

diff --git a/templates/FluentSiteTree_MetaTags.ss b/templates/FluentSiteTree_MetaTags.ss
@@ -1,3 +1,3 @@
 <% if $Locales %><% loop $Locales %><% if $IsPublished && $canViewInLocale %>
-	<link rel="alternate" hreflang="$LocaleRFC1766.ATT" href="$AbsoluteLink.ATT" />
+    <link rel="alternate" hreflang="$HrefLang.ATT" href="$AbsoluteLink.ATT" />
 <% end_if %><% end_loop %><% end_if %>
diff --git a/templates/LocaleMenu.ss b/templates/LocaleMenu.ss
@@ -1,13 +1,14 @@
 <% if $Locales %>
-<div class="left">Locale <span class="arrow">&rarr;</span>
-	<nav class="primary">
-		<ul>
-			<% loop $Locales %>
-				<li class="$LinkingMode">
-					<a href="$Link.ATT" <% if $LinkingMode != 'invalid' %>rel="alternate" hreflang="$LocaleRFC1766"<% end_if %>>$Title.XML</a>
-				</li>
-			<% end_loop %>
-		</ul>
-	</nav>
-</div>
+    <div class="left">Locale <span class="arrow">&rarr;</span>
+        <nav class="primary">
+            <ul>
+                <% loop $Locales %>
+                    <li class="$LinkingMode">
+                        <a href="$Link.ATT" <% if $LinkingMode != 'invalid' %>rel="alternate"
+                           hreflang="$HrefLang"<% end_if %>>$Title.XML</a>
+                    </li>
+                <% end_loop %>
+            </ul>
+        </nav>
+    </div>
 <% end_if %>
diff --git a/templates/Wilr/GoogleSitemaps/Control/GoogleSitemapController_sitemap.ss b/templates/Wilr/GoogleSitemaps/Control/GoogleSitemapController_sitemap.ss
@@ -1,17 +1,23 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <?xml-stylesheet type='text/xsl' href='{$BaseHref}sitemap.xml/styleSheet'?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9" xmlns:image="http://www.google.com/schemas/sitemap-image/1.1" xmlns:xhtml="http://www.w3.org/1999/xhtml">
-	<% loop $Items %>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"
+        xmlns:image="http://www.google.com/schemas/sitemap-image/1.1"
+        xmlns:xhtml="http://www.w3.org/1999/xhtml"
+>
+    <% loop $Items %>
         <url>
             <loc>$AbsoluteLink</loc>
-            <% if $LastEdited %><lastmod>$LastEdited.Rfc3339()</lastmod><% end_if %>
-            <% if $ChangeFrequency %><changefreq>$ChangeFrequency</changefreq><% end_if %>
-            <% if $GooglePriority %><priority>$GooglePriority</priority><% end_if %>
+            <% if $LastEdited %>
+                <lastmod>$LastEdited.Rfc3339()</lastmod><% end_if %>
+            <% if $ChangeFrequency %>
+                <changefreq>$ChangeFrequency</changefreq><% end_if %>
+            <% if $GooglePriority %>
+                <priority>$GooglePriority</priority><% end_if %>
             <% if $Locales %><% loop $Locales %><% if $LinkingMode != 'invalid' %>
-            <xhtml:link
-                rel="alternate"
-                hreflang="$LocaleRFC1766"
-                href="$AbsoluteLink"
+                <xhtml:link
+                        rel="alternate"
+                        hreflang="$HrefLang"
+                        href="$AbsoluteLink"
                 />
             <% end_if %><% end_loop %><% end_if %>
             <% if $ImagesForSitemap %><% loop $ImagesForSitemap %>
@@ -20,5 +26,5 @@
                 </image:image>
             <% end_loop %><% end_if %>
         </url>
-	<% end_loop %>
+    <% end_loop %>
 </urlset>
diff --git a/tests/php/Extension/FluentSiteTreeExtensionTest.php b/tests/php/Extension/FluentSiteTreeExtensionTest.php
@@ -66,6 +66,7 @@ public function testGetLocaleInformation()
             $this->assertInstanceOf(RecordLocale::class, $result);
             $this->assertEquals('en_NZ', $result->getLocale());
             $this->assertEquals('en-NZ', $result->getLocaleRFC1766());
+            $this->assertEquals('en-NZ', $result->getHrefLang());
             $this->assertEquals('English (New Zealand)', $result->getTitle());
             $this->assertEquals('English', $result->getLanguageNative());
             $this->assertEquals('en', $result->getLanguage());
@@ -154,7 +155,7 @@ public function provideURLTests()
      * @dataProvider provideURLTests
      * @param string $domain
      * @param string $locale
-     * @param bool   $prefixDisabled
+     * @param bool $prefixDisabled
      * @param string $pageName
      * @param string $url
      */