added a view-helper to get the primary-language

kokspflanze · svycka · commit 81fa578acb92 · 2019-03-26T08:59:56.000+02:00
diff --git a/README.md b/README.md
@@ -110,7 +110,7 @@ in the `html` tag:
 Inject the detected language here with the following code:
 
 ```
-<html lang="<?= Locale::getPrimaryLanguage(Locale::getDefault())?>">
+<html lang="<?= $this->primaryLanguage()?>">
 ```
 
 ### Disable UriPathStrategy in PHPUNIT
diff --git a/config/module.config.php b/config/module.config.php
@@ -1,13 +1,10 @@
 <?php
 
 use SlmLocale\Locale\Detector;
-use SlmLocale\Service\DetectorFactory;
-use SlmLocale\Service\LocaleMenuViewHelperFactory;
-use SlmLocale\Service\LocaleUrlViewHelperFactory;
+use SlmLocale\Service;
 use SlmLocale\Strategy\Factory\StrategyPluginManagerFactory;
 use SlmLocale\Strategy\StrategyPluginManager;
-use SlmLocale\View\Helper\LocaleMenu;
-use SlmLocale\View\Helper\LocaleUrl;
+use SlmLocale\View\Helper;
 
 /**
  * Copyright (c) 2012-2013 Jurian Sluiman.
@@ -56,18 +53,20 @@
     'service_manager' => [
         'factories'  => [
             StrategyPluginManager::class => StrategyPluginManagerFactory::class,
-            Detector::class              => DetectorFactory::class,
+            Detector::class              => Service\DetectorFactory::class,
         ],
     ],
 
     'view_helpers' => [
         'aliases' => [
-            'localeUrl'  => LocaleUrl::class,
-            'localeMenu' => LocaleMenu::class,
+            'localeUrl'       => Helper\LocaleUrl::class,
+            'localeMenu'      => Helper\LocaleMenu::class,
+            'primaryLanguage' => Helper\PrimaryLanguage::class,
         ],
         'factories' => [
-            LocaleUrl::class  => LocaleUrlViewHelperFactory::class,
-            LocaleMenu::class => LocaleMenuViewHelperFactory::class,
+            Helper\LocaleUrl::class       => Service\LocaleUrlViewHelperFactory::class,
+            Helper\LocaleMenu::class      => Service\LocaleMenuViewHelperFactory::class,
+            Helper\PrimaryLanguage::class => Service\PrimaryLanguageHelperFactory::class,
         ],
     ],
 ];
diff --git a/src/SlmLocale/Service/PrimaryLanguageHelperFactory.php b/src/SlmLocale/Service/PrimaryLanguageHelperFactory.php
@@ -0,0 +1,59 @@
+<?php
+/**
+ * Copyright (c) 2012-2019 Jurian Sluiman.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *   * Neither the names of the copyright holders nor the names of the
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * @author      Jurian Sluiman <jurian@juriansluiman.nl>
+ * @copyright   2012-2013 Jurian Sluiman.
+ * @license     http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @link        http://juriansluiman.nl
+ */
+namespace SlmLocale\Service;
+
+use Interop\Container\ContainerInterface;
+use Locale;
+use SlmLocale\View\Helper\PrimaryLanguage;
+use Zend\ServiceManager\Factory\FactoryInterface;
+
+final class PrimaryLanguageHelperFactory implements FactoryInterface
+{
+    /**
+     * @param ContainerInterface $container
+     * @param string $requestedName
+     * @param array|null $options
+     * @return object|PrimaryLanguage
+     */
+    public function __invoke(ContainerInterface $container, $requestedName, array $options = null)
+    {
+        return new PrimaryLanguage(new Locale());
+    }
+}
diff --git a/src/SlmLocale/View/Helper/PrimaryLanguage.php b/src/SlmLocale/View/Helper/PrimaryLanguage.php
@@ -0,0 +1,66 @@
+<?php
+/**
+ * Copyright (c) 2012-2019 Jurian Sluiman.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *   * Neither the names of the copyright holders nor the names of the
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * @author      Jurian Sluiman <jurian@juriansluiman.nl>
+ * @copyright   2012-2013 Jurian Sluiman.
+ * @license     http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @link        http://juriansluiman.nl
+ */
+namespace SlmLocale\View\Helper;
+
+use Locale;
+use Zend\View\Helper\AbstractHelper;
+
+final class PrimaryLanguage extends AbstractHelper
+{
+    /** @var Locale */
+    protected $locale;
+
+    /**
+     * PrimaryLanguage constructor.
+     * @param Locale $locale
+     */
+    public function __construct(Locale $locale)
+    {
+        $this->locale = $locale;
+    }
+
+    /**
+     * @return string
+     */
+    public function __invoke()
+    {
+        return $this->locale->getPrimaryLanguage($this->locale->getDefault());
+    }
+}
diff --git a/tests/SlmLocaleTest/View/Helper/PrimaryLanguageTest.php b/tests/SlmLocaleTest/View/Helper/PrimaryLanguageTest.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright (c) 2012-2019 Jurian Sluiman.
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ *   * Redistributions of source code must retain the above copyright
+ *     notice, this list of conditions and the following disclaimer.
+ *
+ *   * Redistributions in binary form must reproduce the above copyright
+ *     notice, this list of conditions and the following disclaimer in
+ *     the documentation and/or other materials provided with the
+ *     distribution.
+ *
+ *   * Neither the names of the copyright holders nor the names of the
+ *     contributors may be used to endorse or promote products derived
+ *     from this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
+ * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
+ * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+ * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
+ * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * @author      Jurian Sluiman <jurian@juriansluiman.nl>
+ * @copyright   2012-2013 Jurian Sluiman.
+ * @license     http://www.opensource.org/licenses/bsd-license.php  BSD License
+ * @link        http://juriansluiman.nl
+ */
+namespace SlmLocaleTest\View\Helper;
+
+use Locale;
+use PHPUnit_Framework_TestCase as TestCase;
+use SlmLocale\View\Helper\PrimaryLanguage;
+
+final class PrimaryLanguageTest extends TestCase
+{
+    public function testInvoke()
+    {
+        $locale = new Locale();
+        $locale->setDefault('de-DE');
+        $primaryLanguage = new PrimaryLanguage($locale);
+
+        $this->assertSame('de', $primaryLanguage());
+    }
+}
