From ce8d8af09256cea85132b83b225791dc5e98a23e Mon Sep 17 00:00:00 2001 From: Nikita Hovratov Date: Fri, 16 Aug 2024 19:20:06 +0200 Subject: [PATCH] [!!!][TASK] Replace custom TranslateViewHelper with LanguagePathViewHelper --- .../card_group/Source/EditorPreview.html | 2 +- .../card_group/Source/Frontend.html | 2 +- Classes/ViewHelpers/AssetPathViewHelper.php | 10 ++ .../ViewHelpers/LanguagePathViewHelper.php | 60 ++++++++++ Classes/ViewHelpers/TranslateViewHelper.php | 111 ------------------ Documentation/Templating/Index.rst | 7 +- .../simple-with-basics/Source/Frontend.html | 2 +- .../simple/Source/Frontend.html | 2 +- .../simple2/Source/Frontend.html | 4 +- ...est.php => LanguagePathViewHelperTest.php} | 47 ++------ 10 files changed, 92 insertions(+), 155 deletions(-) create mode 100644 Classes/ViewHelpers/LanguagePathViewHelper.php delete mode 100644 Classes/ViewHelpers/TranslateViewHelper.php rename Tests/Functional/ViewHelpers/{TranslateViewHelperTest.php => LanguagePathViewHelperTest.php} (57%) diff --git a/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/EditorPreview.html b/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/EditorPreview.html index 6395732c..26d719e8 100644 --- a/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/EditorPreview.html +++ b/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/EditorPreview.html @@ -32,7 +32,7 @@

{item.link_title} - +
diff --git a/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/Frontend.html b/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/Frontend.html index 822a8283..d06ef62a 100644 --- a/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/Frontend.html +++ b/Build/content-blocks-examples/ContentBlocks/ContentElements/card_group/Source/Frontend.html @@ -34,7 +34,7 @@

