t3g/file-variants

Prototype for translatable files in TYPO3

0.11.2 2024-11-22 15:11 UTC

Requires

• php: ^8.1
• psr/http-message: ^1.0 || ^2.0
• typo3/cms-backend: ^11.5 || ^12.4
• typo3/cms-core: ^11.5 || ^12.4
• typo3/cms-extbase: ^11.5 || ^12.4
• typo3/cms-fluid: ^11.5 || ^12.4
• typo3/cms-install: ^11.5 || ^12.4

Requires (Dev)

• armin/editorconfig-cli: ^1.8
• ergebnis/composer-normalize: ^2.42
• friendsofphp/php-cs-fixer: ^3.0
• jangregor/phpstan-prophecy: ^1.0
• phpspec/prophecy: ^1.19
• phpspec/prophecy-phpunit: ^2.2
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• rector/rector: ^1.0
• saschaegerer/phpstan-typo3: ^1.10
• ssch/typo3-rector: ^2.2
• typo3/coding-standards: ^0.7.1
• typo3/testing-framework: ^7.0

Replaces

• t3g/file_variants: 0.11.2

GPL-2.0+

• TYPO3 GmbH

README

This extension serves as a working prototype for translatable files in TYPO3.

Features

• Upload language variants using the File list module to provide variants transparently throughout the system.
• Replace or remove variants (which resets to the file of the default language).
• Metadata records are can be translated just like before, but no longer point to the same file record.
• File records are translatable, but not directly accessible. All editing is done through metadata records.

Limits

• Providing file variants is only possible in File list module.
• Usage of sys_language_uid=-1 (All languages) is deactivated.

Setup

1. Install extension via Composer: composer require t3g/file-variants
2. Activate the extension
3. (optional) Use the extension configuration to create a dedicated file storage. If you use no dedicated storage, a dedicated folder will be used in default storage.

Data Examples

• Default language English, uid 0
• First language German (Deutsch), uid 1
• Second language Spain (Español), uid 2
• Third language Russian (Русский), uid 3

sys_file

(Notice that there is no Russian variant here.)

sys_file_metadata

tt_content

sys_file_reference

local is sys_file, foreign is tt_content

Schematically the following relations exist and are created/maintained automatically:

1. tt_content:1 (English) -> sys_file_reference:1 -> sys_file:1 (English)
2. tt_content:2 (German) -> sys_file_reference:2 -> sys_file:2 (German)
3. tt_content:3 (Spanish) -> sys_file_reference:3 -> sys_file:3 (Spanish)
4. tt_content:4 (Russian) -> sys_file_reference:4 -> sys_file:1 (English)

Behaviour

After Installation, the file metadata (sys_file_metadata) edit mask in File list module is slightly changed. Nothing changes for the default language. But creating / editing a file metadata translation allows for uploading a new file for this translation. The upload works the same way as the File list module and can be found next to the file info. This file will reside in the dedicated translation storage or folder. After uploading, the fileinfo element changes its content and displays the uploaded file.

A button then allows for resetting to the file used in default language. The file formerly used here is removed permanently! Also, the upload control is displayed again, so the a new file can be uploaded at any time.

During this process, all file references (sys_file_reference) are searched for a link to the default file, and updated with the translated one.

On each translation action to any record that contains a FAL field (like files or images), a check is performed to find out whether a file variant for the target language is available. If it is, the resulting file reference will link to that file variant instead of the default file.

This results in a consistent behaviour, that summarizes as:

• If a variant is available for a specific language, it will be used, everywhere and everytime.
• If no variant is available for a specific language, the default file is used (current standard TYPO3 behaviour).

Missing Features

1. Upgrade wizard: if file metadata translations already exist, no file variants are provided or added.
2. Workspaces support.