[BUGFIX] Allow setting of default language (#15)

* [BUGFIX] Allow setting of default language Releases: master, 10, 9 * [BUGFIX] Improve wording in manual Co-authored-by: Andreas Fernandez <andreas.fernandez@typo3.com>
TYPO3GmbH · Aug 6, 2020 · 6e526ba · 6e526ba
1 parent fb1b095
commit 6e526ba
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 3 deletions.
diff --git a/Classes/Hooks/PageRendererPreProcess.php b/Classes/Hooks/PageRendererPreProcess.php
@@ -38,7 +38,7 @@ public function addLibrary(): void
         if (!$this->isValidId($config)) {
             throw new \InvalidArgumentException('Usercentrics ID not configured, please set plugin.tx_usercentrics.settingsId in your TypoScript configuration', 1583774571);
         }
-        $this->addUsercentricsScript($config['settingsId']);
+        $this->addUsercentricsScript($config);
         $this->addConfiguredJsFiles($config['jsFiles.'] ?? []);
         $this->addConfiguredInlineJavaScript($config['jsInline.'] ?? []);
     }
@@ -75,11 +75,12 @@ protected function addConfiguredJsFiles(array $jsFiles): void
         }
     }
 
-    protected function addUsercentricsScript(string $settingsId): void
+    protected function addUsercentricsScript(array $config): void
     {
         $this->assetCollector->addJavaScript('usercentrics', 'https://app.usercentrics.eu/latest/main.js', [
             'type' => 'application/javascript',
-            'id' => $settingsId
+            'id' => $config['settingsId'],
+            'language' => $config['language'],
         ]);
     }
 

diff --git a/Configuration/TypoScript/Static/constants.typoscript b/Configuration/TypoScript/Static/constants.typoscript
@@ -4,5 +4,7 @@ plugin {
     tx_usercentrics {
         # cat=usercentrics; type=string; label=Usercentrics ID
         settingsId =
+        # cat=usercentrics; type=string; label=language iso code
+        language = en
     }
 }
diff --git a/Configuration/TypoScript/Static/setup.typoscript b/Configuration/TypoScript/Static/setup.typoscript
@@ -1,4 +1,5 @@
 plugin.tx_usercentrics {
     id = {$plugin.tx_usercentrics.settingsId}
+    language = {$plugin.tx_usercentrics.language}
 }
 
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -32,3 +32,16 @@ In TypoScript, set the constant as follows:
 
    plugin.tx_usercentrics.settingsId = XXXXXXXX
 
+
+Configure The Usercentrics Default language
+===========================================
+
+The extension ships a TypoScript constant that allows to set the default language to be used.
+The language must be enabled in the Usercentrics account settings and provided as ISO 639-1 code.
+
+In TypoScript, set the constant as follows:
+
+.. code-block:: typoscript
+
+   plugin.tx_usercentrics.language = en
+
diff --git a/Tests/Unit/PageRendererPreProcessTest.php b/Tests/Unit/PageRendererPreProcessTest.php
@@ -63,6 +63,7 @@ public function addLibraryAddsMainUsercentricsScript(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                 ],
             ],
         ];
@@ -73,6 +74,7 @@ public function addLibraryAddsMainUsercentricsScript(): void
         $this->assetCollector->addJavaScript('usercentrics', 'https://app.usercentrics.eu/latest/main.js', [
             'type' => 'application/javascript',
             'id' => 'myUsercentricsId',
+            'language' => 'en',
         ])->shouldHaveBeenCalled();
     }
 
@@ -85,6 +87,7 @@ public function addLibraryThrowsExceptionIfNoIdentifierGivenForFile(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                     'jsFiles.' => [
                         '10.' => [
                             'file' => 'EXT:site/Resources/Public/JavaScript/test.js',
@@ -109,6 +112,7 @@ public function addLibraryThrowsExceptionIfNoFileGiven(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                     'jsFiles.' => [
                         '10.' => [
                         ],
@@ -134,6 +138,7 @@ public function addLibraryAddsConfiguredFileWithAttributes(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                     'jsFiles.' => [
                         '10.' => [
                             'file' => $file,
@@ -169,6 +174,7 @@ public function addLibraryAddsConfiguredFileWithAttributesAndOptions(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                     'jsFiles.' => [
                         '10.' => [
                             'file' => $file,
@@ -208,6 +214,7 @@ public function addLibraryThrowsExceptionIfNoIdentifierGivenForInlineJs(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                     'jsInline.' => [
                         '10.' => [
                             'value' => 'alert(123);',
@@ -234,6 +241,7 @@ public function addLibraryAddsInlineJsWithAttributesAndOptions(): void
             'plugin.' => [
                 'tx_usercentrics.' => [
                     'settingsId' => 'myUsercentricsId',
+                    'language' => 'en',
                     'jsInline.' => [
                         '10.' => [
                             'value' => $value,