web-vision / deepl-base
TYPO3 Extension providing shared things across deepl related extensions, for example a shared point when overriding same TYPO3 backend fluid files are required and similar.
Installs: 107
Dependents: 2
Suggesters: 0
Security: 0
Stars: 0
Watchers: 5
Forks: 0
Open Issues: 0
Type:typo3-cms-extension
Requires
- php: ^8.1 || ^8.2 || ^8.3 || ^8.4
- ext-curl: *
- ext-json: *
- ext-pdo: *
- typo3/cms-backend: ^12.4.2 || ^13.4
- typo3/cms-core: ^12.4.2 || ^13.4
- typo3/cms-fluid: ^12.4.2 || ^13.4
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.41
- helmich/phpunit-json-assert: ^3.4.3 || ^3.5.1
- helmich/typo3-typoscript-lint: ^3.1.0
- nikic/php-parser: ^4.15.1 || ^5.1.0
- php-mock/php-mock-phpunit: ^2.6
- phpstan/phpstan: ^1.10
- phpunit/phpunit: ^10.5
- ramsey/uuid: ^4.2
- saschaegerer/phpstan-typo3: ^1.9
- sbuerk/typo3-site-based-test-trait: ^1.0.2 || ^2.0.1
- sbuerk/typo3-styleguide-selector: ^12.0.5 || ^13.4
- typo3/cms-belog: ^12.4.2 || ^13.4
- typo3/cms-dashboard: ^12.4.2 || ^13.4
- typo3/cms-extbase: ^12.4.2 || ^13.4
- typo3/cms-extensionmanager: ^12.4.2 || ^13.4
- typo3/cms-filelist: ^12.4.2 || ^13.4
- typo3/cms-fluid-styled-content: ^12.4.2 || ^13.4
- typo3/cms-frontend: ^12.4.2 || ^13.4
- typo3/cms-info: ^12.4.2 || ^13.4
- typo3/cms-install: ^12.4.2 || ^13.4
- typo3/cms-lowlevel: ^12.4.2 || ^13.4
- typo3/cms-rte-ckeditor: ^12.4.2 || ^13.4
- typo3/cms-styleguide: ^12.0.5 || ^13.4
- typo3/cms-tstemplate: ^12.4.2 || ^13.4
- typo3/cms-workspaces: ^12.4.2 || ^13.4
- typo3/testing-framework: ^8.2.7
This package is auto-updated.
Last update: 2025-06-10 17:48:23 UTC
README
| URL | |
|---|---|
| Repository: | https://github.com/web-vision/deepl-base |
| Read online: | https://docs.typo3.org/p/web-vision/deepl-base/main/en-us/ |
| TER: | https://extensions.typo3.org/extension/deepl_base/ |
Description
This package is a TYPO Extension providing some shared things required by multiple deepl translate or write related extensions, which should work together but must work independent of each other, requiring this shared base extension as common ground.
Note
This extension does not provide anything useful as direct usage, and makes no sense to install it standalone. Should only be a dependency for other extensions.
Compatibility
| Branch | Version | TYPO3 | PHP |
|---|---|---|---|
| main | 1.0.x-dev | v12 + v13 | 8.1, 8.2, 8.3, 8.4 (depending on TYPO3) |
| 1 | ^1 | v12 + v13 | 8.1, 8.2, 8.3, 8.4 (depending on TYPO3) |
Installation
Install with your flavour:
- TER
- Extension Manager
- composer
We prefer composer installation:
composer require 'web-vision/deepl-base':'1.*.*@dev'
Note
Until first release you may need to ensure allowing dev versions but preferring stable releases which requires:
composer config minimum-stability "dev" \ && composer config "prefer-stable" true
Documentation
Note
For the start, the documentation for developers and integrators is contained here in the README.md file and will be converted into rendered documentation at a later point.
PageLayout module localization model - Translation Modes
ViewHelper
InjectVariablesViewHelper
InjectVariablesViewHelper can be placed in fluid templates and
requires to define a speaking identifier used to dispatch the PSR-14
ModifyInjectVariablesViewHelperEvent event, which can be used to
set or modify variables either in the global current template scope
or for children rendering scope.
Example usage in fluid template
<html data-namespace-typo3-fluid="true" xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers" xmlns:deeplbase="http://typo3.org/ns/WebVision/Deepl/Base/ViewHelpers" > <deeplbase:injectVariables identifier="custom-template-variable-inject"> Render {globalOrLocalVariableProviderVariable} only available in children context. </deeplbase:injectVariables> Render {globalOnlyVariableProviderVariable} only ignoring local variable provider changes. </html>
Explicit usage from this extension
<html data-namespace-typo3-fluid="true" xmlns:f="http://typo3.org/ns/TYPO3/CMS/Fluid/ViewHelpers" xmlns:deeplbase="http://typo3.org/ns/WebVision/Deepl/Base/ViewHelpers" > <deeplbase:injectVariables identifier="languageTranslationDropdown"> <f:for each="{translationPartials}" as="translationPartial"> <f:render partial="{translationPartial}" arguments="{_all}"/> </f:for> </deeplbase:injectVariables> </html>
What does it do?
This part renders partials registered by an EventListener. With this identifier an extension could provide its own translation dropdown for the Backend PageView. The extension must be self-aware registering a partial, which is callable by Fluid.
A working example is provided at Classes/EventListener/DefaultTranslationDropdownEventListener.php
and Resources/Private/Backend/Partials/Translation/DefaultTranslationDropdown.html.
ModifyInjectVariablesViewHelperEvent
getIdentifier(): string: identifier used within the fluid template and shouldgetGlobalVariableProvider(): VariableProviderInterface: provides the fluid variable container of the current context. Modification will be available after the ViewHelper and within the children context unless overridden within thegetLocalVariableProvider.getLocalVariableProvider(): VariableProviderInterface: provides the fluid variable container with children context only variables, overriding global variables. Local variable does not change the variables in the template after the ViewHelper call.
Modified Backend Templates
Note
Modifed backend templates are listed here describing the modification, for example, if one or more InjectVariableViewhelper has been placed along with the identifier and use-case.