[!!!][TASK] Drop additional namespace segment for the Tea model

The `Product` namespace segment in the domain model namespace `TTN\Tea\Domain\Model` currently serves no purpose and only adds confusion. So let's simplify the extension structure accordingly. (I intended to use this to demonstrate DDD contexts, but never built enough models in the Tea extension for this to actually make sense.) Fixes #1008
TYPO3BestPractices · Jan 8, 2024 · 90db6d8 · 90db6d8
1 parent 6f9dd4b
commit 90db6d8
Show file tree

Hide file tree

Showing 25 changed files with 84 additions and 83 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 ### Added
 
 ### Changed
+- Drop additional namespace segment for the Tea model (#1025)
 
 ### Deprecated
 

diff --git a/Classes/Controller/FrontEndEditorController.php b/Classes/Controller/FrontEndEditorController.php
@@ -5,8 +5,8 @@
 namespace TTN\Tea\Controller;
 
 use Psr\Http\Message\ResponseInterface;
-use TTN\Tea\Domain\Model\Product\Tea;
-use TTN\Tea\Domain\Repository\Product\TeaRepository;
+use TTN\Tea\Domain\Model\Tea;
+use TTN\Tea\Domain\Repository\TeaRepository;
 use TYPO3\CMS\Core\Context\Context;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Extbase\Annotation as Extbase;

diff --git a/Classes/Controller/TeaController.php b/Classes/Controller/TeaController.php
@@ -5,8 +5,8 @@
 namespace TTN\Tea\Controller;
 
 use Psr\Http\Message\ResponseInterface;
-use TTN\Tea\Domain\Model\Product\Tea;
-use TTN\Tea\Domain\Repository\Product\TeaRepository;
+use TTN\Tea\Domain\Model\Tea;
+use TTN\Tea\Domain\Repository\TeaRepository;
 use TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
 
 /**

diff --git a/Classes/Domain/Model/Product/Tea.php → Classes/Domain/Model/Tea.php b/Classes/Domain/Model/Product/Tea.php → Classes/Domain/Model/Tea.php
@@ -2,7 +2,7 @@
 
 declare(strict_types=1);
 
-namespace TTN\Tea\Domain\Model\Product;
+namespace TTN\Tea\Domain\Model;
 
 use TYPO3\CMS\Extbase\Annotation as Extbase;
 use TYPO3\CMS\Extbase\Domain\Model\FileReference;

diff --git a/...main/Repository/Product/TeaRepository.php → Classes/Domain/Repository/TeaRepository.php b/...main/Repository/Product/TeaRepository.php → Classes/Domain/Repository/TeaRepository.php
@@ -2,9 +2,9 @@
 
 declare(strict_types=1);
 
-namespace TTN\Tea\Domain\Repository\Product;
+namespace TTN\Tea\Domain\Repository;
 
-use TTN\Tea\Domain\Model\Product\Tea;
+use TTN\Tea\Domain\Model\Tea;
 use TTN\Tea\Domain\Repository\Traits\StoragePageAgnosticTrait;
 use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 use TYPO3\CMS\Extbase\Persistence\QueryResultInterface;

diff --git a/Configuration/Extbase/Persistence/Classes.php b/Configuration/Extbase/Persistence/Classes.php
@@ -3,7 +3,7 @@
 declare(strict_types=1);
 
 return [
-    \TTN\Tea\Domain\Model\Product\Tea::class => [
+    \TTN\Tea\Domain\Model\Tea::class => [
         'properties' => [
             'ownerUid' => ['fieldName' => 'owner'],
         ],

diff --git a/...n/TCA/tx_tea_domain_model_product_tea.php → ...iguration/TCA/tx_tea_domain_model_tea.php b/...n/TCA/tx_tea_domain_model_product_tea.php → ...iguration/TCA/tx_tea_domain_model_tea.php
@@ -2,7 +2,7 @@
 
 $tca = [
     'ctrl' => [
-        'title' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea',
+        'title' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea',
         'label' => 'title',
         'tstamp' => 'tstamp',
         'crdate' => 'crdate',
@@ -26,19 +26,19 @@
             'showitem' =>
                 '--div--;LLL:EXT:core/Resources/Private/Language/Form/locallang_tabs.xlf:general,
                     title, description, image, owner,
-                 --div--;LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.tabs.access,
+                 --div--;LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.tabs.access,
                     --palette--;;hidden,
                     --palette--;;access,',
         ],
     ],
     'palettes' => [
         'hidden' => [
             'showitem' => '
-                hidden;LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.hidden
+                hidden;LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.hidden
             ',
         ],
         'access' => [
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.palettes.access',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.palettes.access',
             'showitem' => '
                 starttime;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:starttime_formlabel,
                 endtime;LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:endtime_formlabel,
@@ -50,7 +50,7 @@
     'columns' => [
         'hidden' => [
             'exclude' => true,
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.hidden',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.hidden',
             'config' => [
                 'type' => 'check',
                 'renderType' => 'checkboxToggle',
@@ -107,10 +107,10 @@
                         'value' => 0,
                     ],
                 ],
-                'foreign_table' => 'tx_tea_domain_model_product_tea',
+                'foreign_table' => 'tx_tea_domain_model_tea',
                 'foreign_table_where' =>
-                    'AND {#tx_tea_domain_model_product_tea}.{#pid}=###CURRENT_PID###
-                     AND {#tx_tea_domain_model_product_tea}.{#sys_language_uid} IN (-1,0)',
+                    'AND {#tx_tea_domain_model_tea}.{#pid}=###CURRENT_PID###
+                     AND {#tx_tea_domain_model_tea}.{#sys_language_uid} IN (-1,0)',
                 'default' => 0,
             ],
         ],
@@ -126,7 +126,7 @@
             ],
         ],
         'title' => [
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.title',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.title',
             'config' => [
                 'type' => 'input',
                 'size' => 40,
@@ -136,7 +136,7 @@
             ],
         ],
         'description' => [
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.description',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.description',
             'config' => [
                 'type' => 'text',
                 'enableRichtext' => true,
@@ -147,7 +147,7 @@
             ],
         ],
         'image' => [
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.image',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.image',
             'config' => [
                 'type' => 'file',
                 'maxitems' => 1,
@@ -164,7 +164,7 @@
         'fe_group' => [
             'exclude' => true,
             'l10n_mode' => 'exclude',
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.fe_group',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.fe_group',
             'config' => [
                 'type' => 'select',
                 'renderType' => 'selectMultipleSideBySide',
@@ -191,7 +191,7 @@
         'owner' => [
             'exclude' => true,
             'l10n_mode' => 'exclude',
-            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.owner',
+            'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.owner',
             'config' => [
                 'type' => 'group',
                 'allowed' => 'fe_users',
@@ -231,7 +231,7 @@
         ],
     ];
     $tca['columns']['image'] = [
-        'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.image',
+        'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.image',
         'config' => \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::getFileFieldTCAConfig(
             'image',
             [
@@ -248,7 +248,7 @@
     ];
     $tca['columns']['hidden']['config'] = [
         'type' => 'check',
-        'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_product_tea.hidden',
+        'label' => 'LLL:EXT:tea/Resources/Private/Language/locallang_db.xlf:tx_tea_domain_model_tea.hidden',
         'items' => [
             [
                 0 => '',

diff --git a/Resources/Private/Language/de.locallang_db.xlf b/Resources/Private/Language/de.locallang_db.xlf
@@ -3,35 +3,35 @@
 	<file source-language="en" target-language="de" datatype="plaintext" original="messages">
 		<header/>
 		<body>
-			<trans-unit id="tx_tea_domain_model_product_tea">
+			<trans-unit id="tx_tea_domain_model_tea">
 				<source>Tea</source>
 				<target>Tee</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.tabs.access">
+			<trans-unit id="tx_tea_domain_model_tea.tabs.access">
 				<source>Access</source>
 				<target>Zugriff</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.title">
+			<trans-unit id="tx_tea_domain_model_tea.title">
 				<source>Title</source>
 				<target>Titel</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.description">
+			<trans-unit id="tx_tea_domain_model_tea.description">
 				<source>Description</source>
 				<target>Beschreibung</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.image">
+			<trans-unit id="tx_tea_domain_model_tea.image">
 				<source>Image</source>
 				<target>Bild</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.owner">
+			<trans-unit id="tx_tea_domain_model_tea.owner">
 				<source>Website user who created this record</source>
 				<target>Website-Benutzer, der diesen Datensatz erstellt hat</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.fe_group">
+			<trans-unit id="tx_tea_domain_model_tea.fe_group">
 				<source>Usergroup Access Rights</source>
 				<target>Zugriffsrechte für Benutzergruppen</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.hidden">
+			<trans-unit id="tx_tea_domain_model_tea.hidden">
 				<source>Visible</source>
 				<target>Sichtbar</target>
 			</trans-unit>

diff --git a/Resources/Private/Language/locallang_db.xlf b/Resources/Private/Language/locallang_db.xlf
@@ -3,28 +3,28 @@
 	<file source-language="en" datatype="plaintext" original="messages">
 		<header/>
 		<body>
-			<trans-unit id="tx_tea_domain_model_product_tea">
+			<trans-unit id="tx_tea_domain_model_tea">
 				<source>Tea</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.tabs.access">
+			<trans-unit id="tx_tea_domain_model_tea.tabs.access">
 				<source>Access</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.title">
+			<trans-unit id="tx_tea_domain_model_tea.title">
 				<source>Title</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.description">
+			<trans-unit id="tx_tea_domain_model_tea.description">
 				<source>Description</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.image">
+			<trans-unit id="tx_tea_domain_model_tea.image">
 				<source>Image</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.owner">
+			<trans-unit id="tx_tea_domain_model_tea.owner">
 				<source>Website user who created this record</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.fe_group">
+			<trans-unit id="tx_tea_domain_model_tea.fe_group">
 				<source>Usergroup Access Rights</source>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.hidden">
+			<trans-unit id="tx_tea_domain_model_tea.hidden">
 				<source>Visible</source>
 			</trans-unit>
 		</body>

diff --git a/Resources/Private/Language/pl.locallang_db.xlf b/Resources/Private/Language/pl.locallang_db.xlf
@@ -3,31 +3,31 @@
 	<file source-language="en" target-language="pl" datatype="plaintext" original="messages">
 		<header/>
 		<body>
-			<trans-unit id="tx_tea_domain_model_product_tea">
+			<trans-unit id="tx_tea_domain_model_tea">
 				<source>Tea</source>
 				<target>Herbata</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.tabs.access">
+			<trans-unit id="tx_tea_domain_model_tea.tabs.access">
 				<source>Access</source>
 				<target>Dostęp</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.title">
+			<trans-unit id="tx_tea_domain_model_tea.title">
 				<source>Title</source>
 				<target>Tytuł</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.description">
+			<trans-unit id="tx_tea_domain_model_tea.description">
 				<source>Description</source>
 				<target>Opis</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.image">
+			<trans-unit id="tx_tea_domain_model_tea.image">
 				<source>Image</source>
 				<target>Obraz</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.owner">
+			<trans-unit id="tx_tea_domain_model_tea.owner">
 				<source>Website user who created this record</source>
 				<target>Użytkownik strony, który utworzył ten rekord</target>
 			</trans-unit>
-			<trans-unit id="tx_tea_domain_model_product_tea.fe_group">
+			<trans-unit id="tx_tea_domain_model_tea.fe_group">
 				<source>Usergroup Access Rights</source>
 				<target>Prawa dostępu grupy użytkowników</target>
 			</trans-unit>

diff --git a/Tests/Functional/Controller/Fixtures/Database/Teas.csv b/Tests/Functional/Controller/Fixtures/Database/Teas.csv
@@ -1,4 +1,4 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title"
 ,1,2,"Godesberger Burgtee"
 ,2,2,"Oolong"
diff --git a/...ository/Fixtures/Product/PersistedTea.csv → ...main/Repository/Fixtures/PersistedTea.csv b/...ository/Fixtures/Product/PersistedTea.csv → ...main/Repository/Fixtures/PersistedTea.csv
@@ -1,3 +1,3 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","title"
 ,1,"Godesberger Burgtee"
diff --git a/...Repository/Fixtures/Product/TeaOnPage.csv → .../Domain/Repository/Fixtures/TeaOnPage.csv b/...Repository/Fixtures/Product/TeaOnPage.csv → .../Domain/Repository/Fixtures/TeaOnPage.csv
@@ -1,3 +1,3 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title"
 ,1,1,"Earl Grey"
diff --git a/...Fixtures/Product/TeaWithAllScalarData.csv → ...ository/Fixtures/TeaWithAllScalarData.csv b/...Fixtures/Product/TeaWithAllScalarData.csv → ...ository/Fixtures/TeaWithAllScalarData.csv
@@ -1,3 +1,3 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title","description","owner"
 ,1,1,"Earl Grey","Fresh and hot.",2
diff --git a/...ository/Fixtures/Product/TeaWithImage.csv → ...main/Repository/Fixtures/TeaWithImage.csv b/...ository/Fixtures/Product/TeaWithImage.csv → ...main/Repository/Fixtures/TeaWithImage.csv
@@ -1,7 +1,7 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title","image",
 ,1,1,"Gunpowder",1
 
 "sys_file_reference"
 ,"uid","uid_foreign","tablenames","fieldname"
-,1,1,"tx_tea_domain_model_product_tea","image"
+,1,1,"tx_tea_domain_model_tea","image"
diff --git a/...ository/Fixtures/Product/TeaWithOwner.csv → ...main/Repository/Fixtures/TeaWithOwner.csv b/...ository/Fixtures/Product/TeaWithOwner.csv → ...main/Repository/Fixtures/TeaWithOwner.csv
@@ -1,3 +1,3 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title","owner"
 ,"1","1","Earl Grey",1
diff --git a/...tory/Fixtures/Product/TeaWithoutOwner.csv → ...n/Repository/Fixtures/TeaWithoutOwner.csv b/...tory/Fixtures/Product/TeaWithoutOwner.csv → ...n/Repository/Fixtures/TeaWithoutOwner.csv
@@ -1,3 +1,3 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title","owner"
 ,1,1,"Earl Grey",0
diff --git a/...ory/Fixtures/Product/TwoTeasWithOwner.csv → .../Repository/Fixtures/TwoTeasWithOwner.csv b/...ory/Fixtures/Product/TwoTeasWithOwner.csv → .../Repository/Fixtures/TwoTeasWithOwner.csv
@@ -1,4 +1,4 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title","owner"
 ,1,1,"Earl Grey",1
 ,2,1,"Assam",1
diff --git a/...tory/Fixtures/Product/TwoUnsortedTeas.csv → ...n/Repository/Fixtures/TwoUnsortedTeas.csv b/...tory/Fixtures/Product/TwoUnsortedTeas.csv → ...n/Repository/Fixtures/TwoUnsortedTeas.csv
@@ -1,4 +1,4 @@
-"tx_tea_domain_model_product_tea"
+"tx_tea_domain_model_tea"
 ,"uid","pid","title"
 ,1,1,"Earl Grey"
 ,2,1,"Assam"