{item.link_title} - +
diff --git a/Classes/ViewHelpers/AssetPathViewHelper.php b/Classes/ViewHelpers/AssetPathViewHelper.php index 0cd6163c..aae73b17 100644 --- a/Classes/ViewHelpers/AssetPathViewHelper.php +++ b/Classes/ViewHelpers/AssetPathViewHelper.php @@ -25,6 +25,16 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic; use TYPO3Fluid\Fluid\Exception; +/** + * AssetPathViewHelper + * + * ONLY TO BE USED INSIDE CONTENT BLOCKS + * + * Examples + * ======== + * + * + */ class AssetPathViewHelper extends AbstractViewHelper { use CompileWithRenderStatic; diff --git a/Classes/ViewHelpers/LanguagePathViewHelper.php b/Classes/ViewHelpers/LanguagePathViewHelper.php new file mode 100644 index 00000000..708440d3 --- /dev/null +++ b/Classes/ViewHelpers/LanguagePathViewHelper.php @@ -0,0 +1,60 @@ + + */ +class LanguagePathViewHelper extends AbstractViewHelper +{ + use CompileWithRenderStatic; + + public function initializeArguments(): void + { + $this->registerArgument('name', 'string', 'The vendor/package of the Content Block.'); + } + + public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext): string + { + $name = (string)($arguments['name'] ?? $renderingContext->getVariableProvider()->get('data._name')); + if ($name === '') { + throw new Exception(__CLASS__ . ' seemingly called outside Content Blocks context.', 1699271759); + } + $contentBlockRegistry = GeneralUtility::makeInstance(ContentBlockRegistry::class); + if (!$contentBlockRegistry->hasContentBlock($name)) { + throw new Exception('Content block with the name "' . $name . '" is not registered.', 1699272189); + } + $languagePath = 'LLL:' . $contentBlockRegistry->getContentBlockExtPath($name) . '/' . ContentBlockPathUtility::getLanguageFilePath(); + return $languagePath; + } +} diff --git a/Classes/ViewHelpers/TranslateViewHelper.php b/Classes/ViewHelpers/TranslateViewHelper.php deleted file mode 100644 index c1704994..00000000 --- a/Classes/ViewHelpers/TranslateViewHelper.php +++ /dev/null @@ -1,111 +0,0 @@ - - */ -class TranslateViewHelper extends AbstractViewHelper -{ - use CompileWithRenderStatic; - - public function initializeArguments(): void - { - parent::initializeArguments(); - $this->registerArgument('key', 'string', 'The key of the label to use.', true); - $this->registerArgument('name', 'string', 'The vendor/package of the Content Block.'); - $this->registerArgument('default', 'string', 'If the given locallang key could not be found, this value is used. If this argument is not set, child nodes will be used to render the default'); - $this->registerArgument('arguments', 'array', 'Arguments to be replaced in the resulting string'); - $this->registerArgument('languageKey', 'string', 'Language key ("da" for example) or "default" to use. If empty, use current language.'); - } - - public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext): string - { - $name = (string)($arguments['name'] ?? $renderingContext->getVariableProvider()->get('data._name')); - if ($name === '') { - throw new Exception(__CLASS__ . ' seemingly called outside Content Blocks context.', 1699271759); - } - - $key = (string)$arguments['key']; - if ($key === '') { - throw new Exception('Value for "key" must not be empty.', 1699271873); - } - - $default = (string)($arguments['default'] ?? $renderChildrenClosure() ?? ''); - $translateArguments = $arguments['arguments']; - - $contentBlockRegistry = GeneralUtility::makeInstance(ContentBlockRegistry::class); - if (!$contentBlockRegistry->hasContentBlock($name)) { - throw new Exception('Content block with the name "' . $name . '" is not registered.', 1699272189); - } - $languagePath = 'LLL:' . $contentBlockRegistry->getContentBlockExtPath($name) . '/' . ContentBlockPathUtility::getLanguageFilePath() . ':' . $key; - - $request = null; - if ($renderingContext instanceof RenderingContext) { - $request = $renderingContext->getRequest(); - } - $languageService = self::getLanguageService($request, $arguments['languageKey']); - $value = $languageService->sL($languagePath); - if ($value === '') { - $value = self::handleDefaultValue($default, $translateArguments); - } - return $value; - } - - protected static function handleDefaultValue(string $default, ?array $translateArguments): string - { - if (!empty($translateArguments)) { - return vsprintf($default, $translateArguments); - } - return $default; - } - - protected static function getLanguageService(ServerRequestInterface $request = null, string|Locale $languageKey = null): LanguageService - { - $languageServiceFactory = GeneralUtility::makeInstance(LanguageServiceFactory::class); - if ($languageKey) { - return $languageServiceFactory->create($languageKey); - } - if ($request !== null && ApplicationType::fromRequest($request)->isFrontend()) { - return $languageServiceFactory->createFromSiteLanguage($request->getAttribute('language') - ?? $request->getAttribute('site')->getDefaultLanguage()); - } - return $languageServiceFactory->createFromUserPreferences($GLOBALS['BE_USER'] ?? null); - } -} diff --git a/Documentation/Templating/Index.rst b/Documentation/Templating/Index.rst index 336228f4..04de5527 100644 --- a/Documentation/Templating/Index.rst +++ b/Documentation/Templating/Index.rst @@ -144,11 +144,12 @@ means if you use an asset ViewHelper in a partial, you have to provide Translation ViewHelper ====================== -This ViewHelper looks directly in the `Labels.xlf` file for the given key. +Content Blocks provides a LanguagePathViewHelper to retrieve the LLL-path for +the Labels.xlf file of the current Content Block. .. code-block:: html - + As described above in the asset ViewHelper, the :html:`{data}` variable is required to resolve the Content Block automatically. You can also set @@ -156,7 +157,7 @@ required to resolve the Content Block automatically. You can also set .. code-block:: html - + Partials ======== diff --git a/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple-with-basics/Source/Frontend.html b/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple-with-basics/Source/Frontend.html index a9e3a16d..2aac8856 100644 --- a/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple-with-basics/Source/Frontend.html +++ b/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple-with-basics/Source/Frontend.html @@ -9,4 +9,4 @@

{data.header}

{data.bodytext}

- + diff --git a/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple/Source/Frontend.html b/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple/Source/Frontend.html index 2679f169..9fba2b5d 100644 --- a/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple/Source/Frontend.html +++ b/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple/Source/Frontend.html @@ -17,6 +17,6 @@

