Release 5.0.10

.github/workflows/api_refs.yaml

@@ -124,6 +124,9 @@ jobs:
                   fi
                   composer config --global http-basic.updates.ibexa.co $SATIS_NETWORK_KEY $SATIS_NETWORK_TOKEN
 
+                  git config --global user.name "${GITHUB_ACTOR}"
+                  git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+
                   if [[ '4.6' != $BASE_BRANCH ]]; then
                     tools/api_refs/api_refs.sh
                     # Fix escape character:
@@ -140,8 +143,6 @@ jobs:
               env:
                   BASE_BRANCH: ${{ steps.version_and_branches.outputs.base_branch }}
               run: |
-                  git config --global user.name "${GITHUB_ACTOR}"
-                  git config --global user.email "${GITHUB_ACTOR}@users.noreply.github.com"
                   git add docs/api/php_api/php_api_reference/
                   if [[ '4.6' != $BASE_BRANCH ]]; then
                     git add tools/api_refs/.phpdoc/template/package-edition-map.twig

.lycheeignore

@@ -16,6 +16,7 @@
 ^https://support\.ibexa\.co/
 ^https://redocly\.com/redoc/
 ^https://updates\.ibexa\.co
+https://cohesivo.com
 
 # Hosts that block automated requests (403)
 ^https?://(www\.)?linkedin\.com

code_samples/back_office/online_editor/custom_tags/factbox/config/packages/custom_tags.yaml

@@ -1,25 +1,31 @@
-ibexa:
-    system:
-        admin_group:
-            fieldtypes:
-                ibexa_richtext:
-                    custom_tags: [factbox]
-                    toolbar:
-                        custom_tags_group:
-                            buttons:
-                                factbox:
-                                    priority: 5
 ibexa_fieldtype_richtext:
     custom_tags:
         factbox:
             template: '@ibexadesign/field_type/ibexa_richtext/custom_tags/factbox.html.twig'
-            icon: '/bundles/ibexaadminuiassets/vendors/ids-assets/dist/img/all-icons.svg#info-square'
+            icon: '/bundles/ibexaadminuiassets/vendors/ids-assets/dist/img/all-icons.svg#info-square' # Optional
+            is_inline: false # Optional
+            label: 'Factbox custom tag' # Optional
+            description: 'Highlight a piece of information in a box' # Optional
             attributes:
                 name:
                     type: string
-                    required: true
+                    required: true # Optional
+                    label: 'My name attribute' # Optional
                 style:
                     type: choice
-                    required: true
+                    required: true # Optional
                     default_value: light
                     choices: [light, dark]
+                    label: 'My style attribute' # Optional
+
+ibexa:
+    system:
+        admin_group:
+            fieldtypes:
+                ibexa_richtext:
+                    custom_tags: [factbox]
+                    toolbar:
+                        custom_tags_group:
+                            buttons:
+                                factbox:
+                                    priority: 5

code_samples/back_office/online_editor/custom_tags/factbox/config/packages/jms_translation.yaml

@@ -0,0 +1,9 @@
+jms_translation:
+    configs:
+        app_translation_config:
+            dirs: ['%kernel.project_dir%/src']
+            output_dir: '%kernel.project_dir%/translations'
+            output_format: yaml
+            extractors:
+                - 'app.translation_extractor.factbox'
+                - 'app.translation_extractor.factbox_choice'

code_samples/back_office/online_editor/custom_tags/factbox/config/services.yaml

@@ -0,0 +1,20 @@
+services:
+    app.extractor.custom_tag:
+        class: Ibexa\FieldTypeRichText\Translation\Extractor\CustomTagExtractor
+        arguments:
+            $customTags: '%ibexa.field_type.richtext.custom_tags%'
+            $domain: '%ibexa.field_type.richtext.custom_tags.translation_domain%'
+            $allowlist: ['factbox']
+        tags:
+            -   name: jms_translation.extractor
+                alias: app.translation_extractor.factbox
+
+    app.extractor.custom_tag_choice:
+        class: Ibexa\FieldTypeRichText\Translation\Extractor\ChoiceAttributeExtractor
+        arguments:
+            $customTags: '%ibexa.field_type.richtext.custom_tags%'
+            $domain: '%ibexa.field_type.richtext.custom_tags.translation_domain%'
+            $allowlist: ['factbox']
+        tags:
+            -   name: jms_translation.extractor
+                alias: app.translation_extractor.factbox_choice

