[TASK] Improve TCA configuration

Classes/Controller/MediaController.php

@@ -25,6 +25,7 @@
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
 use TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
+use RuntimeException;
 
 /**
  * Controller for rendering media.
@@ -94,7 +95,7 @@ private function renderMedia(Media $media): ResponseInterface
         // We update the last changed register when a media record has changed because
         // the content element will not get this information if no properties in the
         // content element are changed.
-        $contentObject = $contentObject = $this->getCurrentContentObject();
+        $contentObject = $this->getCurrentContentObject();
         $contentObject->lastChanged($media->getTstamp());
 
         if ($mediaType->equals(MediaType::VIDEO)) {
@@ -105,7 +106,7 @@ private function renderMedia(Media $media): ResponseInterface
             return (new ForwardResponse('audio'))->withArguments(['audio' => $media->getUid()]);
         }
 
-        throw new \RuntimeException('An invalid media type is used.');
+        throw new RuntimeException('An invalid media type is used.'); // @codeCoverageIgnore
     }
 
     /**

Classes/Domain/Model/Enumeration/MediaType.php

@@ -18,6 +18,8 @@
 
 /**
  * Enumeration of allowed media types.
+ *
+ * @codeCoverageIgnore No code to test.
  */
 class MediaType extends Enumeration
 {

Classes/Domain/Repository/MediaRepository.php

@@ -18,6 +18,7 @@
 use Sto\Html5mediakit\Exception\MediaMissingException;
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 use TYPO3\CMS\Extbase\Persistence\Repository;
+use InvalidArgumentException;
 
 /**
  * Repository for retrieving media files from the database.
@@ -76,10 +77,10 @@ private function fetchMediaOrThrowMissingMediaException(QueryInterface $query):
     private function validateParentRecordData($data): void
     {
         if (empty($data['parent_table'])) {
-            throw new \InvalidArgumentException('parent_table field is missing in content data.');
+            throw new InvalidArgumentException('parent_table field is missing in content data.');
         }
         if (empty($data['parent_record'])) {
-            throw new \InvalidArgumentException('parent_record field is missing in content data.');
+            throw new InvalidArgumentException('parent_record field is missing in content data.');
         }
     }
 }

Classes/Exception/MediaException.php

@@ -4,6 +4,8 @@
 
 namespace Sto\Html5mediakit\Exception;
 
+use RuntimeException;
+
 /*                                                                        *
  * This script belongs to the TYPO3 Extension "html5mediakit".            *
  *                                                                        *
@@ -16,7 +18,9 @@
 
 /**
  * Generic media related Exception. Translations should be available for the Exception code.
+ *
+ * @codeCoverageIgnore No code to test.
  */
-class MediaException extends \RuntimeException
+class MediaException extends RuntimeException
 {
 }

Classes/Exception/MediaMissingException.php

@@ -21,7 +21,7 @@
  */
 class MediaMissingException extends MediaException
 {
-    public function __construct($message = '', $code = 0, \Exception $previous = null)
+    public function __construct($message = '', $code = 0, Exception $previous = null)
     {
         if ($message === '') {
             $message = 'No media exists in the current content element.';

Configuration/TCA/Overrides/sys_file_reference.php

@@ -6,13 +6,6 @@
 
 $lllPrefix = 'LLL:EXT:html5mediakit/Resources/Private/Language/locallang_db:sys_file_reference.';
 
-$displayCondition = [
-    'AND' => [
-        'FIELD:tablenames:=:tx_html5mediakit_domain_model_media',
-        'FIELD:fieldname:=:tracks',
-    ],
-];
-
 $additionalColumns = [
     'tx_html5mediakit_track_kind' => [
         'label' => $lllPrefix . 'tx_html5mediakit_track_kind',
@@ -43,7 +36,6 @@
             ],
             'default' => 'subtitles',
         ],
-        'displayCond' => $displayCondition,
     ],
     'tx_html5mediakit_track_label' => [
         'label' => $lllPrefix . 'tx_html5mediakit_track_label',
@@ -53,7 +45,6 @@
             'eval' => 'trim',
             'size' => 10,
         ],
-        'displayCond' => $displayCondition,
     ],
     'tx_html5mediakit_track_srclang' => [
         'label' => $lllPrefix . 'tx_html5mediakit_track_srclang',
@@ -65,18 +56,10 @@
             'max' => 2,
             'size' => 10,
         ],
-        'displayCond' => $displayCondition,
     ],
 ];
 
 ExtensionManagementUtility::addTCAcolumns(
     'sys_file_reference',
     $additionalColumns
 );
-
-ExtensionManagementUtility::addToAllTCAtypes(
-    'sys_file_reference',
-    'tx_html5mediakit_track_kind, tx_html5mediakit_track_label, tx_html5mediakit_track_srclang',
-    '',
-    'after:title',
-);