{data.header}

tableName:{data.mainType}

creationDate:{data.systemProperties.createdAt.timestamp}

updateDate:{data.systemProperties.lastUpdatedAt.timestamp}

- + diff --git a/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple2/Source/Frontend.html b/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple2/Source/Frontend.html index d3b8852e..2aac8856 100644 --- a/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple2/Source/Frontend.html +++ b/Tests/Fixtures/Extensions/test_content_blocks_c/ContentBlocks/ContentElements/simple2/Source/Frontend.html @@ -5,8 +5,8 @@ > - +

{data.header}

{data.bodytext}

- + diff --git a/Tests/Functional/ViewHelpers/TranslateViewHelperTest.php b/Tests/Functional/ViewHelpers/LanguagePathViewHelperTest.php similarity index 57% rename from Tests/Functional/ViewHelpers/TranslateViewHelperTest.php rename to Tests/Functional/ViewHelpers/LanguagePathViewHelperTest.php index fac41c62..f62bc5cb 100644 --- a/Tests/Functional/ViewHelpers/TranslateViewHelperTest.php +++ b/Tests/Functional/ViewHelpers/LanguagePathViewHelperTest.php @@ -26,7 +26,7 @@ use TYPO3Fluid\Fluid\Exception; use TYPO3Fluid\Fluid\View\TemplateView; -final class TranslateViewHelperTest extends FunctionalTestCase +final class LanguagePathViewHelperTest extends FunctionalTestCase { protected bool $initializeDatabase = false; @@ -38,25 +38,13 @@ final class TranslateViewHelperTest extends FunctionalTestCase public static function renderReturnsStringDataProvider(): array { return [ - 'fallback to default attribute for not existing label' => [ - '', - 'myDefault', + 'name explicitly set' => [ + '', + 'LLL:EXT:test_content_blocks_b/ContentBlocks/ContentElements/content-element-b/Source/Language/Labels.xlf', ], - 'fallback to default attribute for static label' => [ - '', - 'myDefault', - ], - 'fallback to child for not existing label' => [ - 'myDefault', - 'myDefault', - ], - 'fallback to child for static label' => [ - 'myDefault', - 'myDefault', - ], - 'key and name given' => [ - '', - 'Content Block title', + 'fallback to name from context' => [ + '', + 'LLL:EXT:test_content_blocks_b/ContentBlocks/ContentElements/content-element-b/Source/Language/Labels.xlf', ], ]; } @@ -68,7 +56,9 @@ public function renderReturnsString(string $template, string $expected): void $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->create('default'); $context = $this->get(RenderingContextFactory::class)->create(); $context->getTemplatePaths()->setTemplateSource($template); - self::assertSame($expected, (new TemplateView($context))->render()); + $view = new TemplateView($context); + $view->assign('data', ['_name' => 'typo3tests/content-element-b']); + self::assertSame($expected, $view->render()); } #[Test] @@ -76,7 +66,7 @@ public function invalidContentBlockThrowsFluidException(): void { $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->create('default'); $context = $this->get(RenderingContextFactory::class)->create(); - $context->getTemplatePaths()->setTemplateSource(''); + $context->getTemplatePaths()->setTemplateSource(''); $this->expectException(Exception::class); $this->expectExceptionCode(1699272189); @@ -89,24 +79,11 @@ public function missingNameThrowsFluidException(): void { $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->create('default'); $context = $this->get(RenderingContextFactory::class)->create(); - $context->getTemplatePaths()->setTemplateSource(''); + $context->getTemplatePaths()->setTemplateSource(''); $this->expectException(Exception::class); $this->expectExceptionCode(1699271759); (new TemplateView($context))->render(); } - - #[Test] - public function emptyKeyThrowsFluidException(): void - { - $GLOBALS['LANG'] = GeneralUtility::makeInstance(LanguageServiceFactory::class)->create('default'); - $context = $this->get(RenderingContextFactory::class)->create(); - $context->getTemplatePaths()->setTemplateSource(''); - - $this->expectException(Exception::class); - $this->expectExceptionCode(1699271873); - - (new TemplateView($context))->render(); - } }