code_samples/back_office/online_editor/custom_tags/factbox/templates/themes/standard/field_type/ibexa_richtext/custom_tags/factbox.html.twig

@@ -1,3 +1,5 @@
+{{ encore_entry_link_tags('factbox') }}
+
 <div class="ibexa-factbox ibexa-factbox--{{ params.style }}">
     <p>{{ params.name }}</p>
     <div>

code_samples/back_office/online_editor/custom_tags/factbox/translations/custom_tags.en.yaml

@@ -1,3 +1,6 @@
 ibexa_richtext.custom_tags.factbox.label: 'Factbox'
+ibexa_richtext.custom_tags.factbox.description: 'Highlight a piece of information in a box'
 ibexa_richtext.custom_tags.factbox.attributes.name.label: 'Name'
 ibexa_richtext.custom_tags.factbox.attributes.style.label: 'Style'
+ibexa_richtext.custom_tags.factbox.attributes.style.choice.dark.label: 'Dark'
+ibexa_richtext.custom_tags.factbox.attributes.style.choice.light.label: 'Light'

code_samples/back_office/online_editor/custom_tags/factbox/webpack.config.js

@@ -0,0 +1,3 @@
+Encore.addStyleEntry('factbox', [
+    path.resolve(__dirname, './assets/scss/factbox.scss'),
+]);

code_samples/background_tasks/src/Dispatcher/SomeClassThatSchedulesExecutionInTheBackground.php

@@ -2,6 +2,7 @@
 
 namespace App\Dispatcher;
 
+use App\Message\SomeMessage;
 use Ibexa\Contracts\Core\Repository\PermissionResolver;
 use Ibexa\Contracts\Messenger\Stamp\DeduplicateStamp;
 use Ibexa\Contracts\Messenger\Stamp\SudoStamp;
@@ -16,15 +17,15 @@ public function __construct(
     ) {
     }
 
-    public function schedule(object $message): void
+    public function schedule(): void
     {
-        $this->bus->dispatch($message);
+        $this->bus->dispatch(new SomeMessage());
 
         $currentUserId = $this->permissionResolver->getCurrentUserReference()->getUserId();
-        $this->bus->dispatch($message, [new UserPermissionStamp($currentUserId)]);
-        $this->bus->dispatch($message, [new SudoStamp()]);
+        $this->bus->dispatch(new SomeMessage(), [new UserPermissionStamp($currentUserId)]);
+        $this->bus->dispatch(new SomeMessage(), [new SudoStamp()]);
 
         $deduplicationKey = 'my_message.project.<key_based_on_message>';
-        $this->bus->dispatch($message, [new DeduplicateStamp($deduplicationKey)]);
+        $this->bus->dispatch(new SomeMessage(), [new DeduplicateStamp($deduplicationKey)]);
     }
 }

code_samples/background_tasks/src/Messenger/SomeMessageProvider.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace App\Messenger;
+
+use App\Message\SomeMessage;
+use Ibexa\Contracts\Messenger\Transport\MessageProviderInterface;
+
+final class SomeMessageProvider implements MessageProviderInterface
+{
+    public function getHandledClasses(): iterable
+    {
+        return [SomeMessage::class];
+    }
+}

code_samples/data_migration/examples/update_language.yaml

@@ -0,0 +1,11 @@
+-
+    type: language
+    mode: update
+    languageCode: ger-DE
+    metadata:
+        name: 'German (Germany)'
+        enabled: true
+    references:
+        -
+            name: ref__ger_de__language_id
+            type: language_id

code_samples/translations_management/config/services.yaml

