-
Notifications
You must be signed in to change notification settings - Fork 81
IBX-10684: Document translation management #3249
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
dabrt
wants to merge
7
commits into
5.0
Choose a base branch
from
translations-management
base: 5.0
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f0df726
IBX-10684: Document translation management
dabrt 2aec539
Add events and extensions
dabrt bffca77
PHP & JS CS Fixes
dabrt 6f128e0
Fix formatting in events
dabrt 07583df
Add "Configure..." stem to enable building
dabrt 9a00463
Implement reviewer comments
dabrt 1196977
PHP & JS CS Fixes
dabrt File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| services: | ||
| App\TranslationsManagement\MyCustomProvider: | ||
| tags: | ||
| - name: 'ibexa.translations_management.auto_translate.provider' | ||
| identifier: 'my_custom_provider' | ||
| validation_profile: 'ai_generic' | ||
| App\TranslationsManagement\MyProviderValidator: | ||
| tags: | ||
| - name: 'ibexa.translations_management.auto_translate.provider.validator' | ||
| profile: 'my_custom_profile' | ||
| App\TranslationsManagement\MyTranslationAddExtension: | ||
| tags: | ||
| - { name: form.type_extension } | ||
| App\TranslationsManagement\ImageAltTextTransformer: | ||
| tags: | ||
| - name: 'ibexa.translations_management.auto_translate.field_value_transformer' | ||
| field_type_identifier: 'ibexa_image' | ||
| App\TranslationsManagement\MyCustomExclusionRule: | ||
| tags: | ||
| - { name: 'ibexa.translations_management.side_by_side.exclusion_rule' } | ||
| app.translations_management.exclusion_rule.custom_field_types: | ||
| class: Ibexa\TranslationsManagement\SideBySide\Service\UnsupportedFieldTypeExclusionRule | ||
| arguments: | ||
| $excludedFieldTypeIdentifiers: ['custom_blog_post', 'custom_landing_page'] | ||
| tags: | ||
| - { name: 'ibexa.translations_management.side_by_side.exclusion_rule' } | ||
| App\TranslationsManagement\TwigComponent\MyTranslationModalFooter: | ||
| tags: | ||
| - name: ibexa.twig.component | ||
| group: 'admin-ui-content-translation-modal-footer' | ||
| priority: 10 |
39 changes: 39 additions & 0 deletions
39
...es/translations_management/src/TranslationsManagement/ContentProxyTranslateSubscriber.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <?php declare(strict_types=1); | ||
|
|
||
| namespace App\TranslationsManagement\EventSubscriber; | ||
|
|
||
| use Ibexa\Contracts\AdminUi\Event\ContentProxyTranslateEvent; | ||
| use Symfony\Component\EventDispatcher\EventSubscriberInterface; | ||
| use Symfony\Component\HttpFoundation\RedirectResponse; | ||
| use Symfony\Component\Routing\Generator\UrlGeneratorInterface; | ||
|
|
||
| final readonly class ContentProxyTranslateSubscriber implements EventSubscriberInterface | ||
| { | ||
| public function __construct( | ||
| private UrlGeneratorInterface $urlGenerator, | ||
| ) { | ||
| } | ||
|
|
||
| public static function getSubscribedEvents(): array | ||
| { | ||
| return [ | ||
| ContentProxyTranslateEvent::class => ['onProxyTranslate', 200], | ||
| ]; | ||
| } | ||
|
|
||
| public function onProxyTranslate(ContentProxyTranslateEvent $event): void | ||
| { | ||
| // Read the translation context: | ||
| $event->getContentId(); | ||
| $event->getFromLanguageCode(); // ?string — null when no source language exists | ||
| $event->getToLanguageCode(); | ||
| $event->getLocationId(); // ?int — null when no location context is available | ||
|
|
||
| $url = $this->urlGenerator->generate('your_custom_route', [ | ||
| 'contentId' => $event->getContentId(), | ||
| ]); | ||
|
|
||
| $event->setResponse(new RedirectResponse($url)); | ||
| $event->stopPropagation(); | ||
| } | ||
| } |
33 changes: 33 additions & 0 deletions
33
code_samples/translations_management/src/TranslationsManagement/ImageAltTextTransformer.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace App\TranslationsManagement; | ||
|
|
||
| use Ibexa\Contracts\Core\Repository\Values\Content\Field; | ||
| use Ibexa\Contracts\TranslationsManagement\AutoTranslate\Transformer\Field\EncodedFieldValue; | ||
| use Ibexa\Contracts\TranslationsManagement\AutoTranslate\Transformer\Field\FieldValueTransformerInterface; | ||
| use Ibexa\Core\FieldType\Value; | ||
|
|
||
| final class ImageAltTextTransformer implements FieldValueTransformerInterface | ||
| { | ||
| public function getFieldTypeIdentifier(): string | ||
| { | ||
| return 'ibexa_image'; | ||
| } | ||
|
|
||
| public function encode(Field $field): EncodedFieldValue | ||
| { | ||
| return new EncodedFieldValue($field->getValue()->alternativeText ?? ''); | ||
| } | ||
|
|
||
| /** | ||
| * @param array<string, mixed> $metadata | ||
| */ | ||
| public function decode(string $value, mixed $previousFieldValue, array $metadata): Value | ||
| { | ||
| $previousFieldValue->alternativeText = $value; | ||
|
|
||
| return $previousFieldValue; | ||
| } | ||
| } |
15 changes: 15 additions & 0 deletions
15
code_samples/translations_management/src/TranslationsManagement/MyApiClient.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace App\TranslationsManagement; | ||
|
|
||
| /** Placeholder for your own HTTP client or third-party SDK wrapper. */ | ||
| final class MyApiClient | ||
| { | ||
| public function translate(string $text, string $sourceLanguage, string $targetLanguage): string | ||
| { | ||
| // Your implementation here. | ||
| return ''; | ||
| } | ||
| } |
16 changes: 16 additions & 0 deletions
16
code_samples/translations_management/src/TranslationsManagement/MyCustomExclusionRule.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace App\TranslationsManagement; | ||
|
|
||
| use Ibexa\Contracts\Core\Repository\Values\Content\ContentInfo; | ||
| use Ibexa\Contracts\TranslationsManagement\SideBySide\Service\SideBySideExclusionRuleInterface; | ||
|
|
||
| final class MyCustomExclusionRule implements SideBySideExclusionRuleInterface | ||
| { | ||
| public function isExcluded(ContentInfo $contentInfo): bool | ||
| { | ||
| return $contentInfo->getContentType()->identifier === 'my_excluded_type'; | ||
| } | ||
| } |
50 changes: 50 additions & 0 deletions
50
code_samples/translations_management/src/TranslationsManagement/MyCustomProvider.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace App\TranslationsManagement; | ||
|
|
||
| use Ibexa\Contracts\TranslationsManagement\AutoTranslate\Provider\TranslationProviderInterface; | ||
| use Ibexa\Contracts\TranslationsManagement\AutoTranslate\TranslationDataInterface; | ||
|
|
||
| final readonly class MyCustomProvider implements TranslationProviderInterface | ||
| { | ||
| /** | ||
| * Replace MyApiClient with your HTTP client, SDK wrapper, or any service | ||
| * that communicates with the external translation API. | ||
| */ | ||
| public function __construct( | ||
| private MyApiClient $apiClient, | ||
| ) { | ||
| } | ||
|
|
||
| public function getIdentifier(): string | ||
| { | ||
| return 'my_custom_provider'; | ||
| } | ||
|
|
||
| public function getName(): string | ||
| { | ||
| return 'My Translation Service'; | ||
| } | ||
|
|
||
| public function getVendorName(): string | ||
| { | ||
| return 'My Company Ltd'; | ||
| } | ||
|
|
||
| public function translate(TranslationDataInterface $translationData): string | ||
| { | ||
| return $this->apiClient->translate( | ||
| $translationData->getText(), | ||
| $translationData->getSourceLanguage(), | ||
| $translationData->getTargetLanguage() | ||
| ); | ||
| } | ||
|
|
||
| /** @return array<string> */ | ||
| public function getSupportedLanguageCodes(): array | ||
| { | ||
| return ['en_GB', 'de_DE', 'fr_FR']; | ||
| } | ||
| } |
22 changes: 22 additions & 0 deletions
22
..._samples/translations_management/src/TranslationsManagement/MyTranslationAddExtension.php
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace App\TranslationsManagement; | ||
|
|
||
| use Ibexa\AdminUi\Form\Type\Content\Translation\TranslationAddType; | ||
| use Symfony\Component\Form\AbstractTypeExtension; | ||
| use Symfony\Component\Form\FormBuilderInterface; | ||
|
|
||
| final class MyTranslationAddExtension extends AbstractTypeExtension | ||
| { | ||
| public static function getExtendedTypes(): iterable | ||
| { | ||
| return [TranslationAddType::class]; | ||
| } | ||
|
|
||
| public function buildForm(FormBuilderInterface $builder, array $options): void | ||
| { | ||
| $builder->add('my_custom_field'/* ... */); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
29 changes: 29 additions & 0 deletions
29
docs/api/event_reference/translations_management_events.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| description: Events that are triggered when working with translations management. | ||
| edition: lts-update | ||
| page_type: reference | ||
| --- | ||
|
|
||
| # Translations management events | ||
|
|
||
| The [Translations management](configure_translations_management.md) package dispatches events at two levels. | ||
|
|
||
| ## Translation events | ||
|
|
||
| Translation events are thrown once per field value per translation operation. | ||
| They are used for logging, analytics, and observability. | ||
| Both events are read-only, you can't use them to override the translation result. | ||
|
|
||
| | Event | Dispatched by | Dispatched when | Properties | | ||
| |---|---|---|----| | ||
| | [`BeforeTranslateEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Event-BeforeTranslateEvent.html) | `TranslationService` | Before a translation request is sent to the provider | `TranslationProviderInterface $provider`</br>`string $text`</br>`string $sourceLanguage`</br>`string $targetLanguage` | | ||
| | [`TranslateEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-AutoTranslate-Event-TranslateEvent.html) | `TranslationService` | After a translation response is received | `string $result`</br>`TranslationProviderInterface $provider`</br>`string $text`</br>`string $sourceLanguage`</br>`string $targetLanguage` | | ||
|
|
||
| ## Side-by-side creation events | ||
|
|
||
| Side-by-side creation events are dispatched when a new translation draft is being prepared. | ||
|
|
||
| | Event | Dispatched by | Dispatched when | Properties | | ||
| |---|---|---|---| | ||
| | [`OnContentSideBySideTranslationCreateEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Event-OnContentSideBySideTranslationCreateEvent.html) | `ContentTranslationCreateController` | When a draft side-by-side translation of a content item is being created | `Request $request`</br>`Content $sourceContent`</br>`string $sourceLanguageCode`</br>`string $targetLanguageCode`</br>`?Content $targetDraft` | | ||
| | [`OnProductSideBySideTranslationCreateEvent`](/api/php_api/php_api_reference/classes/Ibexa-Contracts-TranslationsManagement-SideBySide-Event-OnProductSideBySideTranslationCreateEvent.html) | `ProductTranslationViewController` | When a draft side-by-side translation of a product is being created | `Request $request`</br>`ContentAwareProductInterface $sourceProduct`</br>`ContentAwareProductInterface $targetProduct`</br>`string $sourceLanguageCode`</br>`string $targetLanguageCode`</br>`?ProductUpdateData $productUpdateData` | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 change: 1 addition & 0 deletions
1
docs/multisite/img/diagram_source/translations_management_flow.drawio
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| <mxfile host="Electron" modified="2026-06-16T10:51:05.860Z" agent="5.0 (Macintosh; Intel Mac OS X 26_3_1) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="j-W4lXxHCJBOFpcNCibg" version="14.6.13" type="device"><diagram id="1kQWOgmGZ1G1xJNYzsRM" name="Page-1">5Zptc6M2EIB/DTPtB2d4MRh/tB3Hcc5pPfW0l/uUkUEG9WTkCuGX+/WVQNiAyJn0iJ1cZzxjWEmw++xqWQk0a7TeTyjYhI/Eh1gzdX+vWbeaaRqGaWrip/sHKbFtJ5MEFPlSdhIs0DcohbqUJsiHcakjIwQztCkLPRJF0GMlGaCU7MrdVgSX77oBAVQECw9gVfoZ+SzMDdP1U8M9REEob+3asmEN8s5SEIfAJ7uCyBpr1ogSwrKj9X4EsaCXc8nG3b3QelSMwog1GTDIBmwBTqRtA3+NIqEZZDH/SzYCLgVRjAFDRLRsKNly/jSWJrBDzoWSJPKhuLShWcNdiBhcbIAnWnc8FLgsZGssm1cI4xHBhKZjLR9Ad+Vxecwo+QoLLY7nwuWKt6jGSXu3kDK4L4iksRNI1pDRA+8iW007GyEjr2PkIbUr+NGVsrDgQkfKgAyd4HjpE11+IAHXwx4qsMc+YtxMU6fwnwTGKfEI7qrI28RsQ9fv1mF2zaXlOC1h7l+T80jh/AeMCd7CuBC9mulgfs/hUhwF4ugXDKIg4VO3swFIOEXckM+AWHTm8wHzVMLd8Wur/litVqZXG/a+s3TslvxhdPWKP1R3HHNS0R29Ftxxp4b9noe3l0Z7HudgyWnyVIwg9ttNLJchXEks/QuG+0Thu4CRn8IlLybvj4i4fz3G9zUpxYMoSyk5YU5PIKUoCj5iCBvlHGFahpoj9DfiO1X4jijkRFO8gAaQdfLsLApHClbsAxI23Ssifvhe9bFFcBenj7zqUxFEIqrXxEc8N6fuCOGHr0+MbjmVWOYFHfFJzddgC7OLvkVsXwhpObS7NUQNu4ao3QLRmUo05LbE6e353fMIb/mxdyGwPfs82d4bkX1UyM6TJUZxCFte/V0EpeU0CNK6MrgNlLBmcS5FMUmol6+/M1H20NOK6xnol3YlVCspFAl5W96k+CGVzUYqD9+TylYjlUeqyndtq5wOHVAKDoUOG4IiFheuPBeC4jqiPNtdvWJ9dsETi6NmzfB0G+G5U/FMruZRW8lB2sjUBr1GlrSudr3bjlt/x8qukjEylHLUyfjXhofllsPD6Ff2987oVen/4/HkNPLCvRpP06vFU7PAmaoqP7yLDGFVFhF57dqaS91GfB5UPp+u5tL+f1V5djWV83r59To/XktnFPT8ER3iu0n09LsxGuyecNLJi7BCdq4WhnEINuLQSyg+DCnwvgpTzlWI5XJyhdHmXh5r9WVfDcsXK0G7slzpHMu+0gpQUyrBrtlCKVgL0vopQFp63Upa5Wj0+m/EsatwnM/+nEx/U2i+ClsbqKwyKkeNuNrFRxt7DrWkHIXUYno77gy/dMQ/b/lrOv787rDxRdyNfWVy7vm5KmxGHsAzsIR4TmKUbpVZt0vCGFlzNHmHAUaBaGCkQjKf7et9IN6j3yxBjLyb7nNaIDzH/JHwzLEN0/fq+o3bDu3jZD2+m3cU1k4N6jZeFNWi7v9/UNckhLqofrMnUJ7KC2hFkbGQp4SykAQkAnh8khbmu87PTn1mREBO6f4NGTvIrzhAwkiZPdwj9pRyteXZl0LL7V5eOT05FE7mkCJuN6RSptVVRWfrq+9N72LR9XK/qxVeDSqvn2RmHLfi258Z/PT0tU22Wjp9tGSN/wU=</diagram></mxfile> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
65 changes: 65 additions & 0 deletions
65
docs/multisite/translations_management/configure_translations_management.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| --- | ||
| description: Configure and extend translations management, including side-by-side translation view, and AI-based translation providers. | ||
| edition: lts-update | ||
| month_change: true | ||
| --- | ||
|
|
||
| # Translations management | ||
|
|
||
| `ibexa/translations-management` extends [[= product_name =]]'s content translation capabilities represented by the built-in language management tools. | ||
|
|
||
| ## Install | ||
|
|
||
| ```bash | ||
| composer require ibexa/translations-management | ||
| ``` | ||
|
|
||
| After installation, run the Ibexa data migrations to complete the setup. | ||
| This creates the database records and default configuration the package requires. | ||
|
|
||
| ## Configure translation providers | ||
|
|
||
|
|
||
| ### Provider configuration | ||
|
|
||
|
|
||
| ### Provider types | ||
|
|
||
|
|
||
| ### Provider options | ||
|
|
||
|
|
||
| ### Built-in AI providers | ||
|
|
||
|
|
||
| ### Plugin disabled state | ||
|
|
||
|
|
||
| ### Error handling | ||
|
|
||
|
|
||
| ## Manage language pairs | ||
|
|
||
| ## User settings | ||
|
|
||
|
|
||
| ### Always use automatic translation | ||
|
|
||
|
|
||
| ### Three-state provider selection | ||
|
|
||
|
|
||
| ### Multiple provider rendering | ||
|
|
||
|
|
||
| ## Side-by-side translation view | ||
|
|
||
| ### Side-by-side view functions | ||
|
|
||
| ### Architecture | ||
|
|
||
| ## Translate content items with CLI | ||
|
|
||
| ### CLI command options | ||
|
|
||
| ## Design system assets |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.