Add XmlTemplateFormMetadataLoader to replace old structure based metadata loading #7982

alexander-schranz · 2025-06-02T14:42:39Z

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Fixed tickets	fixes #
Related issues/PRs	#7908
License	MIT
Documentation PR	sulu/sulu-docs#

What's in this PR?

Add new XmlTemplateFormMetadataLoader.

Why?

To replace old structure based metadata loading.

ToDo

Settings Form Key handling
Template Meta Title
Block MinOccurs
Tests

alexander-schranz · 2025-06-02T14:44:06Z

packages/article/src/Infrastructure/Symfony/HttpKernel/SuluArticleBundle.php

@@ -275,7 +275,7 @@ public function prependExtension(ContainerConfigurator $container, ContainerBuil
                        ],
                    ],
                    'templates' => [
-                        'articles' => [
+                        ArticleInterface::TEMPLATE_TYPE => [


I personally would remove the "template_type" currently singleton (page, snippet, article) and replace it with the resource key (pages, snippets, articles) but that should be discussed and tackled in an own Pull request.

alexander-schranz · 2025-06-02T19:41:39Z

src/Sulu/Bundle/CoreBundle/DependencyInjection/SuluCoreExtension.php

+        $container->prependExtensionConfig(
+            'sulu_admin',
+            [
+                'templates' => [
+                    'block' => [ // TODO maybe blocks?
+                        'default_type' => null,
+                        'directories' => [
+                            'app' => '%kernel.project_dir%/config/templates/blocks',
+                        ],
+                    ],
+                ],
+            ]
+        );


we should move this in to the admin or content bundle not sure. Little bit splitted what the correct place is. /cc @Prokyonn, @chirimoya.

JS for global blocks is in the Admin Bundle. Metadata currently also. Template types definitions are in the specific bundles (articles, snippets, page).

Global Metadata service is currently in component would also required to move to the bundle which does the configuration.

Block json metadata which also handles global blocks is currently part of the block content type currently inside components. The block property resolver will be part of content bundle, the json metadata maybe also but would not be required, currently property resolver interface and json schema interfaces are on the same class.

https://github.com/sulu/sulu/blob/3.0/src/Sulu/Component/Content/Types/BlockContentType.php#L471-L505

https://github.com/sulu/sulu/blob/3.0/src/Sulu/Component/Content/Types/Metadata/GlobalBlocksTypedFormMetadataVisitor.php

sulu/src/Sulu/Bundle/CoreBundle/DependencyInjection/SuluCoreExtension.php

Lines 71 to 74 in f77b61b

'blocks' => [

'path' => '%kernel.project_dir%/config/templates/blocks',

'type' => 'block',

],

My gut feeling says contentBundle, but I cannot tell you a specific reason for it 😅, both cases are valid

okay lets tackle this in own PR my first indention was also content, thomas also, but discussion is will it be used outside of content bundle then it would be better to stay part of admin.

alexander-schranz · 2025-06-02T19:45:10Z

src/Sulu/Component/Content/SmartContent/PageDataProvider.php

@@ -390,7 +390,7 @@ private function getTypes(): array
            $metadata = $this->formMetadataProvider->getMetadata('page', $user->getLocale(), []);

            foreach ($metadata->getForms() as $form) {
-                $types[] = ['type' => $form->getName(), 'title' => $form->getTitle($user->getLocale())];
+                $types[] = ['type' => $form->getKey(), 'title' => $form->getTitle($user->getLocale())];


I'm kind of confused about name and key in forms vs templates @Prokyonn lets discuss this.

tackled in #7984

alexander-schranz · 2025-06-03T10:19:15Z

src/Sulu/Bundle/AdminBundle/Resources/config/services.xml

+            <!--
            <tag name="sulu_admin.form_metadata_loader"/>
+            -->


Currently commented out but whole service should later be removed in upcoming PR with removing the structure metadata.

This PR responsibility is just replace all usage of metadata of the admin is not longer build on top of structure metadata instead using the new parsers of the admin bundle.

alexander-schranz · 2025-06-03T14:22:53Z

src/Sulu/Bundle/AdminBundle/Tests/Functional/Controller/fixtures/default.json

@@ -270,7 +270,7 @@
                                    "required": false,
                                    "multilingual": true,
                                    "spaceAfter": null,
-                                    "minOccurs": null,
+                                    "minOccurs": 0,


TODO need to find out where this regression comes from.

Actually 0 is the correct value here:

sulu/src/Sulu/Bundle/AdminBundle/Tests/Application/config/templates/pages/default.xml

Line 95 in 2bb3242

<block name="blocks" default-type="text_block2" minOccurs="0">

Shold we convert 0 to null or keep it as it is now? /cc @Prokyonn

I think keeping it like this is more transparent

alexander-schranz · 2025-06-03T14:24:50Z

src/Sulu/Bundle/AdminBundle/Metadata/FormMetadata/Visitor/BlockSettingsFormMetadataVisitor.php

+/**
+ * @internal
+ */
+class BlockSettingsFormMetadataVisitor implements TypedFormMetadataVisitorInterface


copied from StructureFormMetadataLoader which will get removed in upcoming PR

alexander-schranz · 2025-06-03T14:25:46Z

src/Sulu/Bundle/PageBundle/DependencyInjection/SuluPageExtension.php

+                    'templates' => [
+                        PageInterface::TEMPLATE_TYPE => [
+                            'directories' => [
+                                'app' => '%kernel.project_dir%/config/templates/pages',
+                            ],
+                        ],
+                    ],


required currently also in the old page bundle as the new one is not registered yet in old other bundles because conflicts with the old one

Prokyonn · 2025-06-04T08:50:09Z

src/Sulu/Bundle/AdminBundle/Tests/Functional/Controller/fixtures/default.json

@@ -270,7 +270,7 @@
                                    "required": false,
                                    "multilingual": true,
                                    "spaceAfter": null,
-                                    "minOccurs": null,
+                                    "minOccurs": 0,


I think keeping it like this is more transparent

Prokyonn · 2025-06-04T08:59:02Z

src/Sulu/Bundle/CoreBundle/DependencyInjection/SuluCoreExtension.php

+        $container->prependExtensionConfig(
+            'sulu_admin',
+            [
+                'templates' => [
+                    'block' => [ // TODO maybe blocks?
+                        'default_type' => null,
+                        'directories' => [
+                            'app' => '%kernel.project_dir%/config/templates/blocks',
+                        ],
+                    ],
+                ],
+            ]
+        );


My gut feeling says contentBundle, but I cannot tell you a specific reason for it 😅, both cases are valid

alexander-schranz commented Jun 2, 2025

View reviewed changes

alexander-schranz force-pushed the feature/template-xml-loader branch from 4fac69f to f37b7ad Compare June 2, 2025 19:37

alexander-schranz commented Jun 2, 2025

View reviewed changes

alexander-schranz force-pushed the feature/template-xml-loader branch from f37b7ad to e50f7b2 Compare June 2, 2025 20:13

alexander-schranz added the Feature New functionality not yet included in Sulu label Jun 2, 2025

alexander-schranz force-pushed the feature/template-xml-loader branch from e50f7b2 to e2eaaff Compare June 3, 2025 06:27

alexander-schranz commented Jun 3, 2025

View reviewed changes

Add XmlTemplateFormMetadataLoader

f187998

alexander-schranz force-pushed the feature/template-xml-loader branch 3 times, most recently from 5b97a69 to e2d388b Compare June 3, 2025 11:21

Fix phpstan issues

4c9bdf8

alexander-schranz force-pushed the feature/template-xml-loader branch from e2d388b to 4c9bdf8 Compare June 3, 2025 11:23

alexander-schranz added 3 commits June 3, 2025 15:51

Fix block settings handling

635cb00

Fix priority tag setting handling

2f2a874

Fix meta tag parsing for templates

47d179a

alexander-schranz commented Jun 3, 2025

View reviewed changes

Fix SettingsFormMetadataVisitor test

29c1e56

alexander-schranz force-pushed the feature/template-xml-loader branch from ee7b323 to 29c1e56 Compare June 3, 2025 14:24

alexander-schranz commented Jun 3, 2025

View reviewed changes

alexander-schranz added 2 commits June 3, 2025 16:29

Some phpstan fixes

65d7d6a

Some phpstan fixes

a0206cd

alexander-schranz force-pushed the feature/template-xml-loader branch from e3aa8df to a0206cd Compare June 4, 2025 07:06

alexander-schranz added Technical Debt Impacts code quality, no or just small impact on end developers and users and removed Feature New functionality not yet included in Sulu labels Jun 4, 2025

alexander-schranz force-pushed the feature/template-xml-loader branch 3 times, most recently from 1c62983 to 73ca91d Compare June 4, 2025 07:55

Add test for TemplateXmlLoaderTest

1805f85

alexander-schranz force-pushed the feature/template-xml-loader branch from 73ca91d to 1805f85 Compare June 4, 2025 08:16

Prokyonn approved these changes Jun 4, 2025

View reviewed changes

alexander-schranz added 3 commits June 4, 2025 13:23

Fix phpstan issues

6bd0a1a

Add MetaXmlParserTest

3bb5d8f

Add TagXmlParserTest

10bc922

alexander-schranz force-pushed the feature/template-xml-loader branch from 8d29c51 to 10bc922 Compare June 4, 2025 11:44

alexander-schranz marked this pull request as ready for review June 4, 2025 16:19

alexander-schranz merged commit 75b2678 into sulu:3.0 Jun 5, 2025
9 checks passed

alexander-schranz deleted the feature/template-xml-loader branch June 5, 2025 07:16

alexander-schranz mentioned this pull request Jun 5, 2025

Add parsing of template metadata #7987

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add XmlTemplateFormMetadataLoader to replace old structure based metadata loading #7982

Add XmlTemplateFormMetadataLoader to replace old structure based metadata loading #7982

Uh oh!

alexander-schranz commented Jun 2, 2025 •

edited

Loading

Uh oh!

alexander-schranz Jun 2, 2025

Uh oh!

alexander-schranz Jun 2, 2025 •

edited

Loading

Uh oh!

Prokyonn Jun 4, 2025

Uh oh!

alexander-schranz Jun 4, 2025

Uh oh!

alexander-schranz Jun 2, 2025

Uh oh!

alexander-schranz Jun 3, 2025

Uh oh!

alexander-schranz Jun 3, 2025 •

edited

Loading

Uh oh!

alexander-schranz Jun 3, 2025

Uh oh!

alexander-schranz Jun 4, 2025

Uh oh!

Prokyonn Jun 4, 2025

Uh oh!

alexander-schranz Jun 3, 2025 •

edited

Loading

Uh oh!

alexander-schranz Jun 3, 2025

Uh oh!

Prokyonn Jun 4, 2025

Uh oh!

Prokyonn Jun 4, 2025

Uh oh!

Uh oh!

Uh oh!

	'blocks' => [
	'path' => '%kernel.project_dir%/config/templates/blocks',
	'type' => 'block',
	],

Add XmlTemplateFormMetadataLoader to replace old structure based metadata loading #7982

Add XmlTemplateFormMetadataLoader to replace old structure based metadata loading #7982

Uh oh!

Conversation

alexander-schranz commented Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What's in this PR?

Why?

ToDo

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexander-schranz Jun 2, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexander-schranz Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

alexander-schranz Jun 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

alexander-schranz commented Jun 2, 2025 •

edited

Loading

alexander-schranz Jun 2, 2025 •

edited

Loading

alexander-schranz Jun 3, 2025 •

edited

Loading

alexander-schranz Jun 3, 2025 •

edited

Loading