Merge pull request #18 from nthmedia/v2

Add fallback option to link to homepage if target entry does not exist

CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.2.0 - 2020-05-19
+
+### Added
+- Added fallback link to homepage when entry is not found on target site
+
 ## 2.1.0 - 2019-04-20
 
 ### Added

README.md

@@ -95,7 +95,7 @@ If you want to dynamically loop through each of your sites, try this instead:
 
 ### Checking whether a translated element exists
 
-Lastly, you can check to make sure that a translated version of that element exists before showing the link:
+You can check to make sure that a translated version of that element exists before showing the link:
 
 ```twig
 {% set element = (category ?? entry ?? null) %}
@@ -110,6 +110,21 @@ Lastly, you can check to make sure that a translated version of that element exi
 </ul>
 ```
 
+### Checking whether a translated element exists
+
+Lastly, you can add a fallback to show a link to the homepage of the target site if the entry does not exist on the target site by setting the third parameter to true:
+
+```twig
+{% set element = (category ?? entry ?? null) %}
+
+<ul>
+    <li><a href="{{ siteSwitcher('english', element, true) }}">English</a></li>
+    <li><a href="{{ siteSwitcher('spanish', element, true) }}">Español</a></li>
+    <li><a href="{{ siteSwitcher('french', element, true) }}">Français</a></li>
+    <li><a href="{{ siteSwitcher('german', element, true) }}">Deutsch</a></li>
+</ul>
+```
+
 ***
 
 ## Anything else?

composer.json

@@ -2,7 +2,7 @@
     "name": "doublesecretagency/craft-siteswitcher",
     "description": "Easily switch between sites on any page of your website.",
     "type": "craft-plugin",
-    "version": "2.1.0",
+    "version": "2.2.0",
     "keywords": [
         "craft",
         "cms",

src/services/SiteSwitcherService.php

@@ -31,12 +31,13 @@ class SiteSwitcherService extends Component
      *
      * @param string|null $siteHandle
      * @param Element|null $element
+     * @param bool $fallbackToHomepage
      * @return bool|string
      * @throws Exception
      * @throws InvalidConfigException
      * @throws SiteNotFoundException
      */
-    public function url($siteHandle = null, Element $element = null)
+    public function url($siteHandle = null, Element $element = null, bool $fallbackToHomepage = false)
     {
         // If no site handle specified, use the default site
         if (!$siteHandle) {
@@ -60,6 +61,11 @@ public function url($siteHandle = null, Element $element = null)
             $siteLink .= "?{$queryString}";
         }
 
+        // If not element is found on the target site, fallback to homepage
+        if ($siteLink === false && $fallbackToHomepage === true) {
+            $siteLink = Craft::$app->getSites()->getSiteByHandle($siteHandle)->getBaseUrl();
+        }
+
         // Return site link
         return $siteLink;
     }

src/twigextensions/SiteSwitcherTwigExtension.php

@@ -49,11 +49,12 @@ public function getFunctions(): array
      *
      * @param $siteHandle
      * @param null $element
+     * @param bool $fallbackToHomepage
      * @return mixed
      */
-    public function siteSwitcher($siteHandle, $element = null)
+    public function siteSwitcher($siteHandle, $element = null, $fallbackToHomepage = false)
     {
-        return SiteSwitcher::$plugin->siteSwitcher->url($siteHandle, $element);
+        return SiteSwitcher::$plugin->siteSwitcher->url($siteHandle, $element, $fallbackToHomepage);
     }
 
     /**