Configuration/TCA/Overrides/tt_content.php

@@ -43,6 +43,7 @@
     --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:general,
         --palette--;;general,
         --palette--;;headers,
+    --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.media,
         tx_html5mediakit_media,
     --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.appearance,
         --palette--;;frames,

Configuration/TCA/tx_html5mediakit_domain_model_media.php

@@ -10,39 +10,58 @@
 $languagePrefixCsh = 'LLL:EXT:html5mediakit/Resources/Private/Language/locallang_csh_media.xlf:';
 $lllAddImageFileReference = 'LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:images.addFileReference';
 
-$buildFileFieldConfig = function (array $allowedFileTypes) use ($languagePrefix) {
-    return [
+$buildFileFieldConfig = function (
+    string|array $allowedFileTypes,
+    int $maxitems = 1,
+    string $showitem = '',
+    string $createNewRelationLinkTitle = '',
+) use (
+    $languagePrefix
+) {
+    $showitem .= ',--palette--;;filePalette';
+    $showitem = ltrim($showitem, ',');
+    $allowsMultipleFiles = $maxitems === 0 || $maxitems > 1;
+
+    if ($createNewRelationLinkTitle === '') {
+        $createNewRelationLinkTitle = $languagePrefix . 'choose_file';
+    }
+
+    $config = [
         'type' => 'file',
         'allowed' => $allowedFileTypes,
         'appearance' => [
-            'createNewRelationLinkTitle' => $languagePrefix . 'choose_file',
-            'useSortable' => false,
-            'headerThumbnail' => [
-                'field' => '',
-                'width' => '0',
-                'height' => '0',
-            ],
+            'showPossibleLocalizationRecords' => true,
+            'showAllLocalizationLink' => $allowsMultipleFiles,
+            'createNewRelationLinkTitle' => $createNewRelationLinkTitle,
+            'useSortable' => $allowsMultipleFiles,
             'enabledControls' => [
-                'info' => false,
-                'new' => false,
-                'dragdrop' => false,
-                'sort' => false,
-                'hide' => false,
+                'info' => true,
+                'new' => $allowsMultipleFiles,
+                'dragdrop' => $allowsMultipleFiles,
+                'sort' => $allowsMultipleFiles,
+                'hide' => $allowsMultipleFiles,
                 'delete' => true,
-                'localize' => false,
+                'localize' => true,
             ],
         ],
         'overrideChildTca' => [
             'types' => [
-                '0' => ['showitem' => '--palette--;;filePalette'],
-                AbstractFile::FILETYPE_AUDIO => ['showitem' => '--palette--;;filePalette'],
-                AbstractFile::FILETYPE_VIDEO => ['showitem' => '--palette--;;filePalette'],
-                AbstractFile::FILETYPE_APPLICATION => ['showitem' => '--palette--;;filePalette'],
+                AbstractFile::FILETYPE_APPLICATION => ['showitem' => $showitem],
+                AbstractFile::FILETYPE_AUDIO => ['showitem' => $showitem],
+                AbstractFile::FILETYPE_IMAGE => ['showitem' => $showitem],
+                AbstractFile::FILETYPE_TEXT => ['showitem' => $showitem],
+                AbstractFile::FILETYPE_UNKNOWN => ['showitem' => $showitem],
+                AbstractFile::FILETYPE_VIDEO => ['showitem' => $showitem],
             ],
         ],
-        'maxitems' => 1,
         'security' => ['ignorePageTypeRestriction' => true],
     ];
+
+    if ($maxitems > 0) {
+        $config['maxitems'] = $maxitems;
+    }
+
+    return $config;
 };
 
 return [
@@ -90,10 +109,11 @@
         'tracks' => [
             'label' => $languagePrefixColumn . 'tracks',
             'description' => $languagePrefixCsh . 'tracks.description',
-            'config' => [
-                'type' => 'file',
-                'allowed' => 'vtt',
-            ],
+            'config' => $buildFileFieldConfig(
+                ['vtt'],
+                0,
+                'tx_html5mediakit_track_kind, tx_html5mediakit_track_label, tx_html5mediakit_track_srclang',
+            ),
         ],
         'caption' => [
             'label' => $languagePrefixColumn . 'caption',
@@ -158,19 +178,10 @@
         ],
         'poster' => [
             'label' => $languagePrefixColumn . 'poster',
-            'config' => [
-                'type' => 'file',
-                'allowed' => 'common-image-types',
-                'appearance' => ['createNewRelationLinkTitle' => $lllAddImageFileReference],
-                'maxitems' => 1,
-                'behaviour' => ['allowLanguageSynchronization' => true],
-                'overrideChildTca' => [
-                    'types' => [
-                        '0' => ['showitem' => '--palette--;;filePalette'],
-                        AbstractFile::FILETYPE_IMAGE => ['showitem' => '--palette--;;filePalette'],
-                    ],
-                ],
-            ],
+            'config' => $buildFileFieldConfig(
+                allowedFileTypes: 'common-image-types',
+                createNewRelationLinkTitle: $lllAddImageFileReference
+            ),
         ],
         'sys_language_uid' => [
             'exclude' => true,
@@ -193,27 +204,36 @@
         '0' => ['showitem' => 'type,--palette--;;hiddenFields'],
         'video' => [
             'showitem' => '
-                type, h264, web_m, ogv, poster,
-                --palette--;' . $languagePrefixColumn . 'palette.metadata;metadata,
-                --palette--;;hiddenFields
+                --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.media,
+                    type, h264, web_m, ogv, poster,
+                    --palette--;;hiddenFields,
+                --div--;' . $languagePrefixColumn . 'tracks,
+                    tracks,
+                --div--;' . $languagePrefixColumn . 'palette.metadata;metadata,
+                    caption, description,
+                --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:language,
+                    --palette--;;language,
             ',
         ],
         'audio' => [
             'showitem' => '
-                type, mp3, ogg,
-                --palette--;' . $languagePrefixColumn . 'palette.metadata;metadata,
-                --palette--;;hiddenFields
+                --div--;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:tabs.media,
+                    type, mp3, ogg,
+                    --palette--;;hiddenFields,
+                --div--;' . $languagePrefixColumn . 'tracks,
+                    tracks,
+                --div--;' . $languagePrefixColumn . 'palette.metadata;metadata,
+                    caption, description,
+                --div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:language,
+                    --palette--;;language,
             ',
         ],
     ],
     'palettes' => [
-        'metadata' => [
-            'showitem' => 'tracks, --linebreak--, caption, --linebreak--, description',
-            'canNotCollapse' => 1,
-        ],
-        'hiddenFields' => [
-            'showitem' => 'sys_language_uid, l10n_parent',
-            'isHiddenPalette' => true,
+        'language' => [
+            'showitem' => '
+                sys_language_uid, l10n_parent
+            ',
         ],
     ],
 ];

Tests/Acceptance/Backend/ContentCreationCest.php

@@ -37,10 +37,16 @@ public function html5MediaCanBeCreated(BackendTester $I, PageTree $pageTree, Mod
         $I->waitForElement($headerInputSelector);
         $I->fillField($headerInputSelector, 'Testheader');
 
+        // Switch to tab "Media"
+        $I->click('.typo3-TCEforms > ' . $this->buildTabSelector(2));
+
         $I->click('Create new');
 
         $I->waitForElement('div[data-title="Media file"] select[name$="[type]"]');
 
+        // Tab "Meta data"
+        $I->click('div[data-foreign-table="tx_html5mediakit_domain_model_media"] ' . $this->buildTabSelector(3));
+
         $I->fillField('div[data-title="Media file"] input[data-formengine-input-name$="[caption]"]', 'The caption');
 
         $I->click('Save');
@@ -51,8 +57,19 @@ public function html5MediaCanBeCreated(BackendTester $I, PageTree $pageTree, Mod
 
         $I->seeInField($headerInputSelector, 'Testheader');
 
+        // Switch to tab "Media"
+        $I->click('.typo3-TCEforms > ' . $this->buildTabSelector(2));
+
         $I->click('#data-1-tt_content-1-tx_html5mediakit_media-tx_html5mediakit_domain_model_media-1_label');
         $I->waitForElement('div[data-title="Media file"] select[name$="[type]"]');
         $I->seeInField('div[data-title="Media file"] input[data-formengine-input-name$="[caption]"]', 'The caption');
     }
+
+    private function buildTabSelector(int $tabNumber): string
+    {
+        return sprintf(
+            'div[role="tabpanel"] > ul.nav-tabs > li.t3js-tabmenu-item:nth-child(%d) > a',
+            $tabNumber
+        );
+    }
 }

Tests/Acceptance/Support/Extension/BackendHtml5mediakitEnvironment.php

@@ -6,6 +6,7 @@
 
 use Codeception\Event\SuiteEvent;
 use TYPO3\TestingFramework\Core\Acceptance\Extension\BackendEnvironment;
+use RuntimeException;
 
 class BackendHtml5mediakitEnvironment extends BackendEnvironment
 {
@@ -38,7 +39,7 @@ public function bootstrapTypo3Environment(SuiteEvent $suiteEvent): void
         $typo3RootPath = (string)getenv('TYPO3_PATH_ROOT');
 
         if ($typo3RootPath === '') {
-            throw new \RuntimeException('TYPO3_PATH_ROOT environment variable is not set');
+            throw new RuntimeException('TYPO3_PATH_ROOT environment variable is not set');
         }
 
         $putenvCode = PHP_EOL