@@ -0,0 +1,37 @@
+services:
+    App\TranslationsManagement\MyCustomProvider:
+        tags:
+            - name: 'ibexa.translations_management.auto_translate.provider'
+              identifier: 'my_custom_provider'
+              validation_profile: 'my_custom_profile'
+    App\TranslationsManagement\MyProviderValidator:
+        tags:
+            - name: 'ibexa.translations_management.auto_translate.provider.validator'
+              profile: 'my_custom_profile'
+    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_point2d', 'custom_value']
+        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
+    App\TranslationsManagement\MyCustomAiProvider:
+        tags:
+            - name: 'ibexa.translations_management.auto_translate.provider'
+              identifier: 'my_custom_ai_provider'
+              validation_profile: 'ai_generic'
+    App\TranslationsManagement\MyCustomLanguageNormalizer:
+        tags:
+            - name: 'ibexa.translations_management.auto_translate.provider.language_normalizer'
+              priority: 10

code_samples/translations_management/install/schema.mysql.sql

@@ -0,0 +1,35 @@
+CREATE TABLE IF NOT EXISTS ibexa_auto_translation (
+    id INT AUTO_INCREMENT NOT NULL,
+    provider_identifier VARCHAR(190) NOT NULL,
+    content_id INT NOT NULL,
+    version_no INT NOT NULL,
+    source_language_id BIGINT NOT NULL,
+    target_language_id BIGINT NOT NULL,
+    review_status VARCHAR(64) NOT NULL,
+    created_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
+    updated_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
+    INDEX ibexa_auto_translation_content_version_idx (content_id, version_no),
+    INDEX ibexa_auto_translation_target_language_idx (target_language_id),
+    INDEX ibexa_auto_translation_review_status_idx (review_status),
+    UNIQUE INDEX ibexa_auto_translation_context_uidx (content_id, version_no, source_language_id, target_language_id),
+    PRIMARY KEY(id)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
+
+CREATE TABLE IF NOT EXISTS ibexa_auto_translation_review_log (
+    id INT AUTO_INCREMENT NOT NULL,
+    auto_translation_id INT DEFAULT NULL,
+    user_id INT NOT NULL,
+    status VARCHAR(64) NOT NULL,
+    operation VARCHAR(64) NOT NULL,
+    created_at DATETIME NOT NULL COMMENT '(DC2Type:datetime_immutable)',
+    INDEX IDX_325A3B737CE350E8 (auto_translation_id),
+    INDEX ibexa_auto_translation_review_log_auto_translation_created_idx (auto_translation_id, created_at, id),
+    INDEX ibexa_auto_translation_review_log_status_created_idx (status, created_at),
+    INDEX ibexa_auto_translation_review_log_user_idx (user_id),
+    PRIMARY KEY(id)
+) DEFAULT CHARACTER SET utf8mb4 COLLATE `utf8mb4_unicode_520_ci` ENGINE = InnoDB;
+
+ALTER TABLE ibexa_auto_translation_review_log ADD CONSTRAINT ibexa_auto_translation_review_log_auto_translation_fk
+    FOREIGN KEY (auto_translation_id) REFERENCES ibexa_auto_translation (id) ON UPDATE CASCADE ON DELETE SET NULL;
+ALTER TABLE ibexa_auto_translation_review_log ADD CONSTRAINT ibexa_auto_translation_review_log_user_fk
+    FOREIGN KEY (user_id) REFERENCES ibexa_user (contentobject_id) ON UPDATE CASCADE ON DELETE RESTRICT;

code_samples/translations_management/install/schema.postgresql.sql

@@ -0,0 +1,40 @@
+CREATE TABLE IF NOT EXISTS ibexa_auto_translation (
+    id SERIAL NOT NULL,
+    provider_identifier VARCHAR(190) NOT NULL,
+    content_id INT NOT NULL,
+    version_no INT NOT NULL,
+    source_language_id BIGINT NOT NULL,
+    target_language_id BIGINT NOT NULL,
+    review_status VARCHAR(64) NOT NULL,
+    created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+    updated_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+    PRIMARY KEY(id)
+);
+
+CREATE INDEX IF NOT EXISTS ibexa_auto_translation_content_version_idx ON ibexa_auto_translation (content_id, version_no);
+CREATE INDEX IF NOT EXISTS ibexa_auto_translation_target_language_idx ON ibexa_auto_translation (target_language_id);
+CREATE INDEX IF NOT EXISTS ibexa_auto_translation_review_status_idx ON ibexa_auto_translation (review_status);
+CREATE UNIQUE INDEX IF NOT EXISTS ibexa_auto_translation_context_uidx ON ibexa_auto_translation (content_id, version_no, source_language_id, target_language_id);
+COMMENT ON COLUMN ibexa_auto_translation.created_at IS '(DC2Type:datetime_immutable)';
+COMMENT ON COLUMN ibexa_auto_translation.updated_at IS '(DC2Type:datetime_immutable)';
+
+CREATE TABLE IF NOT EXISTS ibexa_auto_translation_review_log (
+    id SERIAL NOT NULL,
+    auto_translation_id INT DEFAULT NULL,
+    user_id INT NOT NULL,
+    status VARCHAR(64) NOT NULL,
+    operation VARCHAR(64) NOT NULL,
+    created_at TIMESTAMP(0) WITHOUT TIME ZONE NOT NULL,
+    PRIMARY KEY(id)
+);
+
+CREATE INDEX IF NOT EXISTS IDX_325A3B737CE350E8 ON ibexa_auto_translation_review_log (auto_translation_id);
+CREATE INDEX IF NOT EXISTS ibexa_auto_translation_review_log_auto_translation_created_idx ON ibexa_auto_translation_review_log (auto_translation_id, created_at, id);
+CREATE INDEX IF NOT EXISTS ibexa_auto_translation_review_log_status_created_idx ON ibexa_auto_translation_review_log (status, created_at);
+CREATE INDEX IF NOT EXISTS ibexa_auto_translation_review_log_user_idx ON ibexa_auto_translation_review_log (user_id);
+COMMENT ON COLUMN ibexa_auto_translation_review_log.created_at IS '(DC2Type:datetime_immutable)';
+
+ALTER TABLE ibexa_auto_translation_review_log ADD CONSTRAINT ibexa_auto_translation_review_log_auto_translation_fk
+    FOREIGN KEY (auto_translation_id) REFERENCES ibexa_auto_translation (id) ON UPDATE CASCADE ON DELETE SET NULL;
+ALTER TABLE ibexa_auto_translation_review_log ADD CONSTRAINT ibexa_auto_translation_review_log_user_fk
+    FOREIGN KEY (user_id) REFERENCES ibexa_user (contentobject_id) ON UPDATE CASCADE ON DELETE RESTRICT;

code_samples/translations_management/src/TranslationsManagement/ImageAltTextTransformer.php

@@ -0,0 +1,60 @@
+<?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\Base\Exceptions\InvalidArgumentException;
+use Ibexa\Core\FieldType\Image\Value as ImageValue;
+use Ibexa\Core\FieldType\Value;
+
+final class ImageAltTextTransformer implements FieldValueTransformerInterface
+{
+    public function getFieldTypeIdentifier(): string
+    {
+        return 'ibexa_image';
+    }
+
+    public function encode(Field $field): EncodedFieldValue
+    {
+        $value = $field->getValue();
+        if (!$value instanceof ImageValue) {
+            throw new InvalidArgumentException(
+                '$field',
+                sprintf('Expected %s, got %s.', ImageValue::class, get_debug_type($value))
+            );
+        }
+
+        return new EncodedFieldValue($value->alternativeText ?? '');
+    }
+
+    /**
+     * @param array<string, mixed> $metadata
+     */
+    public function decode(string $value, mixed $previousFieldValue, array $metadata): Value
+    {
+        if (!$previousFieldValue instanceof ImageValue) {
+            throw new InvalidArgumentException(
+                '$previousFieldValue',
+                sprintf('Expected %s, got %s.', ImageValue::class, get_debug_type($previousFieldValue))
+            );
+        }
+
+        return new ImageValue([
+            'id' => $previousFieldValue->id,
+            'fileName' => $previousFieldValue->fileName,
+            'fileSize' => $previousFieldValue->fileSize,
+            'uri' => $previousFieldValue->uri,
+            'imageId' => $previousFieldValue->imageId,
+            'inputUri' => $previousFieldValue->inputUri,
+            'width' => $previousFieldValue->width,
+            'height' => $previousFieldValue->height,
+            'alternativeText' => $value,
+            'additionalData' => $previousFieldValue->additionalData,
+            'mime' => $previousFieldValue->mime,
+        ]);
+    }
+}

code_samples/translations_management/src/TranslationsManagement/MyApiClient.php

@@ -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 '';
+    }
+}