Add helper function to get the supported locales excluding mappings

Author: Erik van Velzen

src/SlmLocale/Locale/Detector.php

@@ -67,14 +67,14 @@ class Detector implements EventManagerAwareInterface
     /**
      * Optional list of supported locales
      *
-     * @var array
+     * @var string[]
      */
     protected $supported;
 
     /**
      * Optional list of locale mappings
      *
-     * @var array
+     * @var array & string[string]
      */
     protected $mappings;
 
@@ -128,6 +128,21 @@ public function hasSupported()
         return is_array($this->supported) && count($this->supported);
     }
 
+    /**
+     * get the supported locales excluding those which are mapped to another locale
+     *
+     * @return string[]
+     */
+    public function getMainSupportedLocales()
+    {
+        $supported = $this->getSupported() ?: [];
+        $mappings = $this->getMappings() ?: [];
+
+        $mappedFrom = array_keys($mappings);
+
+        return array_values(array_diff($supported, $mappedFrom));
+    }
+
     public function getMappings()
     {
         return $this->mappings;

tests/SlmLocaleTest/Locale/DetectorTest.php

@@ -199,6 +199,32 @@ public function testEmptyMappingsListIndicatesNoMappingsList()
         $this->assertFalse($detector->hasMappings());
     }
 
+    public function testMainSupportedLocalesExcludesMappings()
+    {
+        $detector = new Detector();
+        $detector->setSupported([
+            'nl',
+            'nl_NL',
+        ]);
+
+        $detector->setMappings([
+            'nl' => 'nl_NL',
+        ]);
+
+        $this->assertEquals(['nl_NL'], $detector->getMainSupportedLocales());
+    }
+
+    public function testMainSupportedLocalesWithoutMappings()
+    {
+        $detector = new Detector();
+        $detector->setSupported([
+            'nl',
+            'nl_NL',
+        ]);
+
+        $this->assertEquals(['nl', 'nl_NL'], $detector->getMainSupportedLocales());
+    }
+
     public function testStrategyAttachesToEventManager()
     {
         $detector = new